--- title: Telegraf Documentation description: Telegraf plugin for collecting metrics from RavenDB url: https://docs.influxdata.com/telegraf/v1/input-plugins/ravendb/ estimated_tokens: 3495 product: Telegraf version: v1 --- - Telegraf v1.18.0+ # RavenDB Input Plugin This plugin gathers metrics from [RavenDB](https://ravendb.net/) servers via the monitoring API. This plugin requires RavenDB Server v5.2+. **Introduced in:** Telegraf v1.18.0 **Tags:** server **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 # Reads metrics from RavenDB servers via the Monitoring Endpoints [[inputs.ravendb]] ## Node URL and port that RavenDB is listening on. By default, ## attempts to connect securely over HTTPS, however, if the user ## is running a local unsecure development cluster users can use ## HTTP via a URL like "http://localhost:8080" url = "https://localhost:4433" ## RavenDB X509 client certificate setup # tls_cert = "/etc/telegraf/raven.crt" # tls_key = "/etc/telegraf/raven.key" ## Optional request timeout ## ## Timeout, specifies the amount of time to wait ## for a server's response headers after fully writing the request and ## time limit for requests made by this client # timeout = "5s" ## List of statistics which are collected # At least one is required # Allowed values: server, databases, indexes, collections # # stats_include = ["server", "databases", "indexes", "collections"] ## List of db where database stats are collected ## If empty, all db are concerned # db_stats_dbs = [] ## List of db where index status are collected ## If empty, all indexes from all db are concerned # index_stats_dbs = [] ## List of db where collection status are collected ## If empty, all collections from all db are concerned # collection_stats_dbs = [] ``` The client certificate should have `Operator` permissions on the cluster. ## Metrics - ravendb\_server - tags: - url - node\_tag - cluster\_id - public\_server\_url (optional) - fields: - backup\_current\_number\_of\_running\_backups - backup\_max\_number\_of\_concurrent\_backups - certificate\_server\_certificate\_expiration\_left\_in\_sec (optional) - certificate\_well\_known\_admin\_certificates (optional, separated by ‘;’) - cluster\_current\_term - cluster\_index - cluster\_node\_state - 0 -> Passive - 1 -> Candidate - 2 -> Follower - 3 -> LeaderElect - 4 -> Leader - config\_public\_tcp\_server\_urls (optional, separated by ‘;’) - config\_server\_urls - config\_tcp\_server\_urls (optional, separated by ‘;’) - cpu\_assigned\_processor\_count - cpu\_machine\_usage - cpu\_machine\_io\_wait (optional) - cpu\_process\_usage - cpu\_processor\_count - cpu\_thread\_pool\_available\_worker\_threads - cpu\_thread\_pool\_available\_completion\_port\_threads - databases\_loaded\_count - databases\_total\_count - disk\_remaining\_storage\_space\_percentage - disk\_system\_store\_used\_data\_file\_size\_in\_mb - disk\_system\_store\_total\_data\_file\_size\_in\_mb - disk\_total\_free\_space\_in\_mb - license\_expiration\_left\_in\_sec (optional) - license\_max\_cores - license\_type - license\_utilized\_cpu\_cores - memory\_allocated\_in\_mb - memory\_installed\_in\_mb - memory\_low\_memory\_severity - 0 -> None - 1 -> Low - 2 -> Extremely Low - memory\_physical\_in\_mb - memory\_total\_dirty\_in\_mb - memory\_total\_swap\_size\_in\_mb - memory\_total\_swap\_usage\_in\_mb - memory\_working\_set\_swap\_usage\_in\_mb - network\_concurrent\_requests\_count - network\_last\_authorized\_non\_cluster\_admin\_request\_time\_in\_sec (optional) - network\_last\_request\_time\_in\_sec (optional) - network\_requests\_per\_sec - network\_tcp\_active\_connections - network\_total\_requests - server\_full\_version - server\_process\_id - server\_version - uptime\_in\_sec - ravendb\_databases - tags: - url - database\_name - database\_id - node\_tag - public\_server\_url (optional) - fields: - counts\_alerts - counts\_attachments - counts\_documents - counts\_performance\_hints - counts\_rehabs - counts\_replication\_factor - counts\_revisions - counts\_unique\_attachments - statistics\_doc\_puts\_per\_sec - statistics\_map\_index\_indexes\_per\_sec - statistics\_map\_reduce\_index\_mapped\_per\_sec - statistics\_map\_reduce\_index\_reduced\_per\_sec - statistics\_request\_average\_duration\_in\_ms - statistics\_requests\_count - statistics\_requests\_per\_sec - indexes\_auto\_count - indexes\_count - indexes\_disabled\_count - indexes\_errors\_count - indexes\_errored\_count - indexes\_idle\_count - indexes\_stale\_count - indexes\_static\_count - storage\_documents\_allocated\_data\_file\_in\_mb - storage\_documents\_used\_data\_file\_in\_mb - storage\_indexes\_allocated\_data\_file\_in\_mb - storage\_indexes\_used\_data\_file\_in\_mb - storage\_total\_allocated\_storage\_file\_in\_mb - storage\_total\_free\_space\_in\_mb - storage\_io\_read\_operations (optional, Linux only) - storage\_io\_write\_operations (optional, Linux only) - storage\_read\_throughput\_in\_kb (optional, Linux only) - storage\_write\_throughput\_in\_kb (optional, Linux only) - storage\_queue\_length (optional, Linux only) - time\_since\_last\_backup\_in\_sec (optional) - uptime\_in\_sec - ravendb\_indexes - tags: - database\_name - index\_name - node\_tag - public\_server\_url (optional) - url - fields - errors - is\_invalid - lock\_mode - Unlock - LockedIgnore - LockedError - mapped\_per\_sec - priority - Low - Normal - High - reduced\_per\_sec - state - Normal - Disabled - Idle - Error - status - Running - Paused - Disabled - time\_since\_last\_indexing\_in\_sec (optional) - time\_since\_last\_query\_in\_sec (optional) - type - None - AutoMap - AutoMapReduce - Map - MapReduce - Faulty - JavaScriptMap - JavaScriptMapReduce - ravendb\_collections - tags: - collection\_name - database\_name - node\_tag - public\_server\_url (optional) - url - fields - documents\_count - documents\_size\_in\_bytes - revisions\_size\_in\_bytes - tombstones\_size\_in\_bytes - total\_size\_in\_bytes ## Example Output ```text ravendb_server,cluster_id=07aecc42-9194-4181-999c-1c42450692c9,host=DESKTOP-2OISR6D,node_tag=A,url=http://localhost:8080 backup_current_number_of_running_backups=0i,backup_max_number_of_concurrent_backups=4i,certificate_server_certificate_expiration_left_in_sec=-1,cluster_current_term=2i,cluster_index=10i,cluster_node_state=4i,config_server_urls="http://127.0.0.1:8080",cpu_assigned_processor_count=8i,cpu_machine_usage=19.09944089456869,cpu_process_usage=0.16977205323024872,cpu_processor_count=8i,cpu_thread_pool_available_completion_port_threads=1000i,cpu_thread_pool_available_worker_threads=32763i,databases_loaded_count=1i,databases_total_count=1i,disk_remaining_storage_space_percentage=18i,disk_system_store_total_data_file_size_in_mb=35184372088832i,disk_system_store_used_data_file_size_in_mb=31379031064576i,disk_total_free_space_in_mb=42931i,license_expiration_left_in_sec=24079222.8772186,license_max_cores=256i,license_type="Enterprise",license_utilized_cpu_cores=8i,memory_allocated_in_mb=205i,memory_installed_in_mb=16384i,memory_low_memory_severity=0i,memory_physical_in_mb=16250i,memory_total_dirty_in_mb=0i,memory_total_swap_size_in_mb=0i,memory_total_swap_usage_in_mb=0i,memory_working_set_swap_usage_in_mb=0i,network_concurrent_requests_count=1i,network_last_request_time_in_sec=0.0058717,network_requests_per_sec=0.09916543455308825,network_tcp_active_connections=128i,network_total_requests=10i,server_full_version="5.2.0-custom-52",server_process_id=31044i,server_version="5.2",uptime_in_sec=56i 1613027977000000000 ravendb_databases,database_id=ced0edba-8f80-48b8-8e81-c3d2c6748ec3,database_name=db1,host=DESKTOP-2OISR6D,node_tag=A,url=http://localhost:8080 counts_alerts=0i,counts_attachments=17i,counts_documents=1059i,counts_performance_hints=0i,counts_rehabs=0i,counts_replication_factor=1i,counts_revisions=5475i,counts_unique_attachments=17i,indexes_auto_count=0i,indexes_count=7i,indexes_disabled_count=0i,indexes_errored_count=0i,indexes_errors_count=0i,indexes_idle_count=0i,indexes_stale_count=0i,indexes_static_count=7i,statistics_doc_puts_per_sec=0,statistics_map_index_indexes_per_sec=0,statistics_map_reduce_index_mapped_per_sec=0,statistics_map_reduce_index_reduced_per_sec=0,statistics_request_average_duration_in_ms=0,statistics_requests_count=0i,statistics_requests_per_sec=0,storage_documents_allocated_data_file_in_mb=140737488355328i,storage_documents_used_data_file_in_mb=74741020884992i,storage_indexes_allocated_data_file_in_mb=175921860444160i,storage_indexes_used_data_file_in_mb=120722940755968i,storage_total_allocated_storage_file_in_mb=325455441821696i,storage_total_free_space_in_mb=42931i,uptime_in_sec=54 1613027977000000000 ravendb_indexes,database_name=db1,host=DESKTOP-2OISR6D,index_name=Orders/Totals,node_tag=A,url=http://localhost:8080 errors=0i,is_invalid=false,lock_mode="Unlock",mapped_per_sec=0,priority="Normal",reduced_per_sec=0,state="Normal",status="Running",time_since_last_indexing_in_sec=45.4256655,time_since_last_query_in_sec=45.4304202,type="Map" 1613027977000000000 ravendb_collections,collection_name=@hilo,database_name=db1,host=DESKTOP-2OISR6D,node_tag=A,url=http://localhost:8080 documents_count=8i,documents_size_in_bytes=122880i,revisions_size_in_bytes=0i,tombstones_size_in_bytes=122880i,total_size_in_bytes=245760i 1613027977000000000 ``` #### Related - [Configure plugins](/telegraf/v1/configure_plugins/) - [RavenDB Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/ravendb/README.md)