Class: SensuPluginsMongoDB::Metrics

Inherits:
Object
  • Object
show all
Defined in:
lib/sensu-plugins-mongodb/metrics.rb

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Metrics

Initializes a Metrics collector.

Parameters:

  • config (Mesh) —

    the config object parsed from the command line. Must include: :host, :port, :user, :password, :debug



11
12
13
14
15
16
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 11

def initialize(config)
  @config = config
  @connected = false
  @db = nil
  @mongo_client = nil
end

Instance Method Details

#connect_mongo_db(db_name) ⇒ Object

Connects to a mongo database.

Parameters:

  • db_name (String) —

    the name of the db to connect to.



21
22
23
24
25
26
27
28
29
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 21

def connect_mongo_db(db_name)
  if @connected
    raise 'Already connected to a database'
  end

  @mongo_client = get_mongo_client(db_name)

  @db = @mongo_client.database
end

#get_mongo_doc(command) ⇒ Mesh?

Fetches a document from the mongo db.

Parameters:

  • command (Mesh) —

    the command to search documents with.

Returns:

  • (Mesh, nil) —

    the first document or nil.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 35

def get_mongo_doc(command)
  unless @connected
    raise 'Cannot fetch documents before connecting.'
  end
  unless @db
    raise 'Cannot fetch documents without a db.'
  end

  rs = @db.command(command)
  unless rs.successful?
    return nil
  end

  rs.documents[0]
end

#master? ⇒ true, false

Checks if the connected node is the master node.

Returns:

  • (true, false) —

    true when the node is a master node.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 54

def master?
  result = false
  begin
    @is_master = get_mongo_doc('isMaster' => 1)
    unless @is_master.nil?
      result = @is_master['ok'] == 1 && @is_master['ismaster']
    end
  rescue StandardError => e
    if @config[:debug]
      puts 'Error checking isMaster: ' + e.message
      puts e.backtrace.inspect
    end
  end
  result
end

#replicaset_status ⇒ Mash?

Fetches the replicaset status of the server (which includes the metrics).

Returns:

  • (Mash, nil) —

    the document showing the replicaset status or nil.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 88

def replicaset_status
  status = get_mongo_doc('replSetGetStatus' => 1)
  return nil if status.nil?

  status
rescue StandardError => e
  if @debug
    puts 'Error checking replSetGetStatus: ' + e.message
    puts e.backtrace.inspect
  end
end

#server_metrics ⇒ Mash

Fetches metrics for the server we are connected to.

rubocop:disable Metrics/AbcSize

Returns:

  • (Mash) —

    the metrics for the server.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 104

def server_metrics
  server_status = self.server_status
  replicaset_status = self.replicaset_status
  server_metrics = {}
  # Handle versions like "2.6.11-pre" etc
  mongo_version = server_status['version'].gsub(/[^0-9\.]/i, '')

  server_metrics['lock.ratio'] = sprintf('%.5f', server_status['globalLock']['ratio']).to_s unless server_status['globalLock']['ratio'].nil?

  # Asserts
  asserts = server_status['asserts']
  server_metrics['asserts.warnings'] = asserts['warning']
  server_metrics['asserts.errors'] = asserts['msg']
  server_metrics['asserts.regular'] = asserts['regular']
  server_metrics['asserts.user'] = asserts['user']
  server_metrics['asserts.rollovers'] = asserts['rollovers']

  # Background flushing
  if server_status.key?('backgroundFlushing')
    bg_flushing = server_status['backgroundFlushing']
    server_metrics['backgroundFlushing.flushes'] = bg_flushing['flushes']
    server_metrics['backgroundFlushing.total_ms'] = bg_flushing['total_ms']
    server_metrics['backgroundFlushing.average_ms'] = bg_flushing['average_ms']
    server_metrics['backgroundFlushing.last_ms'] = bg_flushing['last_ms']
  end

  # Connections
  connections = server_status['connections']
  server_metrics['connections.current'] = connections['current']
  server_metrics['connections.available'] = connections['available']
  server_metrics['connections.totalCreated'] = connections['totalCreated']

  # Cursors (use new metrics.cursor from mongo 2.6+)
  if Gem::Version.new(mongo_version) < Gem::Version.new('2.6.0')
    cursors = server_status['cursors']
    server_metrics['clientCursors.size'] = cursors['clientCursors_size']
    server_metrics['cursors.timedOut'] = cursors['timedOut']

    # Metric names match the version 2.6+ format for standardization!
    server_metrics['cursors.open.NoTimeout'] = cursors['totalNoTimeout']
    server_metrics['cursors.open.pinned'] = cursors['pinned']
    server_metrics['cursors.open.total'] = cursors['totalOpen']
  else
    cursors = server_status['metrics']['cursor']
    server_metrics['cursors.timedOut'] = cursors['timedOut']
    # clientCursors.size has been replaced by cursors.open.total

    open = cursors['open']
    server_metrics['cursors.open.noTimeout'] = open['noTimeout']
    server_metrics['cursors.open.pinned'] = open['pinned']
    server_metrics['cursors.open.total'] = open['total']

    unless Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
      server_metrics['cursors.open.multiTarget'] = open['multiTarget']
      server_metrics['cursors.open.singleTarget'] = open['singleTarget']
    end
  end

  # Database Sizes
  @mongo_client.database_names.each do |name|
    @mongo_client = @mongo_client.use(name)
    db = @mongo_client.database
    result = db.command(dbstats: 1).documents.first
    server_metrics["databaseSizes.#{name}.collections"] = result['collections']
    server_metrics["databaseSizes.#{name}.objects"] = result['objects']
    server_metrics["databaseSizes.#{name}.avgObjSize"] = result['avgObjSize']
    server_metrics["databaseSizes.#{name}.dataSize"] = result['dataSize']
    server_metrics["databaseSizes.#{name}.storageSize"] = result['storageSize']
    server_metrics["databaseSizes.#{name}.numExtents"] = result['numExtents']
    server_metrics["databaseSizes.#{name}.indexes"] = result['indexes']
    server_metrics["databaseSizes.#{name}.indexSize"] = result['indexSize']
    server_metrics["databaseSizes.#{name}.fileSize"] = result['fileSize']
    server_metrics["databaseSizes.#{name}.nsSizeMB"] = result['nsSizeMB']
  end
  # Reset back to previous database
  @mongo_client = @mongo_client.use(@db.name)

  # Journaling (durability)
  if server_status.key?('dur')
    dur = server_status['dur']
    server_metrics['journal.commits'] = dur['commits']
    server_metrics['journaled_MB'] = dur['journaledMB']
    server_metrics['journal.timeMs.writeToDataFiles'] = dur['timeMs']['writeToDataFiles']
    server_metrics['journal.writeToDataFilesMB'] = dur['writeToDataFilesMB']
    server_metrics['journal.compression'] = dur['compression']
    server_metrics['journal.commitsInWriteLock'] = dur['commitsInWriteLock']
    server_metrics['journal.timeMs.dt'] = dur['timeMs']['dt']
    server_metrics['journal.timeMs.prepLogBuffer'] = dur['timeMs']['prepLogBuffer']
    server_metrics['journal.timeMs.writeToJournal'] = dur['timeMs']['writeToJournal']
    server_metrics['journal.timeMs.remapPrivateView'] = dur['timeMs']['remapPrivateView']
  end

  # Extra info
  extra_info = server_status['extra_info']
  server_metrics['mem.heap_usage_bytes'] = extra_info['heap_usage_bytes']
  server_metrics['mem.pageFaults'] = extra_info['page_faults']

  # Global Lock
  global_lock = server_status['globalLock']
  server_metrics['lock.totalTime'] = global_lock['totalTime']
  server_metrics['lock.queue_total'] = global_lock['currentQueue']['total']
  server_metrics['lock.queue_readers'] = global_lock['currentQueue']['readers']
  server_metrics['lock.queue_writers'] = global_lock['currentQueue']['writers']
  server_metrics['lock.clients_total'] = global_lock['activeClients']['total']
  server_metrics['lock.clients_readers'] = global_lock['activeClients']['readers']
  server_metrics['lock.clients_writers'] = global_lock['activeClients']['writers']

  # Index counters
  if Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
    index_counters = server_status['indexCounters']
    index_counters = server_status['indexCounters']['btree'] unless server_status['indexCounters']['btree'].nil?

    server_metrics['indexes.missRatio'] = sprintf('%.5f', index_counters['missRatio']).to_s
    server_metrics['indexes.hits'] = index_counters['hits']
    server_metrics['indexes.misses'] = index_counters['misses']
    server_metrics['indexes.accesses'] = index_counters['accesses']
    server_metrics['indexes.resets'] = index_counters['resets']
  end

  # Locks (from mongo 3.0+ only)
  unless Gem::Version.new(mongo_version) < Gem::Version.new('3.0.0')
    locks = server_status['locks']
    lock_namespaces = %w[
      Collection Global Database Metadata
      MMAPV1Journal oplog
    ]
    lock_dimentions = %w[
      acquireCount acquireWaitCount
      timeAcquiringMicros deadlockCount
    ]

    lock_namespaces.each do |ns|
      lock_dimentions.each do |dm|
        next unless locks.key?(ns) && locks[ns].key?(dm)

        lock = locks[ns][dm]
        server_metrics["locks.#{ns}.#{dm}_r"] = lock['r'] if lock.key?('r')
        server_metrics["locks.#{ns}.#{dm}_w"] = lock['r'] if lock.key?('w')
        server_metrics["locks.#{ns}.#{dm}_R"] = lock['r'] if lock.key?('R')
        server_metrics["locks.#{ns}.#{dm}_W"] = lock['r'] if lock.key?('W')
      end
    end
  end

  # Network
  network = server_status['network']
  server_metrics['network.bytesIn'] = network['bytesIn']
  server_metrics['network.bytesOut'] = network['bytesOut']
  server_metrics['network.numRequests'] = network['numRequests']

  # Opcounters
  opcounters = server_status['opcounters']
  server_metrics['opcounters.insert'] = opcounters['insert']
  server_metrics['opcounters.query'] = opcounters['query']
  server_metrics['opcounters.update'] = opcounters['update']
  server_metrics['opcounters.delete'] = opcounters['delete']
  server_metrics['opcounters.getmore'] = opcounters['getmore']
  server_metrics['opcounters.command'] = opcounters['command']

  # Opcounters Replication
  opcounters_repl = server_status['opcountersRepl']
  server_metrics['opcountersRepl.insert'] = opcounters_repl['insert']
  server_metrics['opcountersRepl.query'] = opcounters_repl['query']
  server_metrics['opcountersRepl.update'] = opcounters_repl['update']
  server_metrics['opcountersRepl.delete'] = opcounters_repl['delete']
  server_metrics['opcountersRepl.getmore'] = opcounters_repl['getmore']
  server_metrics['opcountersRepl.command'] = opcounters_repl['command']

  # Memory
  mem = server_status['mem']
  server_metrics['mem.residentMb'] = mem['resident']
  server_metrics['mem.virtualMb'] = mem['virtual']
  server_metrics['mem.mapped'] = mem['mapped']
  server_metrics['mem.mappedWithJournal'] = mem['mappedWithJournal']

  # Metrics (documents)
  document = server_status['metrics']['document']
  server_metrics['metrics.document.deleted'] = document['deleted']
  server_metrics['metrics.document.inserted'] = document['inserted']
  server_metrics['metrics.document.returned'] = document['returned']
  server_metrics['metrics.document.updated'] = document['updated']

  # Metrics (getLastError)
  get_last_error = server_status['metrics']['getLastError']
  server_metrics['metrics.getLastError.wtime_num'] = get_last_error['wtime']['num']
  server_metrics['metrics.getLastError.wtime_totalMillis'] = get_last_error['wtime']['totalMillis']
  server_metrics['metrics.getLastError.wtimeouts'] = get_last_error['wtimeouts']

  # Metrics (operation)
  operation = server_status['metrics']['operation']
  server_metrics['metrics.operation.fastmod'] = operation['fastmod']
  server_metrics['metrics.operation.idhack'] = operation['idhack']
  server_metrics['metrics.operation.scanAndOrder'] = operation['scanAndOrder']

  # Metrics (operation)
  query_executor = server_status['metrics']['queryExecutor']
  server_metrics['metrics.queryExecutor.scanned'] = query_executor['scanned']
  server_metrics['metrics.queryExecutor.scannedObjects'] = query_executor['scannedObjects']
  server_metrics['metrics.record.moves'] = server_status['metrics']['record']['moves']

  # Metrics (repl)
  repl = server_status['metrics']['repl']
  server_metrics['metrics.repl.apply.batches_num'] = repl['apply']['batches']['num']
  server_metrics['metrics.repl.apply.batches_totalMillis'] = repl['apply']['batches']['totalMillis']
  server_metrics['metrics.repl.apply.ops'] = repl['apply']['ops']
  server_metrics['metrics.repl.buffer.count'] = repl['buffer']['count']
  server_metrics['metrics.repl.buffer.maxSizeBytes'] = repl['buffer']['maxSizeBytes']
  server_metrics['metrics.repl.buffer.sizeBytes'] = repl['buffer']['sizeBytes']
  server_metrics['metrics.repl.network.bytes'] = repl['network']['bytes']
  server_metrics['metrics.repl.network.getmores_num'] = repl['network']['getmores']['num']
  server_metrics['metrics.repl.network.getmores_totalMillis'] = repl['network']['getmores']['totalMillis']
  server_metrics['metrics.repl.network.ops'] = repl['network']['ops']
  server_metrics['metrics.repl.network.readersCreated'] = repl['network']['readersCreated']

  if Gem::Version.new(mongo_version) <= Gem::Version.new('4.0.0')
    server_metrics['metrics.repl.preload.docs_num'] = repl['preload']['docs']['num']
    server_metrics['metrics.repl.preload.docs_totalMillis'] = repl['preload']['docs']['totalMillis']
    server_metrics['metrics.repl.preload.indexes_num'] = repl['preload']['indexes']['num']
    server_metrics['metrics.repl.preload.indexes_totalMillis'] = repl['preload']['indexes']['totalMillis']
  end

  # Metrics (replicaset status)
  # MongoDB will fail if not running with --replSet, hence the check for nil
  unless replicaset_status.nil?
    server_metrics['metrics.replicaset.state'] = replicaset_status['myState']
  end

  # Metrics (storage)
  if Gem::Version.new(mongo_version) <= Gem::Version.new('4.0.0')
    freelist = server_status['metrics']['storage']['freelist']
    server_metrics['metrics.storage.freelist.search_bucketExhauseted'] = freelist['search']['bucketExhausted']
    server_metrics['metrics.storage.freelist.search_requests'] = freelist['search']['requests']
    server_metrics['metrics.storage.freelist.search_scanned'] = freelist['search']['scanned']
  end

  # Metrics (ttl)
  ttl = server_status['metrics']['ttl']
  server_metrics['metrics.ttl.deletedDocuments'] = ttl['deletedDocuments']
  server_metrics['metrics.ttl.passes'] = ttl['passes']

  # Return metrics map.
  # MongoDB returns occasional nils and floats as {"floatApprox": x}.
  # Clean up the results once here to avoid per-metric logic.
  clean_metrics = {}
  server_metrics.each do |k, v|
    next if v.nil?

    if v.is_a?(Hash) && v.key?('floatApprox')
      v = v['floatApprox']
    end
    clean_metrics[k] = v
  end
  clean_metrics
end

#server_status ⇒ Mash?

Fetches the status of the server (which includes the metrics).

Returns:

  • (Mash, nil) —

    the document showing the server status or nil.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sensu-plugins-mongodb/metrics.rb', line 73

def server_status
  status = get_mongo_doc('serverStatus' => 1)
  return nil if status.nil? || status['ok'] != 1

  status
rescue StandardError => e
  if @debug
    puts 'Error checking serverStatus: ' + e.message
    puts e.backtrace.inspect
  end
end