telegraf/plugins/inputs/mongodb

MongoDB Input Plugin

Configuration:

[[inputs.mongodb]]
  ## An array of URLs of the form:
  ##   "mongodb://" [user ":" pass "@"] host [ ":" port]
  ## For example:
  ##   mongodb://user:auth_key@10.10.3.30:27017,
  ##   mongodb://10.10.3.33:18832,
  servers = ["mongodb://127.0.0.1:27017"]

  ## When true, collect cluster status.
  ## Note that the query that counts jumbo chunks triggers a COLLSCAN, which
  ## may have an impact on performance.
  # gather_cluster_status = true

  ## When true, collect per database stats
  # gather_perdb_stats = false

  ## When true, collect per collection stats
  # gather_col_stats = false

  ## List of db where collections stats are collected
  ## If empty, all db are concerned
  # col_stats_dbs = ["local"]

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

Permissions:

If your MongoDB instance has access control enabled you will need to connect as a user with sufficient rights.

With MongoDB 3.4 and higher, the clusterMonitor role can be used. In version 3.2 you may also need these additional permissions:

> db.grantRolesToUser("user", [{role: "read", actions: "find", db: "local"}])

If the user is missing required privileges you may see an error in the Telegraf logs similar to:

Error in input [mongodb]: not authorized on admin to execute command { serverStatus: 1, recordStats: 0 }

Some permission related errors are logged at debug level, you can check these messages by setting debug = true in the agent section of the configuration or by running Telegraf with the --debug argument.

Metrics:

• mongodb
  • tags:
    • hostname
    • node_type
    • rs_name
  • fields:
    • active_reads (integer)
    • active_writes (integer)
    • aggregate_command_failed (integer)
    • aggregate_command_total (integer)
    • assert_msg (integer)
    • assert_regular (integer)
    • assert_rollovers (integer)
    • assert_user (integer)
    • assert_warning (integer)
    • available_reads (integer)
    • available_writes (integer)
    • commands (integer)
    • connections_available (integer)
    • connections_current (integer)
    • connections_total_created (integer)
    • count_command_failed (integer)
    • count_command_total (integer)
    • cursor_no_timeout_count (integer)
    • cursor_pinned_count (integer)
    • cursor_timed_out_count (integer)
    • cursor_total_count (integer)
    • delete_command_failed (integer)
    • delete_command_total (integer)
    • deletes (integer)
    • distinct_command_failed (integer)
    • distinct_command_total (integer)
    • document_deleted (integer)
    • document_inserted (integer)
    • document_returned (integer)
    • document_updated (integer)
    • find_and_modify_command_failed (integer)
    • find_and_modify_command_total (integer)
    • find_command_failed (integer)
    • find_command_total (integer)
    • flushes (integer)
    • flushes_total_time_ns (integer)
    • get_more_command_failed (integer)
    • get_more_command_total (integer)
    • getmores (integer)
    • insert_command_failed (integer)
    • insert_command_total (integer)
    • inserts (integer)
    • jumbo_chunks (integer)
    • latency_commands_count (integer)
    • latency_commands (integer)
    • latency_reads_count (integer)
    • latency_reads (integer)
    • latency_writes_count (integer)
    • latency_writes (integer)
    • member_status (string)
    • net_in_bytes_count (integer)
    • net_out_bytes_count (integer)
    • open_connections (integer)
    • operation_scan_and_order (integer)
    • operation_write_conflicts (integer)
    • page_faults (integer)
    • percent_cache_dirty (float)
    • percent_cache_used (float)
    • queries (integer)
    • queued_reads (integer)
    • queued_writes (integer)
    • repl_apply_batches_num (integer)
    • repl_apply_batches_total_millis (integer)
    • repl_apply_ops (integer)
    • repl_buffer_count (integer)
    • repl_buffer_size_bytes (integer)
    • repl_commands (integer)
    • repl_deletes (integer)
    • repl_executor_pool_in_progress_count (integer)
    • repl_executor_queues_network_in_progress (integer)
    • repl_executor_queues_sleepers (integer)
    • repl_executor_unsignaled_events (integer)
    • repl_getmores (integer)
    • repl_inserts (integer)
    • repl_lag (integer)
    • repl_network_bytes (integer)
    • repl_network_getmores_num (integer)
    • repl_network_getmores_total_millis (integer)
    • repl_network_ops (integer)
    • repl_queries (integer)
    • repl_updates (integer)
    • repl_oplog_window_sec (integer)
    • repl_state (integer)
    • resident_megabytes (integer)
    • state (string)
    • storage_freelist_search_bucket_exhausted (integer)
    • storage_freelist_search_requests (integer)
    • storage_freelist_search_scanned (integer)
    • tcmalloc_central_cache_free_bytes (integer)
    • tcmalloc_current_allocated_bytes (integer)
    • tcmalloc_current_total_thread_cache_bytes (integer)
    • tcmalloc_heap_size (integer)
    • tcmalloc_max_total_thread_cache_bytes (integer)
    • tcmalloc_pageheap_commit_count (integer)
    • tcmalloc_pageheap_committed_bytes (integer)
    • tcmalloc_pageheap_decommit_count (integer)
    • tcmalloc_pageheap_free_bytes (integer)
    • tcmalloc_pageheap_reserve_count (integer)
    • tcmalloc_pageheap_scavenge_count (integer)
    • tcmalloc_pageheap_total_commit_bytes (integer)
    • tcmalloc_pageheap_total_decommit_bytes (integer)
    • tcmalloc_pageheap_total_reserve_bytes (integer)
    • tcmalloc_pageheap_unmapped_bytes (integer)
    • tcmalloc_spinlock_total_delay_ns (integer)
    • tcmalloc_thread_cache_free_bytes (integer)
    • tcmalloc_total_free_bytes (integer)
    • tcmalloc_transfer_cache_free_bytes (integer)
    • total_available (integer)
    • total_created (integer)
    • total_docs_scanned (integer)
    • total_in_use (integer)
    • total_keys_scanned (integer)
    • total_refreshing (integer)
    • total_tickets_reads (integer)
    • total_tickets_writes (integer)
    • ttl_deletes (integer)
    • ttl_passes (integer)
    • update_command_failed (integer)
    • update_command_total (integer)
    • updates (integer)
    • uptime_ns (integer)
    • version (string)
    • vsize_megabytes (integer)
    • wtcache_app_threads_page_read_count (integer)
    • wtcache_app_threads_page_read_time (integer)
    • wtcache_app_threads_page_write_count (integer)
    • wtcache_bytes_read_into (integer)
    • wtcache_bytes_written_from (integer)
    • wtcache_pages_read_into (integer)
    • wtcache_pages_requested_from (integer)
    • wtcache_current_bytes (integer)
    • wtcache_max_bytes_configured (integer)
    • wtcache_internal_pages_evicted (integer)
    • wtcache_modified_pages_evicted (integer)
    • wtcache_unmodified_pages_evicted (integer)
    • wtcache_pages_evicted_by_app_thread (integer)
    • wtcache_pages_queued_for_eviction (integer)
    • wtcache_server_evicting_pages (integer)
    • wtcache_tracked_dirty_bytes (integer)
    • wtcache_worker_thread_evictingpages (integer)
    • commands_per_sec (integer, deprecated in 1.10; use commands))
    • cursor_no_timeout (integer, opened/sec, deprecated in 1.10; use cursor_no_timeout_count))
    • cursor_pinned (integer, opened/sec, deprecated in 1.10; use cursor_pinned_count))
    • cursor_timed_out (integer, opened/sec, deprecated in 1.10; use cursor_timed_out_count))
    • cursor_total (integer, opened/sec, deprecated in 1.10; use cursor_total_count))
    • deletes_per_sec (integer, deprecated in 1.10; use deletes))
    • flushes_per_sec (integer, deprecated in 1.10; use flushes))
    • getmores_per_sec (integer, deprecated in 1.10; use getmores))
    • inserts_per_sec (integer, deprecated in 1.10; use inserts))
    • net_in_bytes (integer, bytes/sec, deprecated in 1.10; use net_out_bytes_count))
    • net_out_bytes (integer, bytes/sec, deprecated in 1.10; use net_out_bytes_count))
    • queries_per_sec (integer, deprecated in 1.10; use queries))
    • repl_commands_per_sec (integer, deprecated in 1.10; use repl_commands))
    • repl_deletes_per_sec (integer, deprecated in 1.10; use repl_deletes)
    • repl_getmores_per_sec (integer, deprecated in 1.10; use repl_getmores)
    • repl_inserts_per_sec (integer, deprecated in 1.10; use repl_inserts))
    • repl_queries_per_sec (integer, deprecated in 1.10; use repl_queries))
    • repl_updates_per_sec (integer, deprecated in 1.10; use repl_updates))
    • ttl_deletes_per_sec (integer, deprecated in 1.10; use ttl_deletes))
    • ttl_passes_per_sec (integer, deprecated in 1.10; use ttl_passes))
    • updates_per_sec (integer, deprecated in 1.10; use updates))

• mongodb_db_stats
  • tags:
    • db_name
    • hostname
  • fields:
    • avg_obj_size (float)
    • collections (integer)
    • data_size (integer)
    • index_size (integer)
    • indexes (integer)
    • num_extents (integer)
    • objects (integer)
    • ok (integer)
    • storage_size (integer)
    • type (string)

• mongodb_col_stats

  • tags:
    • hostname
    • collection
    • db_name
  • fields:
    • size (integer)
    • avg_obj_size (integer)
    • storage_size (integer)
    • total_index_size (integer)
    • ok (integer)
    • count (integer)
    • type (string)

• mongodb_shard_stats

  • tags:
    • hostname
  • fields:
    • in_use (integer)
    • available (integer)
    • created (integer)
    • refreshing (integer)

Example Output:

mongodb,hostname=127.0.0.1:27017 active_reads=3i,active_writes=0i,aggregate_command_failed=0i,aggregate_command_total=87210i,assert_msg=0i,assert_regular=0i,assert_rollovers=0i,assert_user=0i,assert_warning=0i,available_reads=125i,available_writes=128i,commands=218126i,commands_per_sec=1876i,connections_available=838853i,connections_current=7i,connections_total_created=8i,count_command_failed=0i,count_command_total=7i,cursor_no_timeout=0i,cursor_no_timeout_count=0i,cursor_pinned=0i,cursor_pinned_count=0i,cursor_timed_out=0i,cursor_timed_out_count=0i,cursor_total=0i,cursor_total_count=0i,delete_command_failed=0i,delete_command_total=0i,deletes=0i,deletes_per_sec=0i,distinct_command_failed=0i,distinct_command_total=87190i,document_deleted=0i,document_inserted=0i,document_returned=7i,document_updated=43595i,find_and_modify_command_failed=0i,find_and_modify_command_total=43595i,find_command_failed=0i,find_command_total=348819i,flushes=1i,flushes_per_sec=0i,flushes_total_time_ns=5000000i,get_more_command_failed=0i,get_more_command_total=0i,getmores=7i,getmores_per_sec=1i,insert_command_failed=0i,insert_command_total=0i,inserts=0i,inserts_per_sec=0i,jumbo_chunks=0i,latency_commands=44179i,latency_commands_count=122i,latency_reads=36662189i,latency_reads_count=523229i,latency_writes=6768713i,latency_writes_count=87190i,net_in_bytes=837378i,net_in_bytes_count=97692502i,net_out_bytes=690836i,net_out_bytes_count=75377383i,open_connections=7i,operation_scan_and_order=87193i,operation_write_conflicts=7i,page_faults=0i,percent_cache_dirty=0.9,percent_cache_used=1,queries=348816i,queries_per_sec=2988i,queued_reads=0i,queued_writes=0i,resident_megabytes=77i,storage_freelist_search_bucket_exhausted=0i,storage_freelist_search_requests=0i,storage_freelist_search_scanned=0i,tcmalloc_central_cache_free_bytes=280136i,tcmalloc_current_allocated_bytes=77677288i,tcmalloc_current_total_thread_cache_bytes=1222608i,tcmalloc_heap_size=142659584i,tcmalloc_max_total_thread_cache_bytes=260046848i,tcmalloc_pageheap_commit_count=1898i,tcmalloc_pageheap_committed_bytes=130084864i,tcmalloc_pageheap_decommit_count=889i,tcmalloc_pageheap_free_bytes=50610176i,tcmalloc_pageheap_reserve_count=50i,tcmalloc_pageheap_scavenge_count=884i,tcmalloc_pageheap_total_commit_bytes=13021937664i,tcmalloc_pageheap_total_decommit_bytes=12891852800i,tcmalloc_pageheap_total_reserve_bytes=142659584i,tcmalloc_pageheap_unmapped_bytes=12574720i,tcmalloc_spinlock_total_delay_ns=9767500i,tcmalloc_thread_cache_free_bytes=1222608i,tcmalloc_total_free_bytes=1797400i,tcmalloc_transfer_cache_free_bytes=294656i,total_available=0i,total_created=0i,total_docs_scanned=43595i,total_in_use=0i,total_keys_scanned=130805i,total_refreshing=0i,total_tickets_reads=128i,total_tickets_writes=128i,ttl_deletes=0i,ttl_deletes_per_sec=0i,ttl_passes=0i,ttl_passes_per_sec=0i,update_command_failed=0i,update_command_total=43595i,updates=43595i,updates_per_sec=372i,uptime_ns=60023000000i,version="3.6.17",vsize_megabytes=1048i,wtcache_app_threads_page_read_count=108i,wtcache_app_threads_page_read_time=25995i,wtcache_app_threads_page_write_count=0i,wtcache_bytes_read_into=2487250i,wtcache_bytes_written_from=74i,wtcache_current_bytes=5014530i,wtcache_internal_pages_evicted=0i,wtcache_max_bytes_configured=505413632i,wtcache_modified_pages_evicted=0i,wtcache_pages_evicted_by_app_thread=0i,wtcache_pages_queued_for_eviction=0i,wtcache_pages_read_into=139i,wtcache_pages_requested_from=699135i,wtcache_server_evicting_pages=0i,wtcache_tracked_dirty_bytes=4797426i,wtcache_unmodified_pages_evicted=0i,wtcache_worker_thread_evictingpages=0i 1586379818000000000
mongodb,hostname=127.0.0.1:27017,node_type=SEC,rs_name=rs0 active_reads=1i,active_writes=0i,aggregate_command_failed=0i,aggregate_command_total=1i,assert_msg=0i,assert_regular=0i,assert_rollovers=0i,assert_user=79i,assert_warning=0i,available_reads=127i,available_writes=128i,commands=1121855i,commands_per_sec=10i,connections_available=51183i,connections_current=17i,connections_total_created=557i,count_command_failed=0i,count_command_total=46307i,cursor_no_timeout=0i,cursor_no_timeout_count=0i,cursor_pinned=0i,cursor_pinned_count=0i,cursor_timed_out=0i,cursor_timed_out_count=28i,cursor_total=0i,cursor_total_count=0i,delete_command_failed=0i,delete_command_total=0i,deletes=0i,deletes_per_sec=0i,distinct_command_failed=0i,distinct_command_total=0i,document_deleted=0i,document_inserted=0i,document_returned=2248129i,document_updated=0i,find_and_modify_command_failed=0i,find_and_modify_command_total=0i,find_command_failed=2i,find_command_total=8764i,flushes=7850i,flushes_per_sec=0i,flushes_total_time_ns=4535446000000i,get_more_command_failed=0i,get_more_command_total=1993i,getmores=2018i,getmores_per_sec=0i,insert_command_failed=0i,insert_command_total=0i,inserts=0i,inserts_per_sec=0i,jumbo_chunks=0i,latency_commands=112011949i,latency_commands_count=1072472i,latency_reads=1877142443i,latency_reads_count=57086i,latency_writes=0i,latency_writes_count=0i,member_status="SEC",net_in_bytes=1212i,net_in_bytes_count=263928689i,net_out_bytes=41051i,net_out_bytes_count=2475389483i,open_connections=17i,operation_scan_and_order=34i,operation_write_conflicts=0i,page_faults=317i,percent_cache_dirty=1.6,percent_cache_used=73,queries=8764i,queries_per_sec=0i,queued_reads=0i,queued_writes=0i,repl_apply_batches_num=17839419i,repl_apply_batches_total_millis=399929i,repl_apply_ops=23355263i,repl_buffer_count=0i,repl_buffer_size_bytes=0i,repl_commands=11i,repl_commands_per_sec=0i,repl_deletes=440608i,repl_deletes_per_sec=0i,repl_executor_pool_in_progress_count=0i,repl_executor_queues_network_in_progress=0i,repl_executor_queues_sleepers=4i,repl_executor_unsignaled_events=0i,repl_getmores=0i,repl_getmores_per_sec=0i,repl_inserts=1875729i,repl_inserts_per_sec=0i,repl_lag=0i,repl_network_bytes=39122199371i,repl_network_getmores_num=34908797i,repl_network_getmores_total_millis=434805356i,repl_network_ops=23199086i,repl_oplog_window_sec=619292i,repl_queries=0i,repl_queries_per_sec=0i,repl_updates=21034729i,repl_updates_per_sec=38i,repl_state=2,resident_megabytes=6721i,state="SECONDARY",storage_freelist_search_bucket_exhausted=0i,storage_freelist_search_requests=0i,storage_freelist_search_scanned=0i,tcmalloc_central_cache_free_bytes=358512400i,tcmalloc_current_allocated_bytes=5427379424i,tcmalloc_current_total_thread_cache_bytes=70349552i,tcmalloc_heap_size=10199310336i,tcmalloc_max_total_thread_cache_bytes=1073741824i,tcmalloc_pageheap_commit_count=790819i,tcmalloc_pageheap_committed_bytes=7064821760i,tcmalloc_pageheap_decommit_count=533347i,tcmalloc_pageheap_free_bytes=1207816192i,tcmalloc_pageheap_reserve_count=7706i,tcmalloc_pageheap_scavenge_count=426235i,tcmalloc_pageheap_total_commit_bytes=116127649792i,tcmalloc_pageheap_total_decommit_bytes=109062828032i,tcmalloc_pageheap_total_reserve_bytes=10199310336i,tcmalloc_pageheap_unmapped_bytes=3134488576i,tcmalloc_spinlock_total_delay_ns=2518474348i,tcmalloc_thread_cache_free_bytes=70349552i,tcmalloc_total_free_bytes=429626144i,tcmalloc_transfer_cache_free_bytes=764192i,total_available=0i,total_created=0i,total_docs_scanned=735004782i,total_in_use=0i,total_keys_scanned=6188216i,total_refreshing=0i,total_tickets_reads=128i,total_tickets_writes=128i,ttl_deletes=0i,ttl_deletes_per_sec=0i,ttl_passes=7892i,ttl_passes_per_sec=0i,update_command_failed=0i,update_command_total=0i,updates=0i,updates_per_sec=0i,uptime_ns=473590288000000i,version="3.6.17",vsize_megabytes=11136i,wtcache_app_threads_page_read_count=11467625i,wtcache_app_threads_page_read_time=1700336840i,wtcache_app_threads_page_write_count=13268184i,wtcache_bytes_read_into=348022587843i,wtcache_bytes_written_from=322571702254i,wtcache_current_bytes=5509459274i,wtcache_internal_pages_evicted=109108i,wtcache_max_bytes_configured=7547650048i,wtcache_modified_pages_evicted=911196i,wtcache_pages_evicted_by_app_thread=17366i,wtcache_pages_queued_for_eviction=16572754i,wtcache_pages_read_into=11689764i,wtcache_pages_requested_from=499825861i,wtcache_server_evicting_pages=0i,wtcache_tracked_dirty_bytes=117487510i,wtcache_unmodified_pages_evicted=11058458i,wtcache_worker_thread_evictingpages=11907226i 1586379707000000000
mongodb_db_stats,db_name=admin,hostname=127.0.0.1:27017 avg_obj_size=241,collections=2i,data_size=723i,index_size=49152i,indexes=3i,num_extents=0i,objects=3i,ok=1i,storage_size=53248i,type="db_stat" 1547159491000000000
mongodb_db_stats,db_name=local,hostname=127.0.0.1:27017 avg_obj_size=813.9705882352941,collections=6i,data_size=55350i,index_size=102400i,indexes=5i,num_extents=0i,objects=68i,ok=1i,storage_size=204800i,type="db_stat" 1547159491000000000
mongodb_col_stats,collection=foo,db_name=local,hostname=127.0.0.1:27017 size=375005928i,avg_obj_size=5494,type="col_stat",storage_size=249307136i,total_index_size=2138112i,ok=1i,count=68251i 1547159491000000000
mongodb_shard_stats,hostname=127.0.0.1:27017,in_use=3i,available=3i,created=4i,refreshing=0i 1522799074000000000