Kapacitor measurements and fields

Kapacitor exposes internal performance through the /kacapitor/v1/debug/vars endpoint. Use the Telegraf kapacitor plugins to capture these metrics and store them in InfluxDB.

Enable the Kapacitor input plugin in your Telegraf configuration file:

# ...
[[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"
  ]
# ...

Visualize Kapacitor metrics

Use the Kapacitor Monitor dashboard to visualize Kapacitor metrics.

Kapacitor measurements & fields

Kapacitor exposes the following measurements and fields through the /kacapitor/v1/debug/vars endpoint.

• kapacitor
  • num_enabled_tasks
  • num_subscriptions
  • num_tasks
• kapacitor_edges
  • collected
  • emitted
• kapacitor_ingress
  • points_received
• kapacitor_load
  • errors
• kapacitor_memstats
  • alloc_bytes
  • buck_hash_sys_bytes
  • frees
  • gc_sys_bytes
  • gcc_pu_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 and subscriptions.

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_edges

The kapacitor_edges measurement stores fields with information related to edges 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.

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.

gcc_pu_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.

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

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.

collected

The number of events collected by Kapacitor topics.