--- title: Telegraf Documentation description: Telegraf plugin for collecting metrics from Kapacitor url: https://docs.influxdata.com/telegraf/v1/input-plugins/kapacitor/ estimated_tokens: 6693 product: Telegraf version: v1 --- - Telegraf v1.3.0+ # Kapacitor Input Plugin This plugin collects metrics from the configured [InfluxData Kapacitor](https://www.influxdata.com/time-series-platform/kapacitor/) instances. **Introduced in:** Telegraf v1.3.0 **Tags:** applications **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 Kapacitor-formatted JSON metrics from one or more HTTP endpoints [[inputs.kapacitor]] ## Multiple URLs from which to read Kapacitor-formatted JSON ## Default is "http://localhost:9092/kapacitor/v1/debug/vars". urls = [ "http://localhost:9092/kapacitor/v1/debug/vars" ] ## Time limit for http requests timeout = "5s" ## 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 ``` ## Metrics ### Measurements and fields - kapacitor - num\_enabled\_tasks\_ - num\_subscriptions\_ - num\_tasks\_ - kapacitor\_alert - notification\_dropped\_ - primary-handle-count\_ - secondary-handle-count kapacitor\_cluster\_ - dropped\_member\_events\_ - dropped\_user\_events\_ - query\_handler\_errors\_ - kapacitor\_edges - collected\_ - emitted\_ - kapacitor\_ingress - points\_received\_ - kapacitor\_load - errors\_ - kapacitor\_memstats - alloc\_bytes\_ - buck\_hash\_sys\_bytes\_ - frees\_ - gc\_sys\_bytes\_ - gc\_cpu\_fraction\_ - heap\_alloc\_bytes\_ - heap\_idle\_bytes\_ - heap\_in\_use\_bytes\_ - heap\_objects\_ - heap\_released\_bytes\_ - heap\_sys\_bytes\_ - last\_gc\_ns\_ - lookups\_ - mallocs\_ - mcache\_in\_use\_bytes\_ - mcache\_sys\_bytes\_ - mspan\_in\_use\_bytes\_ - mspan\_sys\_bytes\_ - next\_gc\_ns\_ - num\_gc\_ - other\_sys\_bytes\_ - pause\_total\_ns\_ - stack\_in\_use\_bytes\_ - stack\_sys\_bytes\_ - sys\_bytes\_ - total\_alloc\_bytes\_ - kapacitor\_nodes - alerts\_inhibited\_ - alerts\_triggered\_ - avg\_exec\_time\_ns\_ - crits\_triggered\_ - errors\_ - infos\_triggered\_ - oks\_triggered\_ - points\_written\_ - warns\_triggered\_ - write\_errors\_ - kapacitor\_topics - collected\_ ## kapacitor The `kapacitor` measurement stores fields with information related to [Kapacitor tasks](https://docs.influxdata.com/kapacitor/latest/introduction/getting-started/#kapacitor-tasks) and [subscriptions](https://docs.influxdata.com/kapacitor/latest/administration/subscription-management/). ### num\_enabled\_tasks The number of enabled Kapacitor tasks. ### num\_subscriptions The number of Kapacitor/InfluxDB subscriptions. ### num\_tasks The total number of Kapacitor tasks. ## kapacitor\_alert The `kapacitor_alert` measurement stores fields with information related to [Kapacitor alerts](https://docs.influxdata.com/kapacitor/v1.5/working/alerts/). ### notification-dropped The number of internal notifications dropped because they arrive too late from another Kapacitor node. If this count is increasing, Kapacitor Enterprise nodes aren’t able to communicate fast enough to keep up with the volume of alerts. ### primary-handle-count The number of times this node handled an alert as the primary. This count should increase under normal conditions. ### secondary-handle-count The number of times this node handled an alert as the secondary. An increase in this counter indicates that the primary is failing to handle alerts in a timely manner. ## kapacitor\_cluster The `kapacitor_cluster` measurement reflects the ability of [Kapacitor nodes to communicate](https://docs.influxdata.com/enterprise_kapacitor/v1.5/administration/configuration/#cluster-communications) with one another. Specifically, these metrics track the gossip communication between the Kapacitor nodes. ### dropped\_member\_events The number of gossip member events that were dropped. ### dropped\_user\_events The number of gossip user events that were dropped. ### query\_handler\_errors The number of errors from event handlers. ## kapacitor\_edges The `kapacitor_edges` measurement stores fields with information related to [edges](https://docs.influxdata.com/kapacitor/latest/tick/introduction/#pipelines) in Kapacitor TICKscripts. ### collected The number of messages collected by TICKscript edges. ### emitted The number of messages emitted by TICKscript edges. ## kapacitor\_ingress The `kapacitor_ingress` measurement stores fields with information related to data coming into Kapacitor. ### points\_received The number of points received by Kapacitor. ## kapacitor\_load The `kapacitor_load` measurement stores fields with information related to the [Kapacitor Load Directory service](https://docs.influxdata.com/kapacitor/latest/guides/load_directory/). ### errors The number of errors reported from the load directory service. ## kapacitor\_memstats The `kapacitor_memstats` measurement stores fields related to Kapacitor memory usage. ### alloc\_bytes The number of bytes of memory allocated by Kapacitor that are still in use. ### buck\_hash\_sys\_bytes The number of bytes of memory used by the profiling bucket hash table. ### frees The number of heap objects freed. ### gc\_sys\_bytes The number of bytes of memory used for garbage collection system metadata. ### gc\_cpu\_fraction The fraction of Kapacitor’s available CPU time used by garbage collection since Kapacitor started. ### heap\_alloc\_bytes The number of reachable and unreachable heap objects garbage collection has not freed. ### heap\_idle\_bytes The number of heap bytes waiting to be used. ### heap\_in\_use\_bytes The number of heap bytes in use. ### heap\_objects The number of allocated objects. ### heap\_released\_bytes The number of heap bytes released to the operating system. ### heap\_sys\_bytes The number of heap bytes obtained from `system`. ### last\_gc\_ns The nanosecond epoch time of the last garbage collection. ### lookups The total number of pointer lookups. ### mallocs The total number of mallocs. ### mcache\_in\_use\_bytes The number of bytes in use by mcache structures. ### mcache\_sys\_bytes The number of bytes used for mcache structures obtained from `system`. ### mspan\_in\_use\_bytes The number of bytes in use by mspan structures. ### mspan\_sys\_bytes The number of bytes used for mspan structures obtained from `system`. ### next\_gc\_ns The nanosecond epoch time of the next garbage collection. ### num\_gc The number of completed garbage collection cycles. ### other\_sys\_bytes The number of bytes used for other system allocations. ### pause\_total\_ns The total number of nanoseconds spent in garbage collection “stop-the-world” pauses since Kapacitor started. ### stack\_in\_use\_bytes The number of bytes in use by the stack allocator. ### stack\_sys\_bytes The number of bytes obtained from `system` for stack allocator. ### sys\_bytes The number of bytes of memory obtained from `system`. ### total\_alloc\_bytes The total number of bytes allocated, even if freed. ## kapacitor\_nodes The `kapacitor_nodes` measurement stores fields related to events that occur in [TICKscript nodes](https://docs.influxdata.com/kapacitor/latest/nodes/). ### alerts\_inhibited The total number of alerts inhibited by TICKscripts. ### alerts\_triggered The total number of alerts triggered by TICKscripts. ### avg\_exec\_time\_ns The average execution time of TICKscripts in nanoseconds. ### crits\_triggered The number of critical (`crit`) alerts triggered by TICKscripts. ### errors (from TICKscripts) The number of errors caused caused by TICKscripts. ### infos\_triggered The number of info (`info`) alerts triggered by TICKscripts. ### oks\_triggered The number of ok (`ok`) alerts triggered by TICKscripts. #### points\_written The number of points written to InfluxDB or back to Kapacitor. #### warns\_triggered The number of warning (`warn`) alerts triggered by TICKscripts. #### working\_cardinality The total number of unique series processed. #### write\_errors The number of errors that occurred when writing to InfluxDB or other write endpoints. ### kapacitor\_topics The `kapacitor_topics` measurement stores fields related to Kapacitor topics\][topics](https://docs.influxdata.com/kapacitor/latest/working/using_alert_topics/). #### collected (kapacitor\_topics) The number of events collected by Kapacitor topics. **Note:** The Kapacitor variables `host`, `cluster_id`, and `server_id` are currently not recorded due to the potential high cardinality of these values. ## Example Output ```text kapacitor_memstats,host=hostname.local,kap_version=1.1.0~rc2,url=http://localhost:9092/kapacitor/v1/debug/vars alloc_bytes=6974808i,buck_hash_sys_bytes=1452609i,frees=207281i,gc_sys_bytes=802816i,gc_cpu_fraction=0.00004693548939673313,heap_alloc_bytes=6974808i,heap_idle_bytes=6742016i,heap_in_use_bytes=9183232i,heap_objects=23216i,heap_released_bytes=0i,heap_sys_bytes=15925248i,last_gc_ns=1478791460012676997i,lookups=88i,mallocs=230497i,mcache_in_use_bytes=9600i,mcache_sys_bytes=16384i,mspan_in_use_bytes=98560i,mspan_sys_bytes=131072i,next_gc_ns=11467528i,num_gc=8i,other_sys_bytes=2236087i,pause_total_ns=2994110i,stack_in_use_bytes=1900544i,stack_sys_bytes=1900544i,sys_bytes=22464760i,total_alloc_bytes=35023600i 1478791462000000000 kapacitor,host=hostname.local,kap_version=1.1.0~rc2,url=http://localhost:9092/kapacitor/v1/debug/vars num_enabled_tasks=5i,num_subscriptions=5i,num_tasks=5i 1478791462000000000 kapacitor_edges,child=stream0,host=hostname.local,parent=stream,task=deadman-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=shard,retention_policy=monitor,task_master=main points_received=120 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=subscriber,retention_policy=monitor,task_master=main points_received=60 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=http_out,node=http_out3,task=sys-stats,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=window6,host=hostname.local,parent=derivative5,task=deadman-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=from,node=from1,task=sys-stats,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=stream,node=stream0,task=test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=window,node=window6,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=cq,retention_policy=monitor,task_master=main points_received=10 1478791462000000000 kapacitor_edges,child=http_out3,host=hostname.local,parent=window2,task=sys-stats,type=batch collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=mean4,host=hostname.local,parent=log3,task=deadman-test,type=batch collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_kapacitor,host=hostname.local,measurement=nodes,retention_policy=autogen,task_master=main points_received=207 1478791462000000000 kapacitor_edges,child=stream0,host=hostname.local,parent=stream,task=sys-stats,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=log6,host=hostname.local,parent=sum5,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=from1,host=hostname.local,parent=stream0,task=sys-stats,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=alert,node=alert2,task=test,type=stream alerts_triggered=0,avg_exec_time_ns=0i,crits_triggered=0,infos_triggered=0,oks_triggered=0,warns_triggered=0 1478791462000000000 kapacitor_edges,child=log3,host=hostname.local,parent=derivative2,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_kapacitor,host=hostname.local,measurement=runtime,retention_policy=autogen,task_master=main points_received=9 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=tsm1_filestore,retention_policy=monitor,task_master=main points_received=120 1478791462000000000 kapacitor_edges,child=derivative2,host=hostname.local,parent=from1,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=stream,node=stream0,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=queryExecutor,retention_policy=monitor,task_master=main points_received=10 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=tsm1_wal,retention_policy=monitor,task_master=main points_received=120 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=log,node=log6,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=stream,host=hostname.local,parent=stats,task=task_master:main,type=stream collected=598,emitted=598 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=write,retention_policy=monitor,task_master=main points_received=10 1478791462000000000 kapacitor_edges,child=stream0,host=hostname.local,parent=stream,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=log,node=log3,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=from,node=from1,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_kapacitor,host=hostname.local,measurement=ingress,retention_policy=autogen,task_master=main points_received=148 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=eval,node=eval4,task=derivative-test,type=stream avg_exec_time_ns=0i,eval_errors=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=derivative,node=derivative2,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=runtime,retention_policy=monitor,task_master=main points_received=10 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=httpd,retention_policy=monitor,task_master=main points_received=10 1478791462000000000 kapacitor_edges,child=sum5,host=hostname.local,parent=eval4,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_kapacitor,host=hostname.local,measurement=kapacitor,retention_policy=autogen,task_master=main points_received=9 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=from,node=from1,task=test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=tsm1_engine,retention_policy=monitor,task_master=main points_received=120 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=window,node=window2,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=stream,node=stream0,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=influxdb_out4,host=hostname.local,parent=http_out3,task=sys-stats,type=batch collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=window2,host=hostname.local,parent=from1,task=deadman-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=from,node=from1,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=from1,host=hostname.local,parent=stream0,task=deadman-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=database,retention_policy=monitor,task_master=main points_received=40 1478791462000000000 kapacitor_edges,child=stream,host=hostname.local,parent=write_points,task=task_master:main,type=stream collected=750,emitted=750 1478791462000000000 kapacitor_edges,child=log7,host=hostname.local,parent=window6,task=deadman-test,type=batch collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=window2,host=hostname.local,parent=from1,task=sys-stats,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=log,node=log7,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_ingress,database=_kapacitor,host=hostname.local,measurement=edges,retention_policy=autogen,task_master=main points_received=225 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=derivative,node=derivative5,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=from1,host=hostname.local,parent=stream0,task=test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=alert2,host=hostname.local,parent=from1,task=test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=log,node=log3,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=influxdb_out,node=influxdb_out4,task=sys-stats,type=stream avg_exec_time_ns=0i,points_written=0,write_errors=0 1478791462000000000 kapacitor_edges,child=stream0,host=hostname.local,parent=stream,task=test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=log3,host=hostname.local,parent=window2,task=deadman-test,type=batch collected=0,emitted=0 1478791462000000000 kapacitor_edges,child=derivative5,host=hostname.local,parent=mean4,task=deadman-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=stream,node=stream0,task=sys-stats,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=window,node=window2,task=sys-stats,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=mean,node=mean4,task=deadman-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=from1,host=hostname.local,parent=stream0,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 kapacitor_ingress,database=_internal,host=hostname.local,measurement=tsm1_cache,retention_policy=monitor,task_master=main points_received=120 1478791462000000000 kapacitor_nodes,host=hostname.local,kind=sum,node=sum5,task=derivative-test,type=stream avg_exec_time_ns=0i 1478791462000000000 kapacitor_edges,child=eval4,host=hostname.local,parent=log3,task=derivative-test,type=stream collected=0,emitted=0 1478791462000000000 ``` #### Related - [Configure plugins](/telegraf/v1/configure_plugins/) - [Kapacitor Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/kapacitor/README.md)