--- title: Telegraf Documentation description: Telegraf plugin for collecting metrics from MongoDB url: https://docs.influxdata.com/telegraf/v1/input-plugins/mongodb/ estimated_tokens: 7291 product: Telegraf version: v1 --- - Telegraf v0.1.5+ # MongoDB Input Plugin This plugin collects metrics about [MongoDB](https://www.mongodb.com) server instances by running database commands. This plugin supports all versions marked as supported in the [MongoDB Software Lifecycle Schedules](https://www.mongodb.com/support-policy/lifecycles). **Introduced in:** Telegraf v0.1.5 **Tags:** datastore **OS support:** all ## Global configuration options Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details. ## Configuration ```toml # Read metrics from one or many MongoDB servers [[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, ## ## If connecting to a cluster, users must include the "?connect=direct" in ## the URL to ensure that the connection goes directly to the specified node ## and not have all connections passed to the master node. servers = ["mongodb://127.0.0.1:27017/?connect=direct"] ## 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 ## When true, collect usage statistics for each collection ## (insert, update, queries, remove, getmore, commands etc...). # gather_top_stat = false ## List of db where collections stats are collected ## If empty, all db are concerned # col_stats_dbs = ["local"] ## Optional TLS Config ## Set to true/false to enforce TLS being enabled/disabled. If not set, ## enable TLS only if any of the other options are specified. # tls_enable = ## Trusted root certificates for server # tls_ca = "/path/to/cafile" ## Used for TLS client certificate authentication # tls_cert = "/path/to/certfile" ## Used for TLS client certificate authentication # tls_key = "/path/to/keyfile" ## Password for the key file if it is encrypted # tls_key_pwd = "" ## Send the specified TLS server name via SNI # tls_server_name = "kubernetes.example.com" ## Minimal TLS version to accept by the client # tls_min_version = "TLS12" ## List of ciphers to accept, by default all secure ciphers will be accepted ## See https://pkg.go.dev/crypto/tls#pkg-constants for supported values. ## Use "all", "secure" and "insecure" to add all support ciphers, secure ## suites or insecure suites respectively. # tls_cipher_suites = ["secure"] ## Renegotiation method, "never", "once" or "freely" # tls_renegotiation_method = "never" ## Use TLS but skip chain & host verification # insecure_skip_verify = false ## Specifies plugin behavior regarding disconnected servers ## Available choices : ## - error: telegraf will return an error on startup if one the servers is unreachable ## - skip: telegraf will skip unreachable servers on both startup and gather # disconnected_servers_behavior = "error" ``` ### 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: ```shell > 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: ```shell 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) - repl\_member\_health (integer) - repl\_health\_avg (float) - 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) - wt\_connection\_files\_currently\_open (integer) - wt\_data\_handles\_currently\_active (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) - fs\_used\_size (integer) - fs\_total\_size (integer) - 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) - mongodb\_top\_stats - tags: - collection - fields: - total\_time (integer) - total\_count (integer) - read\_lock\_time (integer) - read\_lock\_count (integer) - write\_lock\_time (integer) - write\_lock\_count (integer) - queries\_time (integer) - queries\_count (integer) - get\_more\_time (integer) - get\_more\_count (integer) - insert\_time (integer) - insert\_count (integer) - update\_time (integer) - update\_count (integer) - remove\_time (integer) - remove\_count (integer) - commands\_time (integer) - commands\_count (integer) ## Example Output ```text mongodb,hostname=127.0.0.1:27017 active_reads=1i,active_writes=0i,aggregate_command_failed=0i,aggregate_command_total=0i,assert_msg=0i,assert_regular=0i,assert_rollovers=0i,assert_user=0i,assert_warning=0i,available_reads=127i,available_writes=128i,commands=65i,commands_per_sec=4i,connections_available=51199i,connections_current=1i,connections_total_created=5i,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=1i,deletes=1i,deletes_per_sec=0i,distinct_command_failed=0i,distinct_command_total=0i,document_deleted=0i,document_inserted=0i,document_returned=0i,document_updated=0i,find_and_modify_command_failed=0i,find_and_modify_command_total=0i,find_command_failed=0i,find_command_total=1i,flushes=52i,flushes_per_sec=0i,flushes_total_time_ns=364000000i,get_more_command_failed=0i,get_more_command_total=0i,getmores=0i,getmores_per_sec=0i,insert_command_failed=0i,insert_command_total=0i,inserts=0i,inserts_per_sec=0i,jumbo_chunks=0i,latency_commands=5740i,latency_commands_count=46i,latency_reads=348i,latency_reads_count=7i,latency_writes=0i,latency_writes_count=0i,net_in_bytes=296i,net_in_bytes_count=4262i,net_out_bytes=29322i,net_out_bytes_count=242103i,open_connections=1i,operation_scan_and_order=0i,operation_write_conflicts=0i,page_faults=1i,percent_cache_dirty=0,percent_cache_used=0,queries=1i,queries_per_sec=0i,queued_reads=0i,queued_writes=0i,resident_megabytes=33i,storage_freelist_search_bucket_exhausted=0i,storage_freelist_search_requests=0i,storage_freelist_search_scanned=0i,tcmalloc_central_cache_free_bytes=0i,tcmalloc_current_allocated_bytes=0i,tcmalloc_current_total_thread_cache_bytes=0i,tcmalloc_heap_size=0i,tcmalloc_max_total_thread_cache_bytes=0i,tcmalloc_pageheap_commit_count=0i,tcmalloc_pageheap_committed_bytes=0i,tcmalloc_pageheap_decommit_count=0i,tcmalloc_pageheap_free_bytes=0i,tcmalloc_pageheap_reserve_count=0i,tcmalloc_pageheap_scavenge_count=0i,tcmalloc_pageheap_total_commit_bytes=0i,tcmalloc_pageheap_total_decommit_bytes=0i,tcmalloc_pageheap_total_reserve_bytes=0i,tcmalloc_pageheap_unmapped_bytes=0i,tcmalloc_spinlock_total_delay_ns=0i,tcmalloc_thread_cache_free_bytes=0i,tcmalloc_total_free_bytes=0i,tcmalloc_transfer_cache_free_bytes=0i,total_available=0i,total_created=0i,total_docs_scanned=0i,total_in_use=0i,total_keys_scanned=0i,total_refreshing=0i,total_tickets_reads=128i,total_tickets_writes=128i,ttl_deletes=0i,ttl_deletes_per_sec=0i,ttl_passes=51i,ttl_passes_per_sec=0i,update_command_failed=0i,update_command_total=0i,updates=0i,updates_per_sec=0i,uptime_ns=6135152000000i,version="4.0.19",vsize_megabytes=5088i,wt_connection_files_currently_open=13i,wt_data_handles_currently_active=18i,wtcache_app_threads_page_read_count=99i,wtcache_app_threads_page_read_time=44528i,wtcache_app_threads_page_write_count=19i,wtcache_bytes_read_into=3248195i,wtcache_bytes_written_from=170612i,wtcache_current_bytes=3648788i,wtcache_internal_pages_evicted=0i,wtcache_max_bytes_configured=8053063680i,wtcache_modified_pages_evicted=0i,wtcache_pages_evicted_by_app_thread=0i,wtcache_pages_queued_for_eviction=0i,wtcache_pages_read_into=234i,wtcache_pages_requested_from=18235i,wtcache_server_evicting_pages=0i,wtcache_tracked_dirty_bytes=0i,wtcache_unmodified_pages_evicted=0i,wtcache_worker_thread_evictingpages=0i 1595691605000000000 mongodb,hostname=127.0.0.1:27017,node_type=PRI,rs_name=rs0 active_reads=1i,active_writes=0i,aggregate_command_failed=0i,aggregate_command_total=0i,assert_msg=0i,assert_regular=0i,assert_rollovers=0i,assert_user=25i,assert_warning=0i,available_reads=127i,available_writes=128i,commands=345i,commands_per_sec=4i,connections_available=838853i,connections_current=7i,connections_total_created=13i,count_command_failed=0i,count_command_total=5i,cursor_no_timeout=0i,cursor_no_timeout_count=0i,cursor_pinned=0i,cursor_pinned_count=2i,cursor_timed_out=0i,cursor_timed_out_count=0i,cursor_total=0i,cursor_total_count=4i,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=2i,document_returned=56i,document_updated=0i,find_and_modify_command_failed=0i,find_and_modify_command_total=0i,find_command_failed=0i,find_command_total=23i,flushes=4i,flushes_per_sec=0i,flushes_total_time_ns=43000000i,get_more_command_failed=0i,get_more_command_total=88i,getmores=88i,getmores_per_sec=0i,insert_command_failed=0i,insert_command_total=2i,inserts=2i,inserts_per_sec=0i,jumbo_chunks=0i,latency_commands=82532i,latency_commands_count=337i,latency_reads=30633i,latency_reads_count=111i,latency_writes=0i,latency_writes_count=0i,member_status="PRI",net_in_bytes=636i,net_in_bytes_count=172300i,net_out_bytes=38849i,net_out_bytes_count=335459i,open_connections=7i,operation_scan_and_order=1i,operation_write_conflicts=0i,page_faults=1i,percent_cache_dirty=0,percent_cache_used=0,queries=23i,queries_per_sec=2i,queued_reads=0i,queued_writes=0i,repl_apply_batches_num=0i,repl_apply_batches_total_millis=0i,repl_apply_ops=0i,repl_buffer_count=0i,repl_buffer_size_bytes=0i,repl_commands=0i,repl_commands_per_sec=0i,repl_deletes=0i,repl_deletes_per_sec=0i,repl_executor_pool_in_progress_count=0i,repl_executor_queues_network_in_progress=0i,repl_executor_queues_sleepers=3i,repl_executor_unsignaled_events=0i,repl_getmores=0i,repl_getmores_per_sec=0i,repl_inserts=0i,repl_inserts_per_sec=0i,repl_lag=0i,repl_network_bytes=0i,repl_network_getmores_num=0i,repl_network_getmores_total_millis=0i,repl_network_ops=0i,repl_oplog_window_sec=140i,repl_queries=0i,repl_queries_per_sec=0i,repl_state=1i,repl_updates=0i,repl_updates_per_sec=0i,resident_megabytes=81i,state="PRIMARY",storage_freelist_search_bucket_exhausted=0i,storage_freelist_search_requests=0i,storage_freelist_search_scanned=0i,tcmalloc_central_cache_free_bytes=322128i,tcmalloc_current_allocated_bytes=143566680i,tcmalloc_current_total_thread_cache_bytes=1098968i,tcmalloc_heap_size=181317632i,tcmalloc_max_total_thread_cache_bytes=260046848i,tcmalloc_pageheap_commit_count=53i,tcmalloc_pageheap_committed_bytes=149106688i,tcmalloc_pageheap_decommit_count=1i,tcmalloc_pageheap_free_bytes=3244032i,tcmalloc_pageheap_reserve_count=51i,tcmalloc_pageheap_scavenge_count=1i,tcmalloc_pageheap_total_commit_bytes=183074816i,tcmalloc_pageheap_total_decommit_bytes=33968128i,tcmalloc_pageheap_total_reserve_bytes=181317632i,tcmalloc_pageheap_unmapped_bytes=32210944i,tcmalloc_spinlock_total_delay_ns=0i,tcmalloc_thread_cache_free_bytes=1098968i,tcmalloc_total_free_bytes=2295976i,tcmalloc_transfer_cache_free_bytes=874880i,total_available=0i,total_created=0i,total_docs_scanned=56i,total_in_use=0i,total_keys_scanned=2i,total_refreshing=0i,total_tickets_reads=128i,total_tickets_writes=128i,ttl_deletes=0i,ttl_deletes_per_sec=0i,ttl_passes=2i,ttl_passes_per_sec=0i,update_command_failed=0i,update_command_total=0i,updates=0i,updates_per_sec=0i,uptime_ns=166481000000i,version="4.0.19",vsize_megabytes=1482i,wt_connection_files_currently_open=26i,wt_data_handles_currently_active=44i,wtcache_app_threads_page_read_count=0i,wtcache_app_threads_page_read_time=0i,wtcache_app_threads_page_write_count=56i,wtcache_bytes_read_into=0i,wtcache_bytes_written_from=130403i,wtcache_current_bytes=100312i,wtcache_internal_pages_evicted=0i,wtcache_max_bytes_configured=506462208i,wtcache_modified_pages_evicted=0i,wtcache_pages_evicted_by_app_thread=0i,wtcache_pages_queued_for_eviction=0i,wtcache_pages_read_into=0i,wtcache_pages_requested_from=2085i,wtcache_server_evicting_pages=0i,wtcache_tracked_dirty_bytes=63929i,wtcache_unmodified_pages_evicted=0i,wtcache_worker_thread_evictingpages=0i 1595691605000000000 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 mongodb_top_stats,collection=foo,total_time=1471,total_count=158,read_lock_time=49614,read_lock_count=657,write_lock_time=49125456,write_lock_count=9841,queries_time=174,queries_count=495,get_more_time=498,get_more_count=46,insert_time=2651,insert_count=1265,update_time=0,update_count=0,remove_time=0,remove_count=0,commands_time=498611,commands_count=4615 ``` #### Related - [Configure plugins](/telegraf/v1/configure_plugins/) - [MongoDB Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/mongodb/README.md)