github.com/netdata/go.d.plugin@v0.58.1/modules/mongodb/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-mongodb 5 plugin_name: go.d.plugin 6 module_name: mongodb 7 monitored_instance: 8 name: MongoDB 9 link: https://www.mongodb.com/ 10 icon_filename: mongodb.svg 11 categories: 12 - data-collection.database-servers 13 keywords: 14 - mongodb 15 - databases 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors MongoDB servers. 26 27 Executed queries: 28 29 - [serverStatus](https://docs.mongodb.com/manual/reference/command/serverStatus/) 30 - [dbStats](https://docs.mongodb.com/manual/reference/command/dbStats/) 31 - [replSetGetStatus](https://www.mongodb.com/docs/manual/reference/command/replSetGetStatus/) 32 method_description: "" 33 supported_platforms: 34 include: [] 35 exclude: [] 36 multi_instance: true 37 additional_permissions: 38 description: "" 39 default_behavior: 40 auto_detection: 41 description: "" 42 limits: 43 description: "" 44 performance_impact: 45 description: "" 46 setup: 47 prerequisites: 48 list: 49 - title: Create a read-only user 50 description: | 51 Create a read-only user for Netdata in the admin database. 52 53 - Authenticate as the admin user: 54 55 ```bash 56 use admin 57 db.auth("admin", "<MONGODB_ADMIN_PASSWORD>") 58 ``` 59 60 - Create a user: 61 62 ```bash 63 db.createUser({ 64 "user":"netdata", 65 "pwd": "<UNIQUE_PASSWORD>", 66 "roles" : [ 67 {role: 'read', db: 'admin' }, 68 {role: 'clusterMonitor', db: 'admin'}, 69 {role: 'read', db: 'local' } 70 ] 71 }) 72 ``` 73 configuration: 74 file: 75 name: go.d/mongodb.conf 76 options: 77 description: | 78 The following options can be defined globally: update_every, autodetection_retry. 79 folding: 80 title: Config options 81 enabled: true 82 list: 83 - name: update_every 84 description: Data collection frequency. 85 default_value: 5 86 required: false 87 - name: autodetection_retry 88 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 89 default_value: 0 90 required: false 91 - name: uri 92 description: MongoDB connection string. See [URI syntax](https://www.mongodb.com/docs/manual/reference/connection-string/). 93 default_value: mongodb://localhost:27017 94 required: true 95 - name: timeout 96 description: Query timeout in seconds. 97 default_value: 2 98 required: false 99 - name: databases 100 description: Databases selector. Determines which database metrics will be collected. 101 default_value: "" 102 required: false 103 details: | 104 Metrics of databases matching the selector will be collected. 105 106 - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4) 107 - Pattern syntax: [matcher](https://github.com/netdata/go.d.plugin/tree/master/pkg/matcher#supported-format). 108 - Syntax: 109 110 ```yaml 111 per_user_stats: 112 includes: 113 - pattern1 114 - pattern2 115 excludes: 116 - pattern3 117 - pattern4 118 ``` 119 examples: 120 folding: 121 title: Config 122 enabled: true 123 list: 124 - name: TCP socket 125 description: An example configuration. 126 config: | 127 jobs: 128 - name: local 129 uri: mongodb://netdata:password@localhost:27017 130 - name: With databases metrics 131 description: An example configuration. 132 config: | 133 jobs: 134 - name: local 135 uri: mongodb://netdata:password@localhost:27017 136 databases: 137 includes: 138 - "* *" 139 - name: Multi-instance 140 description: | 141 > **Note**: When you define multiple jobs, their names must be unique. 142 143 Local and remote instances. 144 config: | 145 jobs: 146 - name: local 147 uri: mongodb://netdata:password@localhost:27017 148 149 - name: remote 150 uri: mongodb://netdata:password@203.0.113.0:27017 151 troubleshooting: 152 problems: 153 list: [] 154 alerts: [] 155 metrics: 156 folding: 157 title: Metrics 158 enabled: false 159 availability: [] 160 description: | 161 - WireTiger metrics are available only if [WiredTiger](https://docs.mongodb.com/v6.0/core/wiredtiger/) is used as the 162 storage engine. 163 - Sharding metrics are available on shards only 164 for [mongos](https://www.mongodb.com/docs/manual/reference/program/mongos/). 165 scopes: 166 - name: global 167 description: These metrics refer to the entire monitored application. 168 labels: [] 169 metrics: 170 - name: mongodb.operations_rate 171 description: Operations rate 172 unit: operations/s 173 chart_type: line 174 dimensions: 175 - name: reads 176 - name: writes 177 - name: commands 178 - name: mongodb.operations_latency_time 179 description: Operations Latency 180 unit: milliseconds 181 chart_type: line 182 dimensions: 183 - name: reads 184 - name: writes 185 - name: commands 186 - name: mongodb.operations_by_type_rate 187 description: Operations by type 188 unit: operations/s 189 chart_type: line 190 dimensions: 191 - name: insert 192 - name: query 193 - name: update 194 - name: delete 195 - name: getmore 196 - name: command 197 - name: mongodb.document_operations_rate 198 description: Document operations 199 unit: operations/s 200 chart_type: stacked 201 dimensions: 202 - name: inserted 203 - name: deleted 204 - name: returned 205 - name: updated 206 - name: mongodb.scanned_indexes_rate 207 description: Scanned indexes 208 unit: indexes/s 209 chart_type: line 210 dimensions: 211 - name: scanned 212 - name: mongodb.scanned_documents_rate 213 description: Scanned documents 214 unit: documents/s 215 chart_type: line 216 dimensions: 217 - name: scanned 218 - name: mongodb.active_clients_count 219 description: Connected clients 220 unit: clients 221 chart_type: line 222 dimensions: 223 - name: readers 224 - name: writers 225 - name: mongodb.queued_operations_count 226 description: Queued operations because of a lock 227 unit: operations 228 chart_type: line 229 dimensions: 230 - name: reads 231 - name: writes 232 - name: mongodb.cursors_open_count 233 description: Open cursors 234 unit: cursors 235 chart_type: line 236 dimensions: 237 - name: open 238 - name: mongodb.cursors_open_no_timeout_count 239 description: Open cursors with disabled timeout 240 unit: cursors 241 chart_type: line 242 dimensions: 243 - name: open_no_timeout 244 - name: mongodb.cursors_opened_rate 245 description: Opened cursors rate 246 unit: cursors/s 247 chart_type: line 248 dimensions: 249 - name: opened 250 - name: mongodb.cursors_timed_out_rate 251 description: Timed-out cursors 252 unit: cursors/s 253 chart_type: line 254 dimensions: 255 - name: timed_out 256 - name: mongodb.cursors_by_lifespan_count 257 description: Cursors lifespan 258 unit: cursors 259 chart_type: stacked 260 dimensions: 261 - name: le_1s 262 - name: 1s_5s 263 - name: 5s_15s 264 - name: 15s_30s 265 - name: 30s_1m 266 - name: 1m_10m 267 - name: ge_10m 268 - name: mongodb.transactions_count 269 description: Current transactions 270 unit: transactions 271 chart_type: line 272 dimensions: 273 - name: active 274 - name: inactive 275 - name: open 276 - name: prepared 277 - name: mongodb.transactions_rate 278 description: Transactions rate 279 unit: transactions/s 280 chart_type: line 281 dimensions: 282 - name: started 283 - name: aborted 284 - name: committed 285 - name: prepared 286 - name: mongodb.connections_usage 287 description: Connections usage 288 unit: connections 289 chart_type: stacked 290 dimensions: 291 - name: available 292 - name: used 293 - name: mongodb.connections_by_state_count 294 description: Connections By State 295 unit: connections 296 chart_type: line 297 dimensions: 298 - name: active 299 - name: threaded 300 - name: exhaust_is_master 301 - name: exhaust_hello 302 - name: awaiting_topology_changes 303 - name: mongodb.connections_rate 304 description: Connections Rate 305 unit: connections/s 306 chart_type: line 307 dimensions: 308 - name: created 309 - name: mongodb.asserts_rate 310 description: Raised assertions 311 unit: asserts/s 312 chart_type: stacked 313 dimensions: 314 - name: regular 315 - name: warning 316 - name: msg 317 - name: user 318 - name: tripwire 319 - name: rollovers 320 - name: mongodb.network_traffic_rate 321 description: Network traffic 322 unit: bytes/s 323 chart_type: stacked 324 dimensions: 325 - name: in 326 - name: out 327 - name: mongodb.network_requests_rate 328 description: Network Requests 329 unit: requests/s 330 chart_type: line 331 dimensions: 332 - name: requests 333 - name: mongodb.network_slow_dns_resolutions_rate 334 description: Slow DNS resolution operations 335 unit: resolutions/s 336 chart_type: line 337 dimensions: 338 - name: slow_dns 339 - name: mongodb.network_slow_ssl_handshakes_rate 340 description: Slow SSL handshake operations 341 unit: handshakes/s 342 chart_type: line 343 dimensions: 344 - name: slow_ssl 345 - name: mongodb.memory_resident_size 346 description: Used resident memory 347 unit: bytes 348 chart_type: line 349 dimensions: 350 - name: used 351 - name: mongodb.memory_virtual_size 352 description: Used virtual memory 353 unit: bytes 354 chart_type: line 355 dimensions: 356 - name: used 357 - name: mongodb.memory_page_faults_rate 358 description: Memory page faults 359 unit: pgfaults/s 360 chart_type: line 361 dimensions: 362 - name: pgfaults 363 - name: mongodb.memory_tcmalloc_stats 364 description: TCMalloc statistics 365 unit: bytes 366 chart_type: line 367 dimensions: 368 - name: allocated 369 - name: central_cache_freelist 370 - name: transfer_cache_freelist 371 - name: thread_cache_freelists 372 - name: pageheap_freelist 373 - name: pageheap_unmapped 374 - name: mongodb.wiredtiger_concurrent_read_transactions_usage 375 description: Wired Tiger concurrent read transactions usage 376 unit: transactions 377 chart_type: stacked 378 dimensions: 379 - name: available 380 - name: used 381 - name: mongodb.wiredtiger_concurrent_write_transactions_usage 382 description: Wired Tiger concurrent write transactions usage 383 unit: transactions 384 chart_type: stacked 385 dimensions: 386 - name: available 387 - name: used 388 - name: mongodb.wiredtiger_cache_usage 389 description: Wired Tiger cache usage 390 unit: bytes 391 chart_type: line 392 dimensions: 393 - name: used 394 - name: mongodb.wiredtiger_cache_dirty_space_size 395 description: Wired Tiger cache dirty space size 396 unit: bytes 397 chart_type: line 398 dimensions: 399 - name: dirty 400 - name: mongodb.wiredtiger_cache_io_rate 401 description: Wired Tiger IO activity 402 unit: pages/s 403 chart_type: line 404 dimensions: 405 - name: read 406 - name: written 407 - name: mongodb.wiredtiger_cache_evictions_rate 408 description: Wired Tiger cache evictions 409 unit: pages/s 410 chart_type: stacked 411 dimensions: 412 - name: unmodified 413 - name: modified 414 - name: mongodb.sharding_nodes_count 415 description: Sharding Nodes 416 unit: nodes 417 chart_type: stacked 418 dimensions: 419 - name: shard_aware 420 - name: shard_unaware 421 - name: mongodb.sharding_sharded_databases_count 422 description: Sharded databases 423 unit: databases 424 chart_type: stacked 425 dimensions: 426 - name: partitioned 427 - name: unpartitioned 428 - name: mongodb.sharding_sharded_collections_count 429 description: Sharded collections 430 unit: collections 431 chart_type: stacked 432 dimensions: 433 - name: partitioned 434 - name: unpartitioned 435 - name: lock type 436 description: These metrics refer to the lock type. 437 labels: 438 - name: lock_type 439 description: lock type (e.g. global, database, collection, mutex) 440 metrics: 441 - name: mongodb.lock_acquisitions_rate 442 description: Lock acquisitions 443 unit: acquisitions/s 444 chart_type: line 445 dimensions: 446 - name: shared 447 - name: exclusive 448 - name: intent_shared 449 - name: intent_exclusive 450 - name: commit type 451 description: These metrics refer to the commit type. 452 labels: 453 - name: commit_type 454 description: commit type (e.g. noShards, singleShard, singleWriteShard) 455 metrics: 456 - name: mongodb.transactions_commits_rate 457 description: Transactions commits 458 unit: commits/s 459 chart_type: line 460 dimensions: 461 - name: success 462 - name: fail 463 - name: mongodb.transactions_commits_duration_time 464 description: Transactions successful commits duration 465 unit: milliseconds 466 chart_type: line 467 dimensions: 468 - name: commits 469 - name: database 470 description: These metrics refer to the database. 471 labels: 472 - name: database 473 description: database name 474 metrics: 475 - name: mongodb.database_collection_count 476 description: Database collections 477 unit: collections 478 chart_type: line 479 dimensions: 480 - name: collections 481 - name: mongodb.database_indexes_count 482 description: Database indexes 483 unit: indexes 484 chart_type: line 485 dimensions: 486 - name: indexes 487 - name: mongodb.database_views_count 488 description: Database views 489 unit: views 490 chart_type: line 491 dimensions: 492 - name: views 493 - name: mongodb.database_documents_count 494 description: Database documents 495 unit: documents 496 chart_type: line 497 dimensions: 498 - name: documents 499 - name: mongodb.database_data_size 500 description: Database data size 501 unit: bytes 502 chart_type: line 503 dimensions: 504 - name: data_size 505 - name: mongodb.database_storage_size 506 description: Database storage size 507 unit: bytes 508 chart_type: line 509 dimensions: 510 - name: storage_size 511 - name: mongodb.database_index_size 512 description: Database index size 513 unit: bytes 514 chart_type: line 515 dimensions: 516 - name: index_size 517 - name: replica set member 518 description: These metrics refer to the replica set member. 519 labels: 520 - name: repl_set_member 521 description: replica set member name 522 metrics: 523 - name: mongodb.repl_set_member_state 524 description: Replica Set member state 525 unit: state 526 chart_type: line 527 dimensions: 528 - name: primary 529 - name: startup 530 - name: secondary 531 - name: recovering 532 - name: startup2 533 - name: unknown 534 - name: arbiter 535 - name: down 536 - name: rollback 537 - name: removed 538 - name: mongodb.repl_set_member_health_status 539 description: Replica Set member health status 540 unit: status 541 chart_type: line 542 dimensions: 543 - name: up 544 - name: down 545 - name: mongodb.repl_set_member_replication_lag_time 546 description: Replica Set member replication lag 547 unit: milliseconds 548 chart_type: line 549 dimensions: 550 - name: replication_lag 551 - name: mongodb.repl_set_member_heartbeat_latency_time 552 description: Replica Set member heartbeat latency 553 unit: milliseconds 554 chart_type: line 555 dimensions: 556 - name: heartbeat_latency 557 - name: mongodb.repl_set_member_ping_rtt_time 558 description: Replica Set member ping RTT 559 unit: milliseconds 560 chart_type: line 561 dimensions: 562 - name: ping_rtt 563 - name: mongodb.repl_set_member_uptime 564 description: Replica Set member uptime 565 unit: seconds 566 chart_type: line 567 dimensions: 568 - name: uptime 569 - name: shard 570 description: These metrics refer to the shard. 571 labels: 572 - name: shard_id 573 description: shard id 574 metrics: 575 - name: mongodb.sharding_shard_chunks_count 576 description: Shard chunks 577 unit: chunks 578 chart_type: line 579 dimensions: 580 - name: chunks