Add descriptions for measurement & fields (#7902)

This commit is contained in:
kelseiv 2020-08-06 11:05:35 -07:00 committed by GitHub
parent eb162ddaa4
commit 198f92be41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 38 deletions

View File

@ -37,46 +37,45 @@ InfluxDB-formatted endpoints. See below for more information.
### Measurements & Fields ### Measurements & Fields
**Note:** The measurements and fields are dynamically built from the InfluxDB source, **Note:** The measurements and fields included in this plugin are dynamically built from the InfluxDB source, and may vary between versions:
and may vary between versions.
- influxdb - influxdb
- n_shards - n_shards: The total number of shards in the specified database.
- influxdb_database - influxdb_database: The database metrics are being collected from.
- influxdb_httpd - influxdb_httpd: The URL to listen for network requests. By default, `http://localhost:8086/debug/var`.
- influxdb_measurement - influxdb_measurement: The measurement that metrics are collected from.
- influxdb_memstats - influxdb_memstats: Statistics about the memory allocator in the specified database.
- heap_inuse - heap_inuse: The number of bytes in in-use spans.
- heap_released - heap_released: The number of bytes of physical memory returned to the OS.
- mspan_inuse - mspan_inuse: The number of bytes in in-use mspans.
- total_alloc - total_alloc: The cumulative bytes allocated for heap objects.
- sys - sys: The total number of bytes of memory obtained from the OS. Measures the virtual address space reserved by the Go runtime for the heap, stacks, and other internal data structures.
- mallocs - mallocs: The total number of heap objects allocated. (The total number of live objects are frees.)
- frees - frees: The cumulative number of freed (live) heap objects.
- heap_idle - heap_idle: The number of bytes of idle heap objects.
- pause_total_ns - pause_total_ns: The total time garbage collection cycles are paused in nanoseconds.
- lookups - lookups: The number of pointer lookups performed by the runtime. Primarily useful for debugging runtime internals.
- heap_sys - heap_sys: The number of bytes of heap memory obtained from the OS. Measures the amount of virtual address space reserved for the heap.
- mcache_sys - mcache_sys: The bytes of memory obtained from the OS for mcache structures.
- next_gc - next_gc: The target heap size of the next garbage collection cycle.
- gc_cpu_fraction - gc_cpu_fraction: The fraction of CPU time used by the garbage collection cycle.
- other_sys - other_sys: The number of bytes of memory used other than heap_sys, stacks_sys, mspan_sys, mcache_sys, buckhash_sys, and gc_sys.
- alloc - alloc: The currently allocated number of bytes of heap objects.
- stack_inuse - stack_inuse: The number of bytes in in-use stacks.
- stack_sys - stack_sys: The total number of bytes of memory obtained from the stack in use.
- buck_hash_sys - buck_hash_sys: The bytes of memory in profiling bucket hash tables.
- gc_sys - gc_sys: The bytes of memory in garbage collection metadata.
- num_gc - num_gc: The number of completed garbage collection cycles.
- heap_alloc - heap_alloc: The size, in bytes, of all heap objects.
- heap_objects - heap_objects: The number of allocated heap objects.
- mspan_sys - mspan_sys: The bytes of memory obtained from the OS for mspan.
- mcache_inuse - mcache_inuse: The bytes of allocated mcache structures.
- last_gc - last_gc: Time the last garbage collection finished, as nanoseconds since 1970 (the UNIX epoch).
- influxdb_shard - influxdb_shard: The shard metrics are collected from.
- influxdb_subscriber - influxdb_subscriber: The InfluxDB subscription that metrics are collected from.
- influxdb_tsm1_cache - influxdb_tsm1_cache: The TSM cache that metrics are collected from.
- influxdb_tsm1_wal - influxdb_tsm1_wal: The TSM Write Ahead Log (WAL) that metrics are collected from.
- influxdb_write - influxdb_write: The total writes to the specified database.
### Example Output: ### Example Output: