Add descriptions for kapacitor input metrics (#6505)
This commit is contained in:
Scott Anderson
Daniel Nelson
parent
2754a484f9
commit
9efc37606f
|
|
@ -25,63 +25,247 @@ The Kapacitor plugin will collect metrics from the given Kapacitor instances.
|
||||||
|
|
||||||
### Measurements & Fields
|
### Measurements & Fields
|
||||||
|
|
||||||
- kapacitor
|
- [kapacitor](#kapacitor)
|
||||||
- num_enabled_tasks, integer
|
- [num_enabled_tasks](#num_enabled_tasks) _(integer)_
|
||||||
- num_subscriptions, integer
|
- [num_subscriptions](#num_subscriptions) _(integer)_
|
||||||
- num_tasks, integer
|
- [num_tasks](#num_tasks) _(integer)_
|
||||||
- kapacitor_edges
|
- [kapacitor_edges](#kapacitor_edges)
|
||||||
- collected, integer
|
- [collected](#collected) _(integer)_
|
||||||
- emitted, integer
|
- [emitted](#emitted) _(integer)_
|
||||||
- kapacitor_ingress
|
- [kapacitor_ingress](#kapacitor_ingress)
|
||||||
- points_received, integer
|
- [points_received](#points_received) _(integer)_
|
||||||
- kapacitor_memstats
|
- [kapacitor_load](#kapacitor_load)
|
||||||
- alloc_bytes, integer
|
- [errors](#errors) _(integer)_
|
||||||
- buck_hash_sys_bytes, integer
|
- [kapacitor_memstats](#kapacitor_memstats)
|
||||||
- frees, integer
|
- [alloc_bytes](#alloc_bytes) _(integer)_
|
||||||
- gcc_pu_fraction, float
|
- [buck_hash_sys_bytes](#buck_hash_sys_bytes) _(integer)_
|
||||||
- gc_sys_bytes, integer
|
- [frees](#frees) _(integer)_
|
||||||
- heap_alloc_bytes, integer
|
- [gc_sys_bytes](#gc_sys_bytes) _(integer)_
|
||||||
- heap_idle_bytes, integer
|
- [gcc_pu_fraction](#gcc_pu_fraction) _(float)_
|
||||||
- heap_inuse_bytes, integer
|
- [heap_alloc_bytes](#heap_alloc_bytes) _(integer)_
|
||||||
- heap_objects, integer
|
- [heap_idle_bytes](#heap_idle_bytes) _(integer)_
|
||||||
- heap_released_bytes, integer
|
- [heap_in_use_bytes](#heap_in_use_bytes) _(integer)_
|
||||||
- heap_sys_bytes, integer
|
- [heap_objects](#heap_objects) _(integer)_
|
||||||
- last_gc_ns, integer
|
- [heap_released_bytes](#heap_released_bytes) _(integer)_
|
||||||
- lookups, integer
|
- [heap_sys_bytes](#heap_sys_bytes) _(integer)_
|
||||||
- mallocs, integer
|
- [last_gc_ns](#last_gc_ns) _(integer)_
|
||||||
- mcache_in_use_bytes, integer
|
- [lookups](#lookups) _(integer)_
|
||||||
- mcache_sys_bytes, integer
|
- [mallocs](#mallocs) _(integer)_
|
||||||
- mspan_in_use_bytes, integer
|
- [mcache_in_use_bytes](#mcache_in_use_bytes) _(integer)_
|
||||||
- mspan_sys_bytes, integer
|
- [mcache_sys_bytes](#mcache_sys_bytes) _(integer)_
|
||||||
- next_gc_ns, integer
|
- [mspan_in_use_bytes](#mspan_in_use_bytes) _(integer)_
|
||||||
- num_gc, integer
|
- [mspan_sys_bytes](#mspan_sys_bytes) _(integer)_
|
||||||
- other_sys_bytes, integer
|
- [next_gc_ns](#next_gc_ns) _(integer)_
|
||||||
- pause_total_ns, integer
|
- [num_gc](#num_gc) _(integer)_
|
||||||
- stack_in_use_bytes, integer
|
- [other_sys_bytes](#other_sys_bytes) _(integer)_
|
||||||
- stack_sys_bytes, integer
|
- [pause_total_ns](#pause_total_ns) _(integer)_
|
||||||
- sys_bytes, integer
|
- [stack_in_use_bytes](#stack_in_use_bytes) _(integer)_
|
||||||
- total_alloc_bytes, integer
|
- [stack_sys_bytes](#stack_sys_bytes) _(integer)_
|
||||||
- kapacitor_nodes
|
- [sys_bytes](#sys_bytes) _(integer)_
|
||||||
- alerts_triggered, integer
|
- [total_alloc_bytes](#total_alloc_bytes) _(integer)_
|
||||||
- avg_exec_time_ns, integer
|
- [kapacitor_nodes](#kapacitor_nodes)
|
||||||
- batches_queried, integer
|
- [alerts_inhibited](#alerts_inhibited) _(integer)_
|
||||||
- crits_triggered, integer
|
- [alerts_triggered](#alerts_triggered) _(integer)_
|
||||||
- eval_errors, integer
|
- [avg_exec_time_ns](#avg_exec_time_ns) _(integer)_
|
||||||
- fields_defaulted, integer
|
- [crits_triggered](#crits_triggered) _(integer)_
|
||||||
- infos_triggered, integer
|
- [errors](#errors) _(integer)_
|
||||||
- oks_triggered, integer
|
- [infos_triggered](#infos_triggered) _(integer)_
|
||||||
- points_queried, integer
|
- [oks_triggered](#oks_triggered) _(integer)_
|
||||||
- points_written, integer
|
- [points_written](#points_written) _(integer)_
|
||||||
- query_errors, integer
|
- [warns_triggered](#warns_triggered) _(integer)_
|
||||||
- tags_defaulted, integer
|
- [write_errors](#write_errors) _(integer)_
|
||||||
- warns_triggered, integer
|
- [kapacitor_topics](#kapacitor_topics)
|
||||||
- write_errors, integer
|
- [collected](#collected) _(integer)_
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 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_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.
|
||||||
|
|
||||||
|
#### 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](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
|
||||||
|
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](https://docs.influxdata.com/kapacitor/latest/working/using_alert_topics/).
|
||||||
|
|
||||||
|
#### collected
|
||||||
|
The number of events collected by Kapacitor topics.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
*Note:* The Kapacitor variables `host`, `cluster_id`, and `server_id`
|
*Note:* The Kapacitor variables `host`, `cluster_id`, and `server_id`
|
||||||
are currently not recorded due to the potential high cardinality of
|
are currently not recorded due to the potential high cardinality of
|
||||||
these values.
|
these values.
|
||||||
|
|
||||||
### Example Output:
|
## Example Output
|
||||||
|
|
||||||
```
|
```
|
||||||
$ telegraf --config /etc/telegraf.conf --input-filter kapacitor --test
|
$ telegraf --config /etc/telegraf.conf --input-filter kapacitor --test
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue