fix: update influxdb input schema documentation (#10029)
This commit is contained in:
Scott Anderson
GitHub
parent
317dd38af3
commit
934db67c2b
|
|
@ -41,54 +41,222 @@ InfluxDB-formatted endpoints. See below for more information.
|
|||
|
||||
**Note:** The measurements and fields included in this plugin are dynamically built from the InfluxDB source, and may vary between versions:
|
||||
|
||||
- influxdb
|
||||
- n_shards: The total number of shards in the specified database.
|
||||
- influxdb_ae _(Enterprise Only)_ : Statistics related to the Anti-Entropy (AE) engine in InfluxDB Enterprise clusters.
|
||||
- influxdb_cluster _(Enterprise Only)_ : Statistics related to the clustering features of the data nodes in InfluxDB Enterprise clusters.
|
||||
- influxdb_cq: The metrics related to continuous queries (CQs).
|
||||
- influxdb_database: The database metrics are being collected from.
|
||||
- influxdb_hh _(Enterprise Only)_ : Events resulting in new hinted handoff (HH) processors in InfluxDB Enterprise clusters.
|
||||
- influxdb_hh_database _(Enterprise Only)_ : Aggregates all hinted handoff queues for a single database and node.
|
||||
- influxdb_hh_processor _(Enterprise Only)_ : Statistics stored for a single queue (shard).
|
||||
- influxdb_httpd: The URL to listen for network requests. By default, `http://localhost:8086/debug/var`.
|
||||
- influxdb_measurement: The measurement that metrics are collected from.
|
||||
- influxdb_memstats: Statistics about the memory allocator in the specified database.
|
||||
- heap_inuse: The number of bytes in in-use spans.
|
||||
- heap_released: The number of bytes of physical memory returned to the OS.
|
||||
- mspan_inuse: The number of bytes in in-use mspans.
|
||||
- total_alloc: The cumulative bytes allocated for heap objects.
|
||||
- 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: The total number of heap objects allocated. (The total number of live objects are frees.)
|
||||
- frees: The cumulative number of freed (live) heap objects.
|
||||
- heap_idle: The number of bytes of idle heap objects.
|
||||
- pause_total_ns: The total time garbage collection cycles are paused in nanoseconds.
|
||||
- lookups: The number of pointer lookups performed by the runtime. Primarily useful for debugging runtime internals.
|
||||
- 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: The bytes of memory obtained from the OS for mcache structures.
|
||||
- next_gc: The target heap size of the next garbage collection cycle.
|
||||
- gc_cpu_fraction: The fraction of CPU time used by the garbage collection cycle.
|
||||
- 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: The currently allocated number of bytes of heap objects.
|
||||
- stack_inuse: The number of bytes in in-use stacks.
|
||||
- stack_sys: The total number of bytes of memory obtained from the stack in use.
|
||||
- buck_hash_sys: The bytes of memory in profiling bucket hash tables.
|
||||
- gc_sys: The bytes of memory in garbage collection metadata.
|
||||
- num_gc: The number of completed garbage collection cycles.
|
||||
- heap_alloc: The size, in bytes, of all heap objects.
|
||||
- heap_objects: The number of allocated heap objects.
|
||||
- mspan_sys: The bytes of memory obtained from the OS for mspan.
|
||||
- mcache_inuse: The bytes of allocated mcache structures.
|
||||
- last_gc: Time the last garbage collection finished, as nanoseconds since 1970 (the UNIX epoch).
|
||||
- influxdb_queryExecutor: Query Executor metrics of the InfluxDB engine.
|
||||
- influxdb_rpc _(Enterprise Only)_ : Statistics are related to the use of RPC calls within InfluxDB Enterprise clusters.
|
||||
- influxdb_runtime: The shard metrics are collected from.
|
||||
- influxdb_shard: The shard metrics are collected from.
|
||||
- influxdb_subscriber: The InfluxDB subscription that metrics are collected from.
|
||||
- influxdb_tsm1_cache: The TSM cache that metrics are collected from.
|
||||
- influxdb_tsm1_engine: The TSM storage engine that metrics are collected from.
|
||||
- influxdb_tsm1_filestore: The TSM file store that metrics are collected from.
|
||||
- influxdb_tsm1_wal: The TSM Write Ahead Log (WAL) that metrics are collected from.
|
||||
- influxdb_write: The total writes to the specified database.
|
||||
- **influxdb_ae** _(Enterprise Only)_ : Statistics related to the Anti-Entropy (AE) engine in InfluxDB Enterprise clusters.
|
||||
- **bytesRx**: Number of bytes received by the data node.
|
||||
- **errors**: Total number of anti-entropy jobs that have resulted in errors.
|
||||
- **jobs**: Total number of jobs executed by the data node.
|
||||
- **jobsActive**: Number of active (currently executing) jobs.
|
||||
- **influxdb_cluster** _(Enterprise Only)_ : Statistics related to the clustering features of the data nodes in InfluxDB Enterprise clusters.
|
||||
- **copyShardReq**: Number of internal requests made to copy a shard from one data node to another.
|
||||
- **createIteratorReq**: Number of read requests from other data nodes in the cluster.
|
||||
- **expandSourcesReq**: Number of remote node requests made to find measurements on this node that match a particular regular expression.
|
||||
- **fieldDimensionsReq**: Number of remote node requests for information about the fields and associated types, and tag keys of measurements on this data node.
|
||||
- **iteratorCostReq**: Number of internal requests for iterator cost.
|
||||
- **removeShardReq**: Number of internal requests to delete a shard from this data node. Exclusively incremented by use of the influxd-ctl remove shard command.
|
||||
- **writeShardFail**: Total number of internal write requests from a remote node that failed.
|
||||
- **writeShardPointsReq**: Number of points in every internal write request from any remote node, regardless of success.
|
||||
- **writeShardReq**: Number of internal write requests from a remote data node, regardless of success.
|
||||
- **influxdb_cq**: Metrics related to continuous queries (CQs).
|
||||
- **queryFail**: Total number of continuous queries that executed but failed.
|
||||
- **queryOk**: Total number of continuous queries that executed successfully.
|
||||
- **influxdb_database**: Database metrics are collected from.
|
||||
- **numMeasurements**: Current number of measurements in the specified database.
|
||||
- **numSeries**: Current series cardinality of the specified database.
|
||||
- **influxdb_hh** _(Enterprise Only)_ : Events resulting in new hinted handoff (HH) processors in InfluxDB Enterprise clusters.
|
||||
- **writeShardReq**: Number of initial write requests handled by the hinted handoff engine for a remote node.
|
||||
- **writeShardReqPoints**: Number of write requests for each point in the initial request to the hinted handoff engine for a remote node.
|
||||
- **influxdb_hh_database** _(Enterprise Only)_ : Aggregates all hinted handoff queues for a single database and node.
|
||||
- **bytesRead**: Size, in bytes, of points read from the hinted handoff queue and sent to its destination data node.
|
||||
- **bytesWritten**: Total number of bytes written to the hinted handoff queue.
|
||||
- **queueBytes**: Total number of bytes remaining in the hinted handoff queue.
|
||||
- **queueDepth**: Total number of segments in the hinted handoff queue. The HH queue is a sequence of 10MB “segment” files.
|
||||
- **writeBlocked**: Number of writes blocked because the number of concurrent HH requests exceeds the limit.
|
||||
- **writeDropped**: Number of writes dropped from the HH queue because the write appeared to be corrupted.
|
||||
- **writeNodeReq**: Total number of write requests that succeeded in writing a batch to the destination node.
|
||||
- **writeNodeReqFail**: Total number of write requests that failed in writing a batch of data from the hinted handoff queue to the destination node.
|
||||
- **writeNodeReqPoints**: Total number of points successfully written from the HH queue to the destination node fr
|
||||
- **writeShardReq**: Total number of every write batch request enqueued into the hinted handoff queue.
|
||||
- **writeShardReqPoints**: Total number of points enqueued into the hinted handoff queue.
|
||||
- **influxdb_hh_processor** _(Enterprise Only)_: Statistics stored for a single queue (shard).
|
||||
- **bytesRead**: Size, in bytes, of points read from the hinted handoff queue and sent to its destination data node.
|
||||
- **bytesWritten**: Total number of bytes written to the hinted handoff queue.
|
||||
- **queueBytes**: Total number of bytes remaining in the hinted handoff queue.
|
||||
- **queueDepth**: Total number of segments in the hinted handoff queue. The HH queue is a sequence of 10MB “segment” files.
|
||||
- **writeBlocked**: Number of writes blocked because the number of concurrent HH requests exceeds the limit.
|
||||
- **writeDropped**: Number of writes dropped from the HH queue because the write appeared to be corrupted.
|
||||
- **writeNodeReq**: Total number of write requests that succeeded in writing a batch to the destination node.
|
||||
- **writeNodeReqFail**: Total number of write requests that failed in writing a batch of data from the hinted handoff queue to the destination node.
|
||||
- **writeNodeReqPoints**: Total number of points successfully written from the HH queue to the destination node fr
|
||||
- **writeShardReq**: Total number of every write batch request enqueued into the hinted handoff queue.
|
||||
- **writeShardReqPoints**: Total number of points enqueued into the hinted handoff queue.
|
||||
- **influxdb_httpd**: Metrics related to the InfluxDB HTTP server.
|
||||
- **authFail**: Number of HTTP requests that were aborted due to authentication being required, but not supplied or incorrect.
|
||||
- **clientError**: Number of HTTP responses due to client errors, with a 4XX HTTP status code.
|
||||
- **fluxQueryReq**: Number of Flux query requests served.
|
||||
- **fluxQueryReqDurationNs**: Duration (wall-time), in nanoseconds, spent executing Flux query requests.
|
||||
- **pingReq**: Number of times InfluxDB HTTP server served the /ping HTTP endpoint.
|
||||
- **pointsWrittenDropped**: Number of points dropped by the storage engine.
|
||||
- **pointsWrittenFail**: Number of points accepted by the HTTP /write endpoint, but unable to be persisted.
|
||||
- **pointsWrittenOK**: Number of points successfully accepted and persisted by the HTTP /write endpoint.
|
||||
- **promReadReq**: Number of read requests to the Prometheus /read endpoint.
|
||||
- **promWriteReq**: Number of write requests to the Prometheus /write endpoint.
|
||||
- **queryReq**: Number of query requests.
|
||||
- **queryReqDurationNs**: Total query request duration, in nanosecond (ns).
|
||||
- **queryRespBytes**: Total number of bytes returned in query responses.
|
||||
- **recoveredPanics**: Total number of panics recovered by the HTTP handler.
|
||||
- **req**: Total number of HTTP requests served.
|
||||
- **reqActive**: Number of currently active requests.
|
||||
- **reqDurationNs**: Duration (wall time), in nanoseconds, spent inside HTTP requests.
|
||||
- **serverError**: Number of HTTP responses due to server errors.
|
||||
- **statusReq**: Number of status requests served using the HTTP /status endpoint.
|
||||
- **valuesWrittenOK**: Number of values (fields) successfully accepted and persisted by the HTTP /write endpoint.
|
||||
- **writeReq**: Number of write requests served using the HTTP /write endpoint.
|
||||
- **writeReqActive**: Number of currently active write requests.
|
||||
- **writeReqBytes**: Total number of bytes of line protocol data received by write requests, using the HTTP /write endpoint.
|
||||
- **writeReqDurationNs**: Duration, in nanoseconds, of write requests served using the /write HTTP endpoint.
|
||||
- **influxdb_memstats**: Statistics about the memory allocator in the specified database.
|
||||
- **Alloc**: Number of bytes allocated to heap objects.
|
||||
- **BuckHashSys**: Number of bytes of memory in profiling bucket hash tables.
|
||||
- **Frees**: Cumulative count of heap objects freed.
|
||||
- **GCCPUFraction**: fraction of InfluxDB's available CPU time used by the garbage collector (GC) since InfluxDB started.
|
||||
- **GCSys**: Number of bytes of memory in garbage collection metadata.
|
||||
- **HeapAlloc**: Number of bytes of allocated heap objects.
|
||||
- **HeapIdle**: Number of bytes in idle (unused) spans.
|
||||
- **HeapInuse**: Number of bytes in in-use spans.
|
||||
- **HeapObjects**: Number of allocated heap objects.
|
||||
- **HeapReleased**: Number of bytes of physical memory returned to the OS.
|
||||
- **HeapSys**: Number of bytes of heap memory obtained from the OS.
|
||||
- **LastGC**: Time the last garbage collection finished.
|
||||
- **Lookups**: Number of pointer lookups performed by the runtime.
|
||||
- **MCacheInuse**: Number of bytes of allocated mcache structures.
|
||||
- **MCacheSys**: Number of bytes of memory obtained from the OS for mcache structures.
|
||||
- **MSpanInuse**: Number of bytes of allocated mspan structures.
|
||||
- **MSpanSys**: Number of bytes of memory obtained from the OS for mspan structures.
|
||||
- **Mallocs**: Cumulative count of heap objects allocated.
|
||||
- **NextGC**: Target heap size of the next GC cycle.
|
||||
- **NumForcedGC**: Number of GC cycles that were forced by the application calling the GC function.
|
||||
- **NumGC**: Number of completed GC cycles.
|
||||
- **OtherSys**: Number of bytes of memory in miscellaneous off-heap runtime allocations.
|
||||
- **PauseTotalNs**: Cumulative nanoseconds in GC stop-the-world pauses since the program started.
|
||||
- **StackInuse**: Number of bytes in stack spans.
|
||||
- **StackSys**: Number of bytes of stack memory obtained from the OS.
|
||||
- **Sys**: Total bytes of memory obtained from the OS.
|
||||
- **TotalAlloc**: Cumulative bytes allocated for heap objects.
|
||||
- **influxdb_queryExecutor**: Metrics related to usage of the Query Executor of the InfluxDB engine.
|
||||
- **queriesActive**: Number of active queries currently being handled.
|
||||
- **queriesExecuted**: Number of queries executed (started).
|
||||
- **queriesFinished**: Number of queries that have finished executing.
|
||||
- **queryDurationNs**: Total duration, in nanoseconds, of executed queries.
|
||||
- **recoveredPanics**: Number of panics recovered by the Query Executor.
|
||||
- **influxdb_rpc** _(Enterprise Only)_ : Statistics related to the use of RPC calls within InfluxDB Enterprise clusters.
|
||||
- **idleStreams**: Number of idle multiplexed streams across all live TCP connections.
|
||||
- **liveConnections**: Current number of live TCP connections to other nodes.
|
||||
- **liveStreams**: Current number of live multiplexed streams across all live TCP connections.
|
||||
- **rpcCalls**: Total number of RPC calls made to remote nodes.
|
||||
- **rpcFailures**: Total number of RPC failures, which are RPCs that did not recover.
|
||||
- **rpcReadBytes**: Total number of RPC bytes read.
|
||||
- **rpcRetries**: Total number of RPC calls that retried at least once.
|
||||
- **rpcWriteBytes**: Total number of RPC bytes written.
|
||||
- **singleUse**: Total number of single-use connections opened using Dial.
|
||||
- **singleUseOpen**: Number of single-use connections currently open.
|
||||
- **totalConnections**: Total number of TCP connections that have been established.
|
||||
- **totalStreams**: Total number of streams established.
|
||||
- **influxdb_runtime**: Subset of memstat record statistics for the Go memory allocator.
|
||||
- **Alloc**: Currently allocated number of bytes of heap objects.
|
||||
- **Frees**: Cumulative number of freed (live) heap objects.
|
||||
- **HeapAlloc**: Size, in bytes, of all heap objects.
|
||||
- **HeapIdle**: Number of bytes of idle heap objects.
|
||||
- **HeapInUse**: Number of bytes in in-use spans.
|
||||
- **HeapObjects**: Number of allocated heap objects.
|
||||
- **HeapReleased**: Number of bytes of physical memory returned to the OS.
|
||||
- **HeapSys**: Number of bytes of heap memory obtained from the OS. Measures the amount of virtual address space reserved for the heap.
|
||||
- **Lookups**: Number of pointer lookups performed by the runtime. Primarily useful for debugging runtime internals.
|
||||
- **Mallocs**: Total number of heap objects allocated. The total number of live objects is Frees.
|
||||
- **NumGC**: Number of completed GC (garbage collection) cycles.
|
||||
- **NumGoroutine**: Total number of Go routines.
|
||||
- **PauseTotalNs**: Total duration, in nanoseconds, of total GC (garbage collection) pauses.
|
||||
- **Sys**: 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.
|
||||
- **TotalAlloc**: Total number of bytes allocated for heap objects. This statistic does not decrease when objects are freed.
|
||||
- **influxdb_shard**: Metrics related to InfluxDB shards.
|
||||
- **diskBytes**: Size, in bytes, of the shard, including the size of the data directory and the WAL directory.
|
||||
- **fieldsCreate**: Number of fields created.
|
||||
- **indexType**: Type of index inmem or tsi1.
|
||||
- **n_shards**: Total number of shards in the specified database.
|
||||
- **seriesCreate**: Number of series created.
|
||||
- **writeBytes**: Number of bytes written to the shard.
|
||||
- **writePointsDropped**: Number of requests to write points t dropped from a write.
|
||||
- **writePointsErr**: Number of requests to write points that failed to be written due to errors.
|
||||
- **writePointsOk**: Number of points written successfully.
|
||||
- **writeReq**: Total number of write requests.
|
||||
- **writeReqErr**: Total number of write requests that failed due to errors.
|
||||
- **writeReqOk**: Total number of successful write requests.
|
||||
- **influxdb_subscriber**: InfluxDB subscription metrics.
|
||||
- **createFailures**: Number of subscriptions that failed to be created.
|
||||
- **pointsWritten**: Total number of points that were successfully written to subscribers.
|
||||
- **writeFailures**: Total number of batches that failed to be written to subscribers.
|
||||
- **influxdb_tsm1_cache**: TSM cache metrics.
|
||||
- **cacheAgeMs**: Duration, in milliseconds, since the cache was last snapshotted at sample time.
|
||||
- **cachedBytes**: Total number of bytes that have been written into snapshots.
|
||||
- **diskBytes**: Size, in bytes, of on-disk snapshots.
|
||||
- **memBytes**: Size, in bytes, of in-memory cache.
|
||||
- **snapshotCount**: Current level (number) of active snapshots.
|
||||
- **WALCompactionTimeMs**: Duration, in milliseconds, that the commit lock is held while compacting snapshots.
|
||||
- **writeDropped**: Total number of writes dropped due to timeouts.
|
||||
- **writeErr**: Total number of writes that failed.
|
||||
- **writeOk**: Total number of successful writes.
|
||||
- **influxdb_tsm1_engine**: TSM storage engine metrics.
|
||||
- **cacheCompactionDuration** Duration (wall time), in nanoseconds, spent in cache compactions.
|
||||
- **cacheCompactionErr** Number of cache compactions that have failed due to errors.
|
||||
- **cacheCompactions** Total number of cache compactions that have ever run.
|
||||
- **cacheCompactionsActive** Number of cache compactions that are currently running.
|
||||
- **tsmFullCompactionDuration** Duration (wall time), in nanoseconds, spent in full compactions.
|
||||
- **tsmFullCompactionErr** Total number of TSM full compactions that have failed due to errors.
|
||||
- **tsmFullCompactionQueue** Current number of pending TMS Full compactions.
|
||||
- **tsmFullCompactions** Total number of TSM full compactions that have ever run.
|
||||
- **tsmFullCompactionsActive** Number of TSM full compactions currently running.
|
||||
- **tsmLevel1CompactionDuration** Duration (wall time), in nanoseconds, spent in TSM level 1 compactions.
|
||||
- **tsmLevel1CompactionErr** Total number of TSM level 1 compactions that have failed due to errors.
|
||||
- **tsmLevel1CompactionQueue** Current number of pending TSM level 1 compactions.
|
||||
- **tsmLevel1Compactions** Total number of TSM level 1 compactions that have ever run.
|
||||
- **tsmLevel1CompactionsActive** Number of TSM level 1 compactions that are currently running.
|
||||
- **tsmLevel2CompactionDuration** Duration (wall time), in nanoseconds, spent in TSM level 2 compactions.
|
||||
- **tsmLevel2CompactionErr** Number of TSM level 2 compactions that have failed due to errors.
|
||||
- **tsmLevel2CompactionQueue** Current number of pending TSM level 2 compactions.
|
||||
- **tsmLevel2Compactions** Total number of TSM level 2 compactions that have ever run.
|
||||
- **tsmLevel2CompactionsActive** Number of TSM level 2 compactions that are currently running.
|
||||
- **tsmLevel3CompactionDuration** Duration (wall time), in nanoseconds, spent in TSM level 3 compactions.
|
||||
- **tsmLevel3CompactionErr** Number of TSM level 3 compactions that have failed due to errors.
|
||||
- **tsmLevel3CompactionQueue** Current number of pending TSM level 3 compactions.
|
||||
- **tsmLevel3Compactions** Total number of TSM level 3 compactions that have ever run.
|
||||
- **tsmLevel3CompactionsActive** Number of TSM level 3 compactions that are currently running.
|
||||
- **tsmOptimizeCompactionDuration** Duration (wall time), in nanoseconds, spent during TSM optimize compactions.
|
||||
- **tsmOptimizeCompactionErr** Total number of TSM optimize compactions that have failed due to errors.
|
||||
- **tsmOptimizeCompactionQueue** Current number of pending TSM optimize compactions.
|
||||
- **tsmOptimizeCompactions** Total number of TSM optimize compactions that have ever run.
|
||||
- **tsmOptimizeCompactionsActive** Number of TSM optimize compactions that are currently running.
|
||||
- **influxdb_tsm1_filestore**: The TSM file store metrics.
|
||||
- **diskBytes**: Size, in bytes, of disk usage by the TSM file store.
|
||||
- **numFiles**: Total number of files in the TSM file store.
|
||||
- **influxdb_tsm1_wal**: The TSM Write Ahead Log (WAL) metrics.
|
||||
- **currentSegmentDiskBytes**: Current size, in bytes, of the segment disk.
|
||||
- **oldSegmentDiskBytes**: Size, in bytes, of the segment disk.
|
||||
- **writeErr**: Number of writes that failed due to errors.
|
||||
- **writeOK**: Number of writes that succeeded.
|
||||
- **influxdb_write**: Metrics related to InfluxDB writes.
|
||||
- **pointReq**: Total number of points requested to be written.
|
||||
- **pointReqHH** _(Enterprise only)_: Total number of points received for write by this node and then enqueued into hinted handoff for the destination node.
|
||||
- **pointReqLocal** _(Enterprise only)_: Total number of point requests that have been attempted to be written into a shard on the same (local) node.
|
||||
- **pointReqRemote** _(Enterprise only)_: Total number of points received for write by this node but needed to be forwarded into a shard on a remote node.
|
||||
- **pointsWrittenOK**: Number of points written to the HTTP /write endpoint and persisted successfully.
|
||||
- **req**: Total number of batches requested to be written.
|
||||
- **subWriteDrop**: Total number of batches that failed to be sent to the subscription dispatcher.
|
||||
- **subWriteOk**: Total number of batches successfully sent to the subscription dispatcher.
|
||||
- **valuesWrittenOK**: Number of values (fields) written to the HTTP /write endpoint and persisted successfully.
|
||||
- **writeDrop**: Total number of write requests for points that have been dropped due to timestamps not matching any existing retention policies.
|
||||
- **writeError**: Total number of batches of points that were not successfully written, due to a failure to write to a local or remote shard.
|
||||
- **writeOk**: Total number of batches of points written at the requested consistency level.
|
||||
- **writePartial** _(Enterprise only)_: Total number of batches written to at least one node, but did not meet the requested consistency level.
|
||||
- **writeTimeout**: Total number of write requests that failed to complete within the default write timeout duration.
|
||||
|
||||
### Example Output:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue