From 396e2f71d545ccc8c7bf97ead8ac60eaf7ffaecb Mon Sep 17 00:00:00 2001 From: Dmitrii Anoshin Date: Wed, 30 Nov 2022 21:26:47 -0800 Subject: [PATCH] [mdatagen] Fix documentation generated for optional metrics (#16563) Duplicated documentation for default metrics was generated in the Optional metrics section. This change fixes that --- .chloggen/mdatagen-improve-documentation.yaml | 2 +- cmd/mdatagen/templates/documentation.md.tmpl | 9 +- .../documentation.md | 204 ---- receiver/aerospikereceiver/documentation.md | 189 ---- receiver/apachereceiver/documentation.md | 127 --- receiver/bigipreceiver/documentation.md | 328 ------ receiver/chronyreceiver/documentation.md | 30 +- receiver/couchdbreceiver/documentation.md | 98 -- receiver/dockerstatsreceiver/documentation.md | 446 +++++++- .../elasticsearchreceiver/documentation.md | 657 +----------- receiver/expvarreceiver/documentation.md | 230 +---- .../flinkmetricsreceiver/documentation.md | 279 ----- .../scraper/cpuscraper/documentation.md | 10 +- .../scraper/diskscraper/documentation.md | 112 -- .../filesystemscraper/documentation.md | 29 +- .../scraper/loadscraper/documentation.md | 34 - .../scraper/memoryscraper/documentation.md | 10 +- .../scraper/networkscraper/documentation.md | 71 +- .../scraper/pagingscraper/documentation.md | 39 +- .../scraper/processesscraper/documentation.md | 32 - .../scraper/processscraper/documentation.md | 64 +- receiver/httpcheckreceiver/documentation.md | 56 - receiver/iisreceiver/documentation.md | 124 --- .../kafkametricsreceiver/documentation.md | 168 --- .../kubeletstatsreceiver/documentation.md | 374 ------- receiver/memcachedreceiver/documentation.md | 129 --- .../mongodbatlasreceiver/documentation.md | 957 ------------------ receiver/mongodbreceiver/documentation.md | 242 +---- receiver/mysqlreceiver/documentation.md | 281 ++--- receiver/nginxreceiver/documentation.md | 48 - receiver/nsxtreceiver/documentation.md | 91 -- receiver/oracledbreceiver/documentation.md | 229 ----- receiver/postgresqlreceiver/documentation.md | 271 ----- receiver/rabbitmqreceiver/documentation.md | 64 -- receiver/redisreceiver/documentation.md | 240 +---- receiver/riakreceiver/documentation.md | 82 -- receiver/saphanareceiver/documentation.md | 632 ------------ receiver/sqlserverreceiver/documentation.md | 176 ---- receiver/vcenterreceiver/documentation.md | 371 ------- receiver/zookeeperreceiver/documentation.md | 142 --- 40 files changed, 676 insertions(+), 7001 deletions(-) diff --git a/.chloggen/mdatagen-improve-documentation.yaml b/.chloggen/mdatagen-improve-documentation.yaml index f9abf619446b..61eeb00b5fcd 100755 --- a/.chloggen/mdatagen-improve-documentation.yaml +++ b/.chloggen/mdatagen-improve-documentation.yaml @@ -8,4 +8,4 @@ component: cmd/mdatagen note: Improve generated documentation # One or more tracking issues related to the change -issues: [16556] +issues: [16556, 16563] diff --git a/cmd/mdatagen/templates/documentation.md.tmpl b/cmd/mdatagen/templates/documentation.md.tmpl index bc255a11ddd7..91f77d7087ce 100644 --- a/cmd/mdatagen/templates/documentation.md.tmpl +++ b/cmd/mdatagen/templates/documentation.md.tmpl @@ -56,6 +56,11 @@ metrics: {{- end }} {{- end }} +{{- $optionalMetricSeen := false }} +{{- range $metricName, $metric := .Metrics }} +{{- if not $metric.IsEnabled }} +{{- if not $optionalMetricSeen }} + ## Optional Metrics The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: @@ -66,8 +71,8 @@ metrics: enabled: true ``` -{{- range $metricName, $metric := .Metrics }} -{{- if $metric.IsEnabled }} +{{- end }} +{{- $optionalMetricSeen = true }} {{ template "metric-documenation" $metricName }} diff --git a/receiver/activedirectorydsreceiver/documentation.md b/receiver/activedirectorydsreceiver/documentation.md index b4e6de6476ad..2425d2d815cd 100644 --- a/receiver/activedirectorydsreceiver/documentation.md +++ b/receiver/activedirectorydsreceiver/documentation.md @@ -205,207 +205,3 @@ The number of threads in use by the directory service. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | {threads} | Sum | Int | Cumulative | false | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### active_directory.ds.bind.rate - -The number of binds per second serviced by this domain controller. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {binds}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of bind to the domain server. | Str: ``server``, ``client`` | - -### active_directory.ds.ldap.bind.last_successful.time - -The amount of time taken for the last successful LDAP bind. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### active_directory.ds.ldap.bind.rate - -The number of successful LDAP binds per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {binds}/s | Sum | Double | Cumulative | false | - -### active_directory.ds.ldap.client.session.count - -The number of connected LDAP client sessions. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {sessions} | Sum | Int | Cumulative | false | - -### active_directory.ds.ldap.search.rate - -The number of LDAP searches per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {searches}/s | Sum | Double | Cumulative | false | - -### active_directory.ds.name_cache.hit_rate - -The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### active_directory.ds.notification.queued - -The number of pending update notifications that have been queued to push to clients. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {notifications} | Sum | Int | Cumulative | false | - -### active_directory.ds.operation.rate - -The number of operations performed per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of operation. | Str: ``read``, ``write``, ``search`` | - -### active_directory.ds.replication.network.io - -The amount of network data transmitted by the Directory Replication Agent. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data flow. | Str: ``sent``, ``received`` | -| type | The type of network data sent. | Str: ``compressed``, ``uncompressed`` | - -### active_directory.ds.replication.object.rate - -The number of objects transmitted by the Directory Replication Agent per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data flow. | Str: ``sent``, ``received`` | - -### active_directory.ds.replication.operation.pending - -The number of pending replication operations for the Directory Replication Agent. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | false | - -### active_directory.ds.replication.property.rate - -The number of properties transmitted by the Directory Replication Agent per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {properties}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data flow. | Str: ``sent``, ``received`` | - -### active_directory.ds.replication.sync.object.pending - -The number of objects remaining until the full sync completes for the Directory Replication Agent. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects} | Sum | Int | Cumulative | false | - -### active_directory.ds.replication.sync.request.count - -The number of sync requests made by the Directory Replication Agent. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| result | The result status of the sync request. | Str: ``success``, ``schema_mismatch``, ``other`` | - -### active_directory.ds.replication.value.rate - -The number of values transmitted by the Directory Replication Agent per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {values}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data flow. | Str: ``sent``, ``received`` | -| type | The type of value sent. | Str: ``distingushed_names``, ``other`` | - -### active_directory.ds.security_descriptor_propagations_event.queued - -The number of security descriptor propagation events that are queued for processing. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {events} | Sum | Int | Cumulative | false | - -### active_directory.ds.suboperation.rate - -The rate of sub-operations performed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {suboperations}/s | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of suboperation. | Str: ``security_descriptor_propagations_event``, ``search`` | - -### active_directory.ds.thread.count - -The number of threads in use by the directory service. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | diff --git a/receiver/aerospikereceiver/documentation.md b/receiver/aerospikereceiver/documentation.md index fc3803e05e49..0481c39cfb98 100644 --- a/receiver/aerospikereceiver/documentation.md +++ b/receiver/aerospikereceiver/documentation.md @@ -191,195 +191,6 @@ Number of queries which ran more than query untracked_time (default 1 sec), Aero | ---- | ----------- | ---------- | ----------------------- | --------- | | | Sum | Int | Cumulative | true | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### aerospike.namespace.disk.available - -Minimum percentage of contiguous disk space free to the namespace across all devices - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Int | - -### aerospike.namespace.geojson.region_query_cells - -Number of cell coverings for query region queried - -Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {cells} | Sum | Int | Cumulative | true | - -### aerospike.namespace.geojson.region_query_false_positive - -Number of points outside the region. - -Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_regio_query_falspos. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {points} | Sum | Int | Cumulative | true | - -### aerospike.namespace.geojson.region_query_points - -Number of points within the region. - -Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {points} | Sum | Int | Cumulative | true | - -### aerospike.namespace.geojson.region_query_requests - -Number of geojson queries on the system since the uptime of the node. - -Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {queries} | Sum | Int | Cumulative | true | - -### aerospike.namespace.memory.free - -Percentage of the namespace's memory which is still free - -Aerospike metric memory_free_pct - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Int | - -### aerospike.namespace.memory.usage - -Memory currently used by each component of the namespace - -Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| component | Individual component of a namespace | Str: ``data``, ``index``, ``set_index``, ``secondary_index`` | - -### aerospike.namespace.query.count - -Number of query operations performed on the namespace - -Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {queries} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of query operation performed on a namespace | Str: ``aggregation``, ``basic``, ``short``, ``long_basic``, ``short_basic``, ``ops_background``, ``udf_background`` | -| index | Type of index the operation was performed on | Str: ``primary``, ``secondary`` | -| result | Result of a query operation performed on a namespace | Str: ``abort``, ``complete``, ``error``, ``timeout`` | - -### aerospike.namespace.scan.count - -Number of scan operations performed on the namespace - -Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {scans} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of scan operation performed on a namespace | Str: ``aggregation``, ``basic``, ``ops_background``, ``udf_background`` | -| result | Result of a scan operation performed on a namespace | Str: ``abort``, ``complete``, ``error`` | - -### aerospike.namespace.transaction.count - -Number of transactions performed on the namespace - -Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {transactions} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of transaction performed on a namespace | Str: ``delete``, ``read``, ``udf``, ``write`` | -| result | Result of a transaction performed on a namespace | Str: ``error``, ``filtered_out``, ``not_found``, ``success``, ``timeout`` | - -### aerospike.node.connection.count - -Number of connections opened and closed to the node - -Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | -| operation | Operation performed with a connection (open or close) | Str: ``close``, ``open`` | - -### aerospike.node.connection.open - -Current number of open connections to the node - -Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | - -### aerospike.node.memory.free - -Percentage of the node's memory which is still free - -Aerospike Metric system_free_mem_pct - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Int | - -### aerospike.node.query.tracked - -Number of queries tracked by the system. - -Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/apachereceiver/documentation.md b/receiver/apachereceiver/documentation.md index ec31d6b0a772..9fb420cbe24d 100644 --- a/receiver/apachereceiver/documentation.md +++ b/receiver/apachereceiver/documentation.md @@ -129,133 +129,6 @@ The number of workers currently attached to the HTTP server. | ---- | ----------- | ------ | | state | The state of workers. | Str: ``busy``, ``idle`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### apache.cpu.load - -Current load of the CPU. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### apache.cpu.time - -Jiffs used by processes of given category. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {jiff} | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| level | Level of processes. | Str: ``self``, ``children`` | -| mode | Mode of processes. | Str: ``system``, ``user`` | - -### apache.current_connections - -The number of active connections currently attached to the HTTP server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### apache.load.1 - -The average server load during the last minute. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### apache.load.15 - -The average server load during the last 15 minutes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### apache.load.5 - -The average server load during the last 5 minutes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### apache.request.time - -Total time spent on handling requests. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -### apache.requests - -The number of requests serviced by the HTTP server per second. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### apache.scoreboard - -The number of workers in each state. - -The apache scoreboard is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {workers} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of a connection. | Str: ``open``, ``waiting``, ``starting``, ``reading``, ``sending``, ``keepalive``, ``dnslookup``, ``closing``, ``logging``, ``finishing``, ``idle_cleanup``, ``unknown`` | - -### apache.traffic - -Total HTTP server traffic. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### apache.uptime - -The amount of time that the server has been running in seconds. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | - -### apache.workers - -The number of workers currently attached to the HTTP server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {workers} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of workers. | Str: ``busy``, ``idle`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/bigipreceiver/documentation.md b/receiver/bigipreceiver/documentation.md index be31a145816f..76c08cb20be0 100644 --- a/receiver/bigipreceiver/documentation.md +++ b/receiver/bigipreceiver/documentation.md @@ -330,334 +330,6 @@ Number of requests to the virtual server. | ---- | ----------- | ---------- | ----------------------- | --------- | | {requests} | Sum | Int | Cumulative | true | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### bigip.node.availability - -Availability of the node. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | - -### bigip.node.connection.count - -Current number of connections to the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### bigip.node.data.transmitted - -Amount of data transmitted to and from the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.node.enabled - -Enabled state of of the node. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The enabled status. | Str: ``disabled``, ``enabled`` | - -### bigip.node.packet.count - -Number of packets transmitted to and from the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.node.request.count - -Number of requests to the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### bigip.node.session.count - -Current number of sessions for the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {sessions} | Sum | Int | Cumulative | false | - -### bigip.pool.availability - -Availability of the pool. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | - -### bigip.pool.connection.count - -Current number of connections to the pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### bigip.pool.data.transmitted - -Amount of data transmitted to and from the pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.pool.enabled - -Enabled state of of the pool. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The enabled status. | Str: ``disabled``, ``enabled`` | - -### bigip.pool.member.count - -Total number of pool members. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {members} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The active status. | Str: ``active``, ``inactive`` | - -### bigip.pool.packet.count - -Number of packets transmitted to and from the pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.pool.request.count - -Number of requests to the pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### bigip.pool_member.availability - -Availability of the pool member. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | - -### bigip.pool_member.connection.count - -Current number of connections to the pool member. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### bigip.pool_member.data.transmitted - -Amount of data transmitted to and from the pool member. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.pool_member.enabled - -Enabled state of of the pool member. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The enabled status. | Str: ``disabled``, ``enabled`` | - -### bigip.pool_member.packet.count - -Number of packets transmitted to and from the pool member. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.pool_member.request.count - -Number of requests to the pool member. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### bigip.pool_member.session.count - -Current number of sessions for the pool member. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {sessions} | Sum | Int | Cumulative | false | - -### bigip.virtual_server.availability - -Availability of the virtual server. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | - -### bigip.virtual_server.connection.count - -Current number of connections to the virtual server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### bigip.virtual_server.data.transmitted - -Amount of data transmitted to and from the virtual server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.virtual_server.enabled - -Enabled state of of the virtual server. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The enabled status. | Str: ``disabled``, ``enabled`` | - -### bigip.virtual_server.packet.count - -Number of packets transmitted to and from the virtual server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of data. | Str: ``sent``, ``received`` | - -### bigip.virtual_server.request.count - -Number of requests to the virtual server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/chronyreceiver/documentation.md b/receiver/chronyreceiver/documentation.md index 9bf1f81d14b8..7e039f96eaaf 100644 --- a/receiver/chronyreceiver/documentation.md +++ b/receiver/chronyreceiver/documentation.md @@ -58,17 +58,35 @@ metrics: enabled: true ``` -### ntp.skew +### ntp.frequency.offset -This is the estimated error bound on the frequency. +The frequency is the rate by which the system s clock would be wrong if chronyd was not correcting it. + +It is expressed in ppm (parts per million). For example, a value of 1 ppm would mean that when the system’s clock thinks it has advanced 1 second, it has actually advanced by 1.000001 seconds relative to true time. | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | | ppm | Gauge | Double | -### ntp.time.correction +#### Attributes -The number of seconds difference between the system's clock and the reference clock +| Name | Description | Values | +| ---- | ----------- | ------ | +| leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | + +### ntp.stratum + +The number of hops away from the reference system keeping the reference time + +To read further, refer to https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/system_administrators_guide/ch-configuring_ntp_using_the_chrony_suite#sect-Checking_chrony_tracking + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {count} | Gauge | Int | + +### ntp.time.rms_offset + +the long term average of the offset value | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | @@ -80,9 +98,9 @@ The number of seconds difference between the system's clock and the reference cl | ---- | ----------- | ------ | | leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | -### ntp.time.last_offset +### ntp.time.root_delay -The estimated local offset on the last clock update +This is the total of the network path delays to the stratum-1 system from which the system is ultimately synchronised. | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | diff --git a/receiver/couchdbreceiver/documentation.md b/receiver/couchdbreceiver/documentation.md index d33fc897e648..a31feaddf959 100644 --- a/receiver/couchdbreceiver/documentation.md +++ b/receiver/couchdbreceiver/documentation.md @@ -100,104 +100,6 @@ The number of views read. | ---- | ----------- | ------ | | view | The view type. | Str: ``temporary_view_reads``, ``view_reads`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### couchdb.average_request_time - -The average duration of a served request. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Double | - -### couchdb.database.open - -The number of open databases. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {databases} | Sum | Int | Cumulative | false | - -### couchdb.database.operations - -The number of database operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The operation type. | Str: ``writes``, ``reads`` | - -### couchdb.file_descriptor.open - -The number of open file descriptors. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {files} | Sum | Int | Cumulative | false | - -### couchdb.httpd.bulk_requests - -The number of bulk requests. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### couchdb.httpd.requests - -The number of HTTP requests by method. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| http.method | An HTTP request method. | Str: ``COPY``, ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``POST``, ``PUT`` | - -### couchdb.httpd.responses - -The number of each HTTP status code. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {responses} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| http.status_code | An HTTP status code. | Any Str | - -### couchdb.httpd.views - -The number of views read. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {views} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| view | The view type. | Str: ``temporary_view_reads``, ``view_reads`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/dockerstatsreceiver/documentation.md b/receiver/dockerstatsreceiver/documentation.md index f5d3641e4594..e6a8e1dec462 100644 --- a/receiver/dockerstatsreceiver/documentation.md +++ b/receiver/dockerstatsreceiver/documentation.md @@ -160,15 +160,15 @@ metrics: enabled: true ``` -### container.blockio.io_service_bytes_recursive +### container.blockio.io_merged_recursive -Number of bytes transferred to/from the disk by the group and descendant groups. +Number of bios/requests merged into requests belonging to this cgroup and its descendant cgroups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| {operations} | Sum | Int | Cumulative | true | #### Attributes @@ -178,77 +178,453 @@ Number of bytes transferred to/from the disk by the group and descendant groups. | device_minor | Device minor number for block IO operations. | Any Str | | operation | Type of BlockIO operation. | Any Str | -### container.cpu.percent +### container.blockio.io_queued_recursive -Percent of CPU used by the container. +Number of requests queued up for this cgroup and its descendant cgroups. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). -### container.cpu.usage.kernelmode +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | -Time spent by tasks of the cgroup in kernel mode (Linux). Time spent by all container processes in kernel mode (Windows). +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.blockio.io_service_time_recursive + +Total amount of time in nanoseconds between request dispatch and request completion for the IOs done by this cgroup and descendant cgroups. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | ns | Sum | Int | Cumulative | true | -### container.cpu.usage.total +#### Attributes -Total CPU time consumed. +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.blockio.io_serviced_recursive + +Number of IOs (bio) issued to the disk by the group and descendant groups. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.blockio.io_time_recursive + +Disk time allocated to cgroup (and descendant cgroups) per device in milliseconds. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.blockio.io_wait_time_recursive + +Total amount of time the IOs for this cgroup (and descendant cgroups) spent waiting in the scheduler queues for service. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | ns | Sum | Int | Cumulative | true | -### container.cpu.usage.usermode +#### Attributes -Time spent by tasks of the cgroup in user mode (Linux). Time spent by all container processes in user mode (Windows). +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.blockio.sectors_recursive + +Number of sectors transferred to/from disk by the group and descendant groups. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sectors} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.cpu.throttling_data.periods + +Number of periods with throttling active. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {periods} | Sum | Int | Cumulative | true | + +### container.cpu.throttling_data.throttled_periods + +Number of periods when the container hits its throttling limit. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {periods} | Sum | Int | Cumulative | true | + +### container.cpu.throttling_data.throttled_time + +Aggregate time the container was throttled. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | ns | Sum | Int | Cumulative | true | -### container.memory.percent +### container.cpu.usage.percpu -Percentage of memory used. +Per-core CPU usage by the container. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | -### container.memory.total_cache +#### Attributes -Total amount of memory used by the processes of this cgroup (and descendants) that can be associated with a block on a block device. Also accounts for memory used by tmpfs. +| Name | Description | Values | +| ---- | ----------- | ------ | +| core | The CPU core number when utilising per-CPU metrics. | Any Str | + +### container.cpu.usage.system + +System CPU usage, as reported by docker. + +Note this is the usage for the system, not the container. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.memory.active_anon + +The amount of anonymous memory that has been identified as active by the kernel. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | By | Sum | Int | Cumulative | false | -### container.memory.usage.limit +### container.memory.active_file -Memory limit of the container. +Cache memory that has been identified as active by the kernel. + +[More docs](https://docs.docker.com/config/containers/runmetrics/) | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | By | Sum | Int | Cumulative | false | -### container.memory.usage.total +### container.memory.cache -Memory usage of the container. This excludes the total cache. +The amount of memory used by the processes of this control group that can be associated precisely with a block on a block device. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | By | Sum | Int | Cumulative | false | -### container.network.io.usage.rx_bytes +### container.memory.dirty -Bytes received by the container. +Bytes that are waiting to get written back to the disk, from this cgroup. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| By | Sum | Int | Cumulative | false | + +### container.memory.hierarchical_memory_limit + +The maximum amount of physical memory that can be used by the processes of this control group. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.hierarchical_memsw_limit + +The maximum amount of RAM + swap that can be used by the processes of this control group. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.inactive_anon + +The amount of anonymous memory that has been identified as inactive by the kernel. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.inactive_file + +Cache memory that has been identified as inactive by the kernel. + +[More docs](https://docs.docker.com/config/containers/runmetrics/) + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.mapped_file + +Indicates the amount of memory mapped by the processes in the control group. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.pgfault + +Indicate the number of times that a process of the cgroup triggered a page fault. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +### container.memory.pgmajfault + +Indicate the number of times that a process of the cgroup triggered a major fault. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +### container.memory.pgpgin + +Number of pages read from disk by the cgroup. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### container.memory.pgpgout + +Number of pages written to disk by the cgroup. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### container.memory.rss + +The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.rss_huge + +Number of bytes of anonymous transparent hugepages in this cgroup. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.swap + +The amount of swap currently used by the processes in this cgroup. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_active_anon + +The amount of anonymous memory that has been identified as active by the kernel. Includes descendant cgroups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_active_file + +Cache memory that has been identified as active by the kernel. Includes descendant cgroups. + +[More docs](https://docs.docker.com/config/containers/runmetrics/). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_dirty + +Bytes that are waiting to get written back to the disk, from this cgroup and descendants. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_inactive_anon + +The amount of anonymous memory that has been identified as inactive by the kernel. Includes descendant cgroups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_inactive_file + +Cache memory that has been identified as inactive by the kernel. Includes descendant cgroups. + +[More docs](https://docs.docker.com/config/containers/runmetrics/). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_mapped_file + +Indicates the amount of memory mapped by the processes in the control group and descendant groups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_pgfault + +Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a page fault. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +### container.memory.total_pgmajfault + +Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a major fault. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +### container.memory.total_pgpgin + +Number of pages read from disk by the cgroup and descendant groups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### container.memory.total_pgpgout + +Number of pages written to disk by the cgroup and descendant groups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### container.memory.total_rss + +The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps. Includes descendant cgroups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_rss_huge + +Number of bytes of anonymous transparent hugepages in this cgroup and descendant cgroups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_swap + +The amount of swap currently used by the processes in this cgroup and descendant groups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_unevictable + +The amount of memory that cannot be reclaimed. Includes descendant cgroups. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.total_writeback + +Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup and descendants. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.unevictable + +The amount of memory that cannot be reclaimed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.usage.max + +Maximum memory usage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.writeback + +Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.network.io.usage.rx_errors + +Received errors. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {errors} | Sum | Int | Cumulative | true | #### Attributes @@ -256,9 +632,9 @@ Bytes received by the container. | ---- | ----------- | ------ | | interface | Network interface. | Any Str | -### container.network.io.usage.rx_dropped +### container.network.io.usage.rx_packets -Incoming packets dropped. +Packets received. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -270,13 +646,13 @@ Incoming packets dropped. | ---- | ----------- | ------ | | interface | Network interface. | Any Str | -### container.network.io.usage.tx_bytes +### container.network.io.usage.tx_errors -Bytes sent. +Sent errors. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| {errors} | Sum | Int | Cumulative | true | #### Attributes @@ -284,9 +660,9 @@ Bytes sent. | ---- | ----------- | ------ | | interface | Network interface. | Any Str | -### container.network.io.usage.tx_dropped +### container.network.io.usage.tx_packets -Outgoing packets dropped. +Packets sent. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | diff --git a/receiver/elasticsearchreceiver/documentation.md b/receiver/elasticsearchreceiver/documentation.md index 225e483bb2a0..bbcfcbb8428f 100644 --- a/receiver/elasticsearchreceiver/documentation.md +++ b/receiver/elasticsearchreceiver/documentation.md @@ -775,135 +775,39 @@ metrics: enabled: true ``` -### elasticsearch.breaker.memory.estimated - -Estimated memory used for the operation. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of circuit breaker. | Any Str | - -### elasticsearch.breaker.memory.limit - -Memory limit for the circuit breaker. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of circuit breaker. | Any Str | - -### elasticsearch.breaker.tripped - -Total number of times the circuit breaker has been triggered and prevented an out of memory error. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of circuit breaker. | Any Str | - -### elasticsearch.cluster.data_nodes - -The number of data nodes in the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {nodes} | Sum | Int | Cumulative | false | - -### elasticsearch.cluster.health - -The health status of the cluster. - -Health status is based on the state of its primary and replica shards. Green indicates all shards are assigned. Yellow indicates that one or more replica shards are unassigned. Red indicates that one or more primary shards are unassigned, making some data unavailable. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {status} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The health status of the cluster. | Str: ``green``, ``yellow``, ``red`` | - -### elasticsearch.cluster.in_flight_fetch - -The number of unfinished fetches. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {fetches} | Sum | Int | Cumulative | false | - -### elasticsearch.cluster.nodes - -The total number of nodes in the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {nodes} | Sum | Int | Cumulative | false | - -### elasticsearch.cluster.pending_tasks - -The number of cluster-level changes that have not yet been executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {tasks} | Sum | Int | Cumulative | false | - -### elasticsearch.cluster.published_states.differences +### elasticsearch.index.cache.evictions -Number of differences between published cluster states. +The number of evictions from the cache for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | +| {evictions} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | State of the published differences | Str: ``incompatible``, ``compatible`` | - -### elasticsearch.cluster.published_states.full - -Number of published cluster states. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.cluster.shards +### elasticsearch.index.cache.memory.usage -The number of shards in the cluster. +The size in bytes of the cache for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {shards} | Sum | Int | Cumulative | false | +| By | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | The state of the shard. | Str: ``active``, ``active_primary``, ``relocating``, ``initializing``, ``unassigned``, ``unassigned_delayed`` | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.cluster.state_queue +### elasticsearch.index.cache.size -Number of cluster states in queue. +The number of elements of the query cache for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -913,70 +817,68 @@ Number of cluster states in queue. | Name | Description | Values | | ---- | ----------- | ------ | -| state | State of the published differences | Str: ``pending``, ``committed`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.cluster.state_update.count +### elasticsearch.index.documents -The number of cluster state update attempts that changed the cluster state since the node started. +The number of documents for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| {documents} | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | State of cluster state update | Any Str | +| state | The state of the document. | Str: ``active``, ``deleted`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.cluster.state_update.time +### elasticsearch.index.operations.merge.docs_count -The cumulative amount of time updating the cluster state since the node started. +The total number of documents in merge operations for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | +| {documents} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | State of cluster state update | Any Str | -| type | Type of cluster state update | Str: ``computation``, ``context_construction``, ``commit``, ``completion``, ``master_apply``, ``notification`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.index.operations.completed +### elasticsearch.index.operations.merge.size -The number of operations completed for an index. +The total size of merged segments for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | +| By | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | | aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.index.operations.time +### elasticsearch.index.segments.count -Time spent on operations for an index. +Number of segments of an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | +| {segments} | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | | aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.index.shards.size +### elasticsearch.index.segments.memory -The size of the shards assigned to this index. +Size of memory for segment object of an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -987,34 +889,11 @@ The size of the shards assigned to this index. | Name | Description | Values | | ---- | ----------- | ------ | | aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | +| object | Type of object in segment | Str: ``term``, ``doc_value``, ``index_writer``, ``fixed_bit_set`` | -### elasticsearch.indexing_pressure.memory.limit - -Configured memory limit, in bytes, for the indexing requests. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### elasticsearch.indexing_pressure.memory.total.primary_rejections - -Cumulative number of indexing requests rejected in the primary stage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### elasticsearch.indexing_pressure.memory.total.replica_rejections - -Number of indexing requests rejected in the replica stage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### elasticsearch.memory.indexing_pressure +### elasticsearch.index.segments.size -Memory consumed, in bytes, by indexing requests in the specified stage. +Size of segments of an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -1024,510 +903,86 @@ Memory consumed, in bytes, by indexing requests in the specified stage. | Name | Description | Values | | ---- | ----------- | ------ | -| stage | Stage of the indexing pressure | Str: ``coordinating``, ``primary``, ``replica`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.node.cache.count +### elasticsearch.index.translog.operations -Total count of query cache misses across all shards assigned to selected nodes. +Number of transaction log operations for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {count} | Sum | Int | Cumulative | false | +| {operations} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| type | Type of query cache count | Str: ``hit``, ``miss`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.node.cache.evictions +### elasticsearch.index.translog.size -The number of evictions from the cache on a node. +Size of the transaction log for an index. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {evictions} | Sum | Int | Cumulative | true | +| By | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | -### elasticsearch.node.cache.memory.usage +### elasticsearch.node.operations.get.completed -The size in bytes of the cache on a node. +The number of hits and misses resulting from GET operations. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| {operations} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | - -### elasticsearch.node.cluster.connections - -The number of open tcp connections for internal cluster communication. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | +| result | Result of get operation | Str: ``hit``, ``miss`` | -### elasticsearch.node.cluster.io +### elasticsearch.node.operations.get.time -The number of bytes sent and received on the network for internal cluster communication. +The time spent on hits and misses resulting from GET operations. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| ms | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| direction | The direction of network data. | Str: ``received``, ``sent`` | - -### elasticsearch.node.disk.io.read - -The total number of kilobytes read across all file stores for this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| KiBy | Sum | Int | Cumulative | false | - -### elasticsearch.node.disk.io.write - -The total number of kilobytes written across all file stores for this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| KiBy | Sum | Int | Cumulative | false | +| result | Result of get operation | Str: ``hit``, ``miss`` | -### elasticsearch.node.documents +### elasticsearch.node.segments.memory -The number of documents on the node. +Size of memory for segment object of a node. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | false | +| By | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | The state of the document. | Str: ``active``, ``deleted`` | - -### elasticsearch.node.fs.disk.available - -The amount of disk space available to the JVM across all file stores for this node. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise. +| object | Type of object in segment | Str: ``term``, ``doc_value``, ``index_writer``, ``fixed_bit_set`` | -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.fs.disk.free - -The amount of unallocated disk space across all file stores for this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.fs.disk.total - -The amount of disk space across all file stores for this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.http.connections - -The number of HTTP connections to the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### elasticsearch.node.ingest.documents +### jvm.memory.heap.utilization -Total number of documents ingested during the lifetime of this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | true | - -### elasticsearch.node.ingest.documents.current - -Total number of documents currently being ingested. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | false | - -### elasticsearch.node.ingest.operations.failed - -Total number of failed ingest operations during the lifetime of this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operation} | Sum | Int | Cumulative | true | - -### elasticsearch.node.open_files - -The number of open file descriptors held by the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {files} | Sum | Int | Cumulative | false | - -### elasticsearch.node.operations.completed - -The number of operations completed by a node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | - -### elasticsearch.node.operations.time - -Time spent on operations by a node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | - -### elasticsearch.node.pipeline.ingest.documents.current - -Total number of documents currently being ingested by a pipeline. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | Name of the ingest pipeline. | Any Str | - -### elasticsearch.node.pipeline.ingest.documents.preprocessed - -Number of documents preprocessed by the ingest pipeline. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | Name of the ingest pipeline. | Any Str | - -### elasticsearch.node.pipeline.ingest.operations.failed - -Total number of failed operations for the ingest pipeline. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operation} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | Name of the ingest pipeline. | Any Str | - -### elasticsearch.node.script.cache_evictions - -Total number of times the script cache has evicted old data. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### elasticsearch.node.script.compilation_limit_triggered - -Total number of times the script compilation circuit breaker has limited inline script compilations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### elasticsearch.node.script.compilations - -Total number of inline script compilations performed by the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {compilations} | Sum | Int | Cumulative | false | - -### elasticsearch.node.shards.data_set.size - -Total data set size of all shards assigned to the node. This includes the size of shards not stored fully on the node, such as the cache for partially mounted indices. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.shards.reserved.size - -A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of -1 indicates that this is not available. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.shards.size - -The size of the shards assigned to this node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.thread_pool.tasks.finished - -The number of tasks finished by the thread pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {tasks} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| thread_pool_name | The name of the thread pool. | Any Str | -| state | The state of the task. | Str: ``rejected``, ``completed`` | - -### elasticsearch.node.thread_pool.tasks.queued - -The number of queued tasks in the thread pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {tasks} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| thread_pool_name | The name of the thread pool. | Any Str | - -### elasticsearch.node.thread_pool.threads - -The number of threads in the thread pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| thread_pool_name | The name of the thread pool. | Any Str | -| state | The state of the thread. | Str: ``active``, ``idle`` | - -### elasticsearch.node.translog.operations - -Number of transaction log operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -### elasticsearch.node.translog.size - -Size of the transaction log. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.node.translog.uncommitted.size - -Size of uncommitted transaction log operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### elasticsearch.os.cpu.load_avg.15m - -Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### elasticsearch.os.cpu.load_avg.1m - -One-minute load average on the system (field is not present if one-minute load average is not available). - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### elasticsearch.os.cpu.load_avg.5m - -Five-minute load average on the system (field is not present if five-minute load average is not available). +Fraction of heap memory usage | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | | 1 | Gauge | Double | -### elasticsearch.os.cpu.usage - -Recent CPU usage for the whole system, or -1 if not supported. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Int | - -### elasticsearch.os.memory - -Amount of physical memory. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | State of the memory | Str: ``free``, ``used`` | - -### jvm.classes.loaded - -The number of loaded classes - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### jvm.gc.collections.count - -The total number of garbage collections that have occurred - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of the garbage collector. | Any Str | - -### jvm.gc.collections.elapsed - -The approximate accumulated collection elapsed time - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of the garbage collector. | Any Str | - -### jvm.memory.heap.committed - -The amount of memory that is guaranteed to be available for the heap - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### jvm.memory.heap.max - -The maximum amount of memory can be used for the heap - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### jvm.memory.heap.used - -The current heap memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### jvm.memory.nonheap.committed - -The amount of memory that is guaranteed to be available for non-heap purposes - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### jvm.memory.nonheap.used - -The current non-heap memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### jvm.memory.pool.max - -The maximum amount of memory can be used for the memory pool - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of the JVM memory pool. | Any Str | - -### jvm.memory.pool.used - -The current memory pool memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The name of the JVM memory pool. | Any Str | - -### jvm.threads.count - -The current number of threads - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/expvarreceiver/documentation.md b/receiver/expvarreceiver/documentation.md index 4a2cad2655f4..ad1b01b0a022 100644 --- a/receiver/expvarreceiver/documentation.md +++ b/receiver/expvarreceiver/documentation.md @@ -262,242 +262,22 @@ metrics: enabled: true ``` -### process.runtime.memstats.buck_hash_sys +### process.runtime.memstats.lookups -Bytes of memory in profiling bucket hash tables. +Number of pointer lookups performed by the runtime. As defined by https://pkg.go.dev/runtime#MemStats | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| {lookups} | Sum | Int | Cumulative | false | -### process.runtime.memstats.frees +### process.runtime.memstats.total_alloc -Cumulative count of heap objects freed. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects} | Sum | Int | Cumulative | true | - -### process.runtime.memstats.gc_cpu_fraction - -The fraction of this program's available CPU time used by the GC since the program started. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### process.runtime.memstats.gc_sys - -Bytes of memory in garbage collection metadata. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_alloc - -Bytes of allocated heap objects. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_idle - -Bytes in idle (unused) spans. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_inuse - -Bytes in in-use spans. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_objects - -Number of allocated heap objects. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects} | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_released - -Bytes of physical memory returned to the OS. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.heap_sys - -Bytes of heap memory obtained by the OS. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.last_pause - -The most recent stop-the-world pause time. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ns | Gauge | Int | - -### process.runtime.memstats.mallocs - -Cumulative count of heap objects allocated. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects} | Sum | Int | Cumulative | true | - -### process.runtime.memstats.mcache_inuse - -Bytes of allocated mcache structures. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.mcache_sys - -Bytes of memory obtained from the OS for mcache structures. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.mspan_inuse - -Bytes of allocated mspan structures. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.mspan_sys - -Bytes of memory obtained from the OS for mspan structures. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.next_gc - -The target heap size of the next GC cycle. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.num_forced_gc - -Number of GC cycles that were forced by the application calling the GC function. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### process.runtime.memstats.num_gc - -Number of completed GC cycles. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### process.runtime.memstats.other_sys - -Bytes of memory in miscellaneous off-heap runtime allocations. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.pause_total - -The cumulative nanoseconds in GC stop-the-world pauses since the program started. +Cumulative bytes allocated for heap objects. As defined by https://pkg.go.dev/runtime#MemStats | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | By | Sum | Int | Cumulative | true | - -### process.runtime.memstats.stack_inuse - -Bytes in stack spans. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.stack_sys - -Bytes of stack memory obtained from the OS. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### process.runtime.memstats.sys - -Total bytes of memory obtained from the OS. - -As defined by https://pkg.go.dev/runtime#MemStats - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | diff --git a/receiver/flinkmetricsreceiver/documentation.md b/receiver/flinkmetricsreceiver/documentation.md index 2f59feabb42a..c6a2779fafba 100644 --- a/receiver/flinkmetricsreceiver/documentation.md +++ b/receiver/flinkmetricsreceiver/documentation.md @@ -281,285 +281,6 @@ The number of records a task has. | ---- | ----------- | ------ | | record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### flink.job.checkpoint.count - -The number of checkpoints completed or failed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {checkpoints} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| checkpoint | The number of checkpoints completed or that failed. | Str: ``completed``, ``failed`` | - -### flink.job.checkpoint.in_progress - -The number of checkpoints in progress. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {checkpoints} | Sum | Int | Cumulative | false | - -### flink.job.last_checkpoint.size - -The total size of the last checkpoint. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.job.last_checkpoint.time - -The end to end duration of the last checkpoint. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### flink.job.restart.count - -The total number of restarts since this job was submitted, including full restarts and fine-grained restarts. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {restarts} | Sum | Int | Cumulative | true | - -### flink.jvm.class_loader.classes_loaded - -The total number of classes loaded since the start of the JVM. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {classes} | Sum | Int | Cumulative | true | - -### flink.jvm.cpu.load - -The CPU usage of the JVM for a jobmanager or taskmanager. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### flink.jvm.cpu.time - -The CPU time used by the JVM for a jobmanager or taskmanager. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ns | Sum | Int | Cumulative | true | - -### flink.jvm.gc.collections.count - -The total number of collections that have occurred. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {collections} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | - -### flink.jvm.gc.collections.time - -The total time spent performing garbage collection. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | - -### flink.jvm.memory.direct.total_capacity - -The total capacity of all buffers in the direct buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.direct.used - -The amount of memory used by the JVM for the direct buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.heap.committed - -The amount of heap memory guaranteed to be available to the JVM. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.heap.max - -The maximum amount of heap memory that can be used for memory management. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.heap.used - -The amount of heap memory currently used. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.mapped.total_capacity - -The number of buffers in the mapped buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.mapped.used - -The amount of memory used by the JVM for the mapped buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.metaspace.committed - -The amount of memory guaranteed to be available to the JVM in the Metaspace memory pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.metaspace.max - -The maximum amount of memory that can be used in the Metaspace memory pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.metaspace.used - -The amount of memory currently used in the Metaspace memory pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.nonheap.committed - -The amount of non-heap memory guaranteed to be available to the JVM. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.nonheap.max - -The maximum amount of non-heap memory that can be used for memory management. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.memory.nonheap.used - -The amount of non-heap memory currently used. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.jvm.threads.count - -The total number of live threads. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | - -### flink.memory.managed.total - -The total amount of managed memory. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.memory.managed.used - -The amount of managed memory currently used. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### flink.operator.record.count - -The number of records an operator has. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {records} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The operator name. | Any Str | -| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | - -### flink.operator.watermark.output - -The last watermark this operator has emitted. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| name | The operator name. | Any Str | - -### flink.task.record.count - -The number of records a task has. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {records} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md index 3723bf722a28..b61798491b11 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md @@ -37,13 +37,13 @@ metrics: enabled: true ``` -### system.cpu.time +### system.cpu.utilization -Total CPU seconds broken down by different states. +Percentage of CPU time broken down by different states. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | #### Attributes diff --git a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md index 94fc306901ad..6485b83d2b51 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md @@ -113,115 +113,3 @@ Time disk spent activated multiplied by the queue length. | Name | Description | Values | | ---- | ----------- | ------ | | device | Name of the disk. | Any Str | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### system.disk.io - -Disk bytes transferred. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | -| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | - -### system.disk.io_time - -Time disk spent activated. On Windows, this is calculated as the inverse of disk idle time. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | - -### system.disk.merged - -The number of disk reads/writes merged into single physical disk access operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | -| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | - -### system.disk.operation_time - -Time spent in disk operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | -| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | - -### system.disk.operations - -Disk operations count. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | -| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | - -### system.disk.pending_operations - -The queue size of pending I/O operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | - -### system.disk.weighted_io_time - -Time disk spent activated multiplied by the queue length. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the disk. | Any Str | diff --git a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md index 1987317aa4f2..d86d80965375 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md @@ -58,31 +58,13 @@ metrics: enabled: true ``` -### system.filesystem.inodes.usage - -FileSystem inodes used. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {inodes} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Identifier of the filesystem. | Any Str | -| mode | Mountpoint mode such "ro", "rw", etc. | Any Str | -| mountpoint | Mountpoint path. | Any Str | -| type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | -| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | - -### system.filesystem.usage +### system.filesystem.utilization -Filesystem bytes used. +Fraction of filesystem bytes used. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | #### Attributes @@ -92,4 +74,3 @@ Filesystem bytes used. | mode | Mountpoint mode such "ro", "rw", etc. | Any Str | | mountpoint | Mountpoint path. | Any Str | | type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | -| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md index d07752c010d9..00cd0916699f 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md @@ -35,37 +35,3 @@ Average CPU Load over 5 minutes. | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | | 1 | Gauge | Double | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### system.cpu.load_average.15m - -Average CPU Load over 15 minutes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### system.cpu.load_average.1m - -Average CPU Load over 1 minute. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### system.cpu.load_average.5m - -Average CPU Load over 5 minutes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | diff --git a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md index 1b9b0468eb29..419b9c134e1e 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md @@ -36,13 +36,13 @@ metrics: enabled: true ``` -### system.memory.usage +### system.memory.utilization -Bytes of memory in use. +Percentage of memory bytes in use. -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | #### Attributes diff --git a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md index a7bcbe41d27f..4fbd17448e14 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md @@ -97,77 +97,18 @@ metrics: enabled: true ``` -### system.network.connections +### system.network.conntrack.count -The number of connections. +The count of entries in conntrack table. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | +| {entries} | Sum | Int | Cumulative | false | -#### Attributes +### system.network.conntrack.max -| Name | Description | Values | -| ---- | ----------- | ------ | -| protocol | Network protocol, e.g. TCP or UDP. | Str: ``tcp`` | -| state | State of the network connection. | Any Str | - -### system.network.dropped - -The number of packets dropped. +The limit for entries in the conntrack table. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### system.network.errors - -The number of errors encountered. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {errors} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### system.network.io - -The number of bytes transmitted and received. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### system.network.packets - -The number of packets transferred. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| device | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | +| {entries} | Sum | Int | Cumulative | false | diff --git a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md index 0af244bc8dcf..daa3da65677f 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md @@ -66,42 +66,13 @@ metrics: enabled: true ``` -### system.paging.faults - -The number of page faults. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {faults} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Type of fault. | Str: ``major``, ``minor`` | - -### system.paging.operations - -The number of paging operations. +### system.paging.utilization -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes +Swap (unix) or pagefile (windows) utilization. -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Page In or Page Out. | Str: ``page_in``, ``page_out`` | -| type | Type of fault. | Str: ``major``, ``minor`` | - -### system.paging.usage - -Swap (unix) or pagefile (windows) usage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | #### Attributes diff --git a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md index d4b10b95568e..5d529964d56a 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md @@ -33,35 +33,3 @@ Total number of created processes. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | {processes} | Sum | Int | Cumulative | true | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### system.processes.count - -Total number of processes in each state. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {processes} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | Breakdown status of the processes. | Str: ``blocked``, ``daemon``, ``detached``, ``idle``, ``locked``, ``orphan``, ``paging``, ``running``, ``sleeping``, ``stopped``, ``system``, ``unknown``, ``zombies`` | - -### system.processes.created - -Total number of created processes. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {processes} | Sum | Int | Cumulative | true | diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md index 141f656e3a78..4595700b57ba 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md @@ -66,13 +66,27 @@ metrics: enabled: true ``` -### process.cpu.time +### process.context_switches -Total CPU seconds broken down by different states. +Number of times the process has been context switched. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | +| {count} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of context switched. | Str: ``involuntary``, ``voluntary`` | + +### process.cpu.utilization + +Percentage of total CPU time used by the process since last scrape, expressed as a value between 0 and 1. On the first scrape, no data point is emitted for this metric. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | #### Attributes @@ -80,35 +94,59 @@ Total CPU seconds broken down by different states. | ---- | ----------- | ------ | | state | Breakdown of CPU usage by type. | Str: ``system``, ``user``, ``wait`` | -### process.disk.io +### process.memory.usage -Disk bytes transferred. +The amount of physical memory in use. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| By | Sum | Int | Cumulative | false | + +### process.memory.virtual + +Virtual memory size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.open_file_descriptors + +Number of file descriptors in use by the process. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {count} | Sum | Int | Cumulative | false | + +### process.paging.faults + +Number of page faults the process has made. This metric is only available on Linux. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| direction | Direction of flow of bytes (read or write). | Str: ``read``, ``write`` | +| type | Type of memory paging fault. | Str: ``major``, ``minor`` | -### process.memory.physical_usage +### process.signals_pending -Deprecated: use `process.memory.usage` metric instead. The amount of physical memory in use. +Number of pending signals for the process. This metric is only available on Linux. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| {signals} | Sum | Int | Cumulative | false | -### process.memory.virtual_usage +### process.threads -Deprecated: Use `process.memory.virtual` metric instead. Virtual memory size. +Process threads count. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| {threads} | Sum | Int | Cumulative | false | ## Resource Attributes diff --git a/receiver/httpcheckreceiver/documentation.md b/receiver/httpcheckreceiver/documentation.md index 0fa47eb07e4e..37a8afd87b82 100644 --- a/receiver/httpcheckreceiver/documentation.md +++ b/receiver/httpcheckreceiver/documentation.md @@ -57,59 +57,3 @@ Records errors occurring during HTTP check. | http.status_code | HTTP response status code | Any Int | | http.method | HTTP request method | Any Str | | http.status_class | HTTP response status class | Any Str | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### httpcheck.duration - -Measures the duration of the HTTP check. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| http.url | Full HTTP request URL. | Any Str | - -### httpcheck.error - -Records errors occurring during HTTP check. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {error} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| http.url | Full HTTP request URL. | Any Str | -| error.message | Error message recorded during check | Any Str | - -### httpcheck.status - -1 if the check resulted in status_code matching the status_class, otherwise 0. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| http.url | Full HTTP request URL. | Any Str | -| http.status_code | HTTP response status code | Any Int | -| http.method | HTTP request method | Any Str | -| http.status_class | HTTP response status class | Any Str | diff --git a/receiver/iisreceiver/documentation.md b/receiver/iisreceiver/documentation.md index 7fe7cf6e1e9b..3044ca7cf6d9 100644 --- a/receiver/iisreceiver/documentation.md +++ b/receiver/iisreceiver/documentation.md @@ -126,130 +126,6 @@ The amount of time the server has been up. | ---- | ----------- | ---------- | | s | Gauge | Int | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### iis.connection.active - -Number of active connections. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### iis.connection.anonymous - -Number of connections established anonymously. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | true | - -### iis.connection.attempt.count - -Total number of attempts to connect to the server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {attempts} | Sum | Int | Cumulative | true | - -### iis.network.blocked - -Number of bytes blocked due to bandwidth throttling. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### iis.network.file.count - -Number of transmitted files. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {files} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction data is moving. | Str: ``sent``, ``received`` | - -### iis.network.io - -Total amount of bytes sent and received. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction data is moving. | Str: ``sent``, ``received`` | - -### iis.request.count - -Total number of requests of a given type. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| request | The type of request sent by a client. | Str: ``delete``, ``get``, ``head``, ``options``, ``post``, ``put``, ``trace`` | - -### iis.request.queue.age.max - -Age of oldest request in the queue. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### iis.request.queue.count - -Current number of requests in the queue. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | false | - -### iis.request.rejected - -Total number of requests rejected. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -### iis.thread.active - -Current number of active threads. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | - -### iis.uptime - -The amount of time the server has been up. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/kafkametricsreceiver/documentation.md b/receiver/kafkametricsreceiver/documentation.md index 25f267d7cdc1..b90b157583bc 100644 --- a/receiver/kafkametricsreceiver/documentation.md +++ b/receiver/kafkametricsreceiver/documentation.md @@ -169,171 +169,3 @@ Number of partitions in topic. | Name | Description | Values | | ---- | ----------- | ------ | | topic | The ID (integer) of a topic | Any Str | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### kafka.brokers - -Number of brokers in the cluster. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {brokers} | Gauge | Int | - -### kafka.consumer_group.lag - -Current approximate lag of consumer group at partition of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | Any Str | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.consumer_group.lag_sum - -Current approximate sum of consumer group lag across all partitions of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | Any Str | -| topic | The ID (integer) of a topic | Any Str | - -### kafka.consumer_group.members - -Count of members in the consumer group - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {members} | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | Any Str | - -### kafka.consumer_group.offset - -Current offset of the consumer group at partition of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | Any Str | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.consumer_group.offset_sum - -Sum of consumer group offset across partitions of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | Any Str | -| topic | The ID (integer) of a topic | Any Str | - -### kafka.partition.current_offset - -Current offset of partition of topic. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.partition.oldest_offset - -Oldest offset of partition of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.partition.replicas - -Number of replicas for partition of topic - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {replicas} | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.partition.replicas_in_sync - -Number of synchronized replicas of partition - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {replicas} | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| topic | The ID (integer) of a topic | Any Str | -| partition | The number (integer) of the partition | Any Int | - -### kafka.topic.partitions - -Number of partitions in topic. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {partitions} | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| topic | The ID (integer) of a topic | Any Str | diff --git a/receiver/kubeletstatsreceiver/documentation.md b/receiver/kubeletstatsreceiver/documentation.md index 82f8c2372842..e6927a5279d8 100644 --- a/receiver/kubeletstatsreceiver/documentation.md +++ b/receiver/kubeletstatsreceiver/documentation.md @@ -376,380 +376,6 @@ The inodes used by the filesystem. This may not equal inodes - free because file | ---- | ----------- | ---------- | | 1 | Gauge | Int | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### container.cpu.time - -Container CPU time - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -### container.cpu.utilization - -Container CPU utilization - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### container.filesystem.available - -Container filesystem available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.filesystem.capacity - -Container filesystem capacity - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.filesystem.usage - -Container filesystem usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.memory.available - -Container memory available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.memory.major_page_faults - -Container memory major_page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### container.memory.page_faults - -Container memory page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### container.memory.rss - -Container memory rss - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.memory.usage - -Container memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### container.memory.working_set - -Container memory working_set - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.cpu.time - -Node CPU time - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -### k8s.node.cpu.utilization - -Node CPU utilization - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### k8s.node.filesystem.available - -Node filesystem available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.filesystem.capacity - -Node filesystem capacity - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.filesystem.usage - -Node filesystem usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.memory.available - -Node memory available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.memory.major_page_faults - -Node memory major_page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.node.memory.page_faults - -Node memory page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.node.memory.rss - -Node memory rss - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.memory.usage - -Node memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.memory.working_set - -Node memory working_set - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.node.network.errors - -Node network errors - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| interface | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### k8s.node.network.io - -Node network IO - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| interface | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### k8s.pod.cpu.time - -Pod CPU time - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -### k8s.pod.cpu.utilization - -Pod CPU utilization - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### k8s.pod.filesystem.available - -Pod filesystem available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.filesystem.capacity - -Pod filesystem capacity - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.filesystem.usage - -Pod filesystem usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.memory.available - -Pod memory available - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.memory.major_page_faults - -Pod memory major_page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.pod.memory.page_faults - -Pod memory page_faults - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.pod.memory.rss - -Pod memory rss - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.memory.usage - -Pod memory usage - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.memory.working_set - -Pod memory working_set - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.pod.network.errors - -Pod network errors - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| interface | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### k8s.pod.network.io - -Pod network IO - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| interface | Name of the network interface. | Any Str | -| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | - -### k8s.volume.available - -The number of available bytes in the volume. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.volume.capacity - -The total capacity in bytes of the volume. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### k8s.volume.inodes - -The total inodes in the filesystem. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.volume.inodes.free - -The free inodes in the filesystem. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - -### k8s.volume.inodes.used - -The inodes used by the filesystem. This may not equal inodes - free because filesystem may share inodes with other filesystems. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Int | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/memcachedreceiver/documentation.md b/receiver/memcachedreceiver/documentation.md index 7fe7f72ff69e..08d7dcb97c59 100644 --- a/receiver/memcachedreceiver/documentation.md +++ b/receiver/memcachedreceiver/documentation.md @@ -130,132 +130,3 @@ Number of threads used by the memcached instance. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | {threads} | Sum | Int | Cumulative | false | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### memcached.bytes - -Current number of bytes used by this server to store items. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### memcached.commands - -Commands executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {commands} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| command | The type of command. | Str: ``get``, ``set``, ``flush``, ``touch`` | - -### memcached.connections.current - -The current number of open connections. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### memcached.connections.total - -Total number of connections opened since the server started running. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | true | - -### memcached.cpu.usage - -Accumulated user and system time. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The type of CPU usage. | Str: ``system``, ``user`` | - -### memcached.current_items - -Number of items currently stored in the cache. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {items} | Sum | Int | Cumulative | false | - -### memcached.evictions - -Cache item evictions. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {evictions} | Sum | Int | Cumulative | true | - -### memcached.network - -Bytes transferred over the network. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| by | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Direction of data flow. | Str: ``sent``, ``received`` | - -### memcached.operation_hit_ratio - -Hit ratio for operations, expressed as a percentage value between 0.0 and 100.0. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | - -### memcached.operations - -Operation counts. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | Result of cache request. | Str: ``hit``, ``miss`` | -| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | - -### memcached.threads - -Number of threads used by the memcached instance. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | diff --git a/receiver/mongodbatlasreceiver/documentation.md b/receiver/mongodbatlasreceiver/documentation.md index 0bda1d88a56e..a7a427b608a3 100644 --- a/receiver/mongodbatlasreceiver/documentation.md +++ b/receiver/mongodbatlasreceiver/documentation.md @@ -959,963 +959,6 @@ Aggregate of MongoDB Metrics MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED | ---- | ----------- | ------ | | memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### mongodbatlas.db.counts - -Database feature size - -Aggregate of MongoDB Metrics DATABASE_EXTENT_COUNT, DATABASE_VIEW_COUNT, DATABASE_COLLECTION_COUNT, DATABASE_OBJECT_COUNT, DATABASE_INDEX_COUNT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {objects} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | - -### mongodbatlas.db.size - -Database feature size - -Aggregate of MongoDB Metrics DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_AVERAGE_OBJECT_SIZE - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | - -### mongodbatlas.disk.partition.iops.average - -Disk partition iops - -Aggregate of MongoDB Metrics DISK_PARTITION_IOPS_READ, DISK_PARTITION_IOPS_WRITE, DISK_PARTITION_IOPS_TOTAL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {ops}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | - -### mongodbatlas.disk.partition.iops.max - -Disk partition iops - -Aggregate of MongoDB Metrics MAX_DISK_PARTITION_IOPS_WRITE, MAX_DISK_PARTITION_IOPS_TOTAL, MAX_DISK_PARTITION_IOPS_READ - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {ops}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | - -### mongodbatlas.disk.partition.latency.average - -Disk partition latency - -Aggregate of MongoDB Metrics DISK_PARTITION_LATENCY_WRITE, DISK_PARTITION_LATENCY_READ - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | - -### mongodbatlas.disk.partition.latency.max - -Disk partition latency - -Aggregate of MongoDB Metrics MAX_DISK_PARTITION_LATENCY_WRITE, MAX_DISK_PARTITION_LATENCY_READ - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | - -### mongodbatlas.disk.partition.space.average - -Disk partition space - -Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.disk.partition.space.max - -Disk partition space - -Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.disk.partition.usage.average - -Disk partition usage (%) - -Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_PERCENT_FREE, DISK_PARTITION_SPACE_PERCENT_USED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.disk.partition.usage.max - -Disk partition usage (%) - -Aggregate of MongoDB Metrics MAX_DISK_PARTITION_SPACE_PERCENT_USED, MAX_DISK_PARTITION_SPACE_PERCENT_FREE - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.disk.partition.utilization.average - -Disk partition utilization (%) - -MongoDB Metrics DISK_PARTITION_UTILIZATION - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.disk.partition.utilization.max - -Disk partition utilization (%) - -MongoDB Metrics MAX_DISK_PARTITION_UTILIZATION - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_status | Disk measurement type | Str: ``free``, ``used`` | - -### mongodbatlas.process.asserts - -Number of assertions per second - -Aggregate of MongoDB Metrics ASSERT_REGULAR, ASSERT_USER, ASSERT_MSG, ASSERT_WARNING - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {assertions}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| assert_type | MongoDB assertion type | Str: ``regular``, ``warning``, ``msg``, ``user`` | - -### mongodbatlas.process.background_flush - -Amount of data flushed in the background - -MongoDB Metric BACKGROUND_FLUSH_AVG - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### mongodbatlas.process.cache.io - -Cache throughput (per second) - -Aggregate of MongoDB Metrics CACHE_BYTES_READ_INTO, CACHE_BYTES_WRITTEN_FROM - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cache_direction | Whether read into or written from | Str: ``read_into``, ``written_from`` | - -### mongodbatlas.process.cache.size - -Cache sizes - -Aggregate of MongoDB Metrics CACHE_USED_BYTES, CACHE_DIRTY_BYTES - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Double | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cache_status | Cache status | Str: ``dirty``, ``used`` | - -### mongodbatlas.process.connections - -Number of current connections - -MongoDB Metric CONNECTIONS - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Double | Cumulative | false | - -### mongodbatlas.process.cpu.children.normalized.usage.average - -CPU Usage for child processes, normalized to pct - -Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, PROCESS_NORMALIZED_CPU_CHILDREN_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.children.normalized.usage.max - -CPU Usage for child processes, normalized to pct - -Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.children.usage.average - -CPU Usage for child processes (%) - -Aggregate of MongoDB Metrics PROCESS_CPU_CHILDREN_KERNEL, PROCESS_CPU_CHILDREN_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.children.usage.max - -CPU Usage for child processes (%) - -Aggregate of MongoDB Metrics MAX_PROCESS_CPU_CHILDREN_USER, MAX_PROCESS_CPU_CHILDREN_KERNEL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.normalized.usage.average - -CPU Usage, normalized to pct - -Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_KERNEL, PROCESS_NORMALIZED_CPU_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.normalized.usage.max - -CPU Usage, normalized to pct - -Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_USER, MAX_PROCESS_NORMALIZED_CPU_KERNEL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.usage.average - -CPU Usage (%) - -Aggregate of MongoDB Metrics PROCESS_CPU_KERNEL, PROCESS_CPU_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cpu.usage.max - -CPU Usage (%) - -Aggregate of MongoDB Metrics MAX_PROCESS_CPU_KERNEL, MAX_PROCESS_CPU_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.cursors - -Number of cursors - -Aggregate of MongoDB Metrics CURSORS_TOTAL_OPEN, CURSORS_TOTAL_TIMED_OUT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {cursors} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cursor_state | Whether cursor is open or timed out | Str: ``timed_out``, ``open`` | - -### mongodbatlas.process.db.document.rate - -Document access rates - -Aggregate of MongoDB Metrics DOCUMENT_METRICS_UPDATED, DOCUMENT_METRICS_DELETED, DOCUMENT_METRICS_RETURNED, DOCUMENT_METRICS_INSERTED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {documents}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| document_status | Status of documents in the database | Str: ``returned``, ``inserted``, ``updated``, ``deleted`` | - -### mongodbatlas.process.db.operations.rate - -DB Operation Rates - -Aggregate of MongoDB Metrics OPCOUNTER_GETMORE, OPERATIONS_SCAN_AND_ORDER, OPCOUNTER_UPDATE, OPCOUNTER_REPL_UPDATE, OPCOUNTER_CMD, OPCOUNTER_DELETE, OPCOUNTER_REPL_DELETE, OPCOUNTER_REPL_CMD, OPCOUNTER_QUERY, OPCOUNTER_REPL_INSERT, OPCOUNTER_INSERT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {operations}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | Type of database operation | Str: ``cmd``, ``query``, ``update``, ``delete``, ``getmore``, ``insert``, ``scan_and_order`` | -| cluster_role | Whether process is acting as replica or primary | Str: ``primary``, ``replica`` | - -### mongodbatlas.process.db.operations.time - -DB Operation Times - -Aggregate of MongoDB Metrics OP_EXECUTION_TIME_WRITES, OP_EXECUTION_TIME_COMMANDS, OP_EXECUTION_TIME_READS - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| execution_type | Type of command | Str: ``reads``, ``writes``, ``commands`` | - -### mongodbatlas.process.db.query_executor.scanned - -Scanned objects - -Aggregate of MongoDB Metrics QUERY_EXECUTOR_SCANNED_OBJECTS, QUERY_EXECUTOR_SCANNED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {objects}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | - -### mongodbatlas.process.db.query_targeting.scanned_per_returned - -Scanned objects per returned - -Aggregate of MongoDB Metrics QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED, QUERY_TARGETING_SCANNED_PER_RETURNED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {scanned}/{returned} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | - -### mongodbatlas.process.db.storage - -Storage used by the database - -Aggregate of MongoDB Metrics DB_INDEX_SIZE_TOTAL, DB_DATA_SIZE_TOTAL_WO_SYSTEM, DB_STORAGE_TOTAL, DB_DATA_SIZE_TOTAL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| storage_status | Views on database size | Str: ``total``, ``data_size``, ``index_size``, ``data_size_wo_system`` | - -### mongodbatlas.process.fts.cpu.usage - -Full text search CPU (%) - -Aggregate of MongoDB Metrics FTS_PROCESS_CPU_USER, FTS_PROCESS_CPU_KERNEL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.process.global_lock - -Number and status of locks - -Aggregate of MongoDB Metrics GLOBAL_LOCK_CURRENT_QUEUE_WRITERS, GLOBAL_LOCK_CURRENT_QUEUE_READERS, GLOBAL_LOCK_CURRENT_QUEUE_TOTAL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {locks} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| global_lock_state | Which queue is locked | Str: ``current_queue_total``, ``current_queue_readers``, ``current_queue_writers`` | - -### mongodbatlas.process.index.btree_miss_ratio - -Index miss ratio (%) - -MongoDB Metric INDEX_COUNTERS_BTREE_MISS_RATIO - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -### mongodbatlas.process.index.counters - -Indexes - -Aggregate of MongoDB Metrics INDEX_COUNTERS_BTREE_MISSES, INDEX_COUNTERS_BTREE_ACCESSES, INDEX_COUNTERS_BTREE_HITS - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {indexes} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| btree_counter_type | Database index effectiveness | Str: ``accesses``, ``hits``, ``misses`` | - -### mongodbatlas.process.journaling.commits - -Journaling commits - -MongoDB Metric JOURNALING_COMMITS_IN_WRITE_LOCK - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {commits} | Gauge | Double | - -### mongodbatlas.process.journaling.data_files - -Data file sizes - -MongoDB Metric JOURNALING_WRITE_DATA_FILES_MB - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| MiBy | Gauge | Double | - -### mongodbatlas.process.journaling.written - -Journals written - -MongoDB Metric JOURNALING_MB - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| MiBy | Gauge | Double | - -### mongodbatlas.process.memory.usage - -Memory Usage - -Aggregate of MongoDB Metrics MEMORY_MAPPED, MEMORY_VIRTUAL, COMPUTED_MEMORY, MEMORY_RESIDENT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | - -### mongodbatlas.process.network.io - -Network IO - -Aggregate of MongoDB Metrics NETWORK_BYTES_OUT, NETWORK_BYTES_IN - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Network traffic direction | Str: ``receive``, ``transmit`` | - -### mongodbatlas.process.network.requests - -Network requests - -MongoDB Metric NETWORK_NUM_REQUESTS - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Double | Cumulative | true | - -### mongodbatlas.process.oplog.rate - -Execution rate by operation - -MongoDB Metric OPLOG_RATE_GB_PER_HOUR - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| GiBy/h | Gauge | Double | - -### mongodbatlas.process.oplog.time - -Execution time by operation - -Aggregate of MongoDB Metrics OPLOG_MASTER_TIME, OPLOG_SLAVE_LAG_MASTER_TIME, OPLOG_MASTER_LAG_TIME_DIFF - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| oplog_type | Oplog type | Str: ``slave_lag_master_time``, ``master_time``, ``master_lag_time_diff`` | - -### mongodbatlas.process.page_faults - -Page faults - -Aggregate of MongoDB Metrics GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN, EXTRA_INFO_PAGE_FAULTS, GLOBAL_ACCESSES_NOT_IN_MEMORY - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {faults}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_issue_type | Type of memory issue encountered | Str: ``extra_info``, ``global_accesses_not_in_memory``, ``exceptions_thrown`` | - -### mongodbatlas.process.restarts - -Restarts in last hour - -Aggregate of MongoDB Metrics RESTARTS_IN_LAST_HOUR - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {restarts}/h | Gauge | Double | - -### mongodbatlas.process.tickets - -Tickets - -Aggregate of MongoDB Metrics TICKETS_AVAILABLE_WRITE, TICKETS_AVAILABLE_READS - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {tickets} | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| ticket_type | Type of ticket available | Str: ``available_reads``, ``available_writes`` | - -### mongodbatlas.system.cpu.normalized.usage.average - -System CPU Normalized to pct - -Aggregate of MongoDB Metrics SYSTEM_NORMALIZED_CPU_IOWAIT, SYSTEM_NORMALIZED_CPU_GUEST, SYSTEM_NORMALIZED_CPU_IRQ, SYSTEM_NORMALIZED_CPU_KERNEL, SYSTEM_NORMALIZED_CPU_STEAL, SYSTEM_NORMALIZED_CPU_SOFTIRQ, SYSTEM_NORMALIZED_CPU_NICE, SYSTEM_NORMALIZED_CPU_USER - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.cpu.normalized.usage.max - -System CPU Normalized to pct - -Aggregate of MongoDB Metrics MAX_SYSTEM_NORMALIZED_CPU_USER, MAX_SYSTEM_NORMALIZED_CPU_NICE, MAX_SYSTEM_NORMALIZED_CPU_IOWAIT, MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ, MAX_SYSTEM_NORMALIZED_CPU_STEAL, MAX_SYSTEM_NORMALIZED_CPU_KERNEL, MAX_SYSTEM_NORMALIZED_CPU_GUEST, MAX_SYSTEM_NORMALIZED_CPU_IRQ - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.cpu.usage.average - -System CPU Usage (%) - -Aggregate of MongoDB Metrics SYSTEM_CPU_USER, SYSTEM_CPU_GUEST, SYSTEM_CPU_SOFTIRQ, SYSTEM_CPU_IRQ, SYSTEM_CPU_KERNEL, SYSTEM_CPU_IOWAIT, SYSTEM_CPU_NICE, SYSTEM_CPU_STEAL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.cpu.usage.max - -System CPU Usage (%) - -Aggregate of MongoDB Metrics MAX_SYSTEM_CPU_SOFTIRQ, MAX_SYSTEM_CPU_IRQ, MAX_SYSTEM_CPU_GUEST, MAX_SYSTEM_CPU_IOWAIT, MAX_SYSTEM_CPU_NICE, MAX_SYSTEM_CPU_KERNEL, MAX_SYSTEM_CPU_USER, MAX_SYSTEM_CPU_STEAL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.fts.cpu.normalized.usage - -Full text search disk usage (%) - -Aggregate of MongoDB Metrics FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.fts.cpu.usage - -Full-text search (%) - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| 1 | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | - -### mongodbatlas.system.fts.disk.used - -Full text search disk usage - -MongoDB Metric FTS_DISK_USAGE - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Double | - -### mongodbatlas.system.fts.memory.usage - -Full-text search - -Aggregate of MongoDB Metrics FTS_MEMORY_MAPPED, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| MiBy | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | - -### mongodbatlas.system.memory.usage.average - -System Memory Usage - -Aggregate of MongoDB Metrics SYSTEM_MEMORY_AVAILABLE, SYSTEM_MEMORY_BUFFERS, SYSTEM_MEMORY_USED, SYSTEM_MEMORY_CACHED, SYSTEM_MEMORY_SHARED, SYSTEM_MEMORY_FREE - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KiBy | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | - -### mongodbatlas.system.memory.usage.max - -System Memory Usage - -Aggregate of MongoDB Metrics MAX_SYSTEM_MEMORY_CACHED, MAX_SYSTEM_MEMORY_AVAILABLE, MAX_SYSTEM_MEMORY_USED, MAX_SYSTEM_MEMORY_BUFFERS, MAX_SYSTEM_MEMORY_FREE, MAX_SYSTEM_MEMORY_SHARED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KiBy | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | - -### mongodbatlas.system.network.io.average - -System Network IO - -Aggregate of MongoDB Metrics SYSTEM_NETWORK_IN, SYSTEM_NETWORK_OUT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Network traffic direction | Str: ``receive``, ``transmit`` | - -### mongodbatlas.system.network.io.max - -System Network IO - -Aggregate of MongoDB Metrics MAX_SYSTEM_NETWORK_OUT, MAX_SYSTEM_NETWORK_IN - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Network traffic direction | Str: ``receive``, ``transmit`` | - -### mongodbatlas.system.paging.io.average - -Swap IO - -Aggregate of MongoDB Metrics SWAP_IO_IN, SWAP_IO_OUT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {pages}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Network traffic direction | Str: ``receive``, ``transmit`` | - -### mongodbatlas.system.paging.io.max - -Swap IO - -Aggregate of MongoDB Metrics MAX_SWAP_IO_IN, MAX_SWAP_IO_OUT - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {pages}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | Network traffic direction | Str: ``receive``, ``transmit`` | - -### mongodbatlas.system.paging.usage.average - -Swap usage - -Aggregate of MongoDB Metrics SWAP_USAGE_FREE, SWAP_USAGE_USED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KiBy | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | - -### mongodbatlas.system.paging.usage.max - -Swap usage - -Aggregate of MongoDB Metrics MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KiBy | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/mongodbreceiver/documentation.md b/receiver/mongodbreceiver/documentation.md index f6643e278dd6..8dfdd6ecdb50 100644 --- a/receiver/mongodbreceiver/documentation.md +++ b/receiver/mongodbreceiver/documentation.md @@ -288,271 +288,69 @@ metrics: enabled: true ``` -### mongodb.cache.operations - -The number of cache operations of the instance. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The result of a cache request. | Str: ``hit``, ``miss`` | - -### mongodb.collection.count - -The number of collections. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {collections} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | - -### mongodb.connection.count - -The number of connections. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | -| type | The status of the connection. | Str: ``active``, ``available``, ``current`` | - -### mongodb.cursor.count - -The number of open cursors maintained for clients. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {cursors} | Sum | Int | Cumulative | false | - -### mongodb.cursor.timeout.count - -The number of cursors that have timed out. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {cursors} | Sum | Int | Cumulative | false | - -### mongodb.data.size - -The size of the collection. Data compression does not affect this value. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | - -### mongodb.database.count - -The number of existing databases. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {databases} | Sum | Int | Cumulative | false | - -### mongodb.document.operation.count - -The number of document operations executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {documents} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | -| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | - -### mongodb.extent.count - -The number of extents. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {extents} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | - -### mongodb.global_lock.time +### mongodb.lock.acquire.count -The time the global lock has been held. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -### mongodb.index.access.count - -The number of times an index has been accessed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {accesses} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | -| collection | The name of a collection. | Any Str | - -### mongodb.index.count - -The number of indexes. +Number of times the lock was acquired in the specified mode. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {indexes} | Sum | Int | Cumulative | false | +| {count} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | | database | The name of a database. | Any Str | +| lock_type | The Resource over which the Lock controls access | Str: ``parallel_batch_write_mode``, ``replication_state_transition``, ``global``, ``database``, ``collection``, ``mutex``, ``metadata``, ``oplog`` | +| lock_mode | The mode of Lock which denotes the degree of access | Str: ``shared``, ``exclusive``, ``intent_shared``, ``intent_exclusive`` | -### mongodb.index.size +### mongodb.lock.acquire.time -Sum of the space allocated to all indexes in the database, including free index space. +Cumulative wait time for the lock acquisitions. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| microseconds | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | | database | The name of a database. | Any Str | +| lock_type | The Resource over which the Lock controls access | Str: ``parallel_batch_write_mode``, ``replication_state_transition``, ``global``, ``database``, ``collection``, ``mutex``, ``metadata``, ``oplog`` | +| lock_mode | The mode of Lock which denotes the degree of access | Str: ``shared``, ``exclusive``, ``intent_shared``, ``intent_exclusive`` | -### mongodb.memory.usage +### mongodb.lock.acquire.wait_count -The amount of memory used. +Number of times the lock acquisitions encountered waits because the locks were held in a conflicting mode. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | +| {count} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | | database | The name of a database. | Any Str | -| type | The type of memory used. | Str: ``resident``, ``virtual`` | - -### mongodb.network.io.receive - -The number of bytes received. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### mongodb.network.io.transmit +| lock_type | The Resource over which the Lock controls access | Str: ``parallel_batch_write_mode``, ``replication_state_transition``, ``global``, ``database``, ``collection``, ``mutex``, ``metadata``, ``oplog`` | +| lock_mode | The mode of Lock which denotes the degree of access | Str: ``shared``, ``exclusive``, ``intent_shared``, ``intent_exclusive`` | -The number of by transmitted. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### mongodb.network.request.count +### mongodb.lock.deadlock.count -The number of requests received by the server. +Number of times the lock acquisitions encountered deadlocks. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | false | - -### mongodb.object.count - -The number of objects. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {objects} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of a database. | Any Str | - -### mongodb.operation.count - -The number of operations executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | - -### mongodb.operation.time - -The total time spent performing operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | - -### mongodb.session.count - -The total number of active sessions. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {sessions} | Sum | Int | Cumulative | false | - -### mongodb.storage.size - -The total amount of storage allocated to this collection. - -If collection data is compressed it reflects the compressed size. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | +| {count} | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | | database | The name of a database. | Any Str | +| lock_type | The Resource over which the Lock controls access | Str: ``parallel_batch_write_mode``, ``replication_state_transition``, ``global``, ``database``, ``collection``, ``mutex``, ``metadata``, ``oplog`` | +| lock_mode | The mode of Lock which denotes the degree of access | Str: ``shared``, ``exclusive``, ``intent_shared``, ``intent_exclusive`` | ## Resource Attributes diff --git a/receiver/mysqlreceiver/documentation.md b/receiver/mysqlreceiver/documentation.md index af1eb103057f..4c467dcd1dce 100644 --- a/receiver/mysqlreceiver/documentation.md +++ b/receiver/mysqlreceiver/documentation.md @@ -380,95 +380,23 @@ metrics: enabled: true ``` -### mysql.buffer_pool.data_pages - -The number of data pages in the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | - -### mysql.buffer_pool.limit - -The configured size of the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### mysql.buffer_pool.operations - -The number of operations on the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The buffer pool operations types. | Str: ``read_ahead_rnd``, ``read_ahead``, ``read_ahead_evicted``, ``read_requests``, ``reads``, ``wait_free``, ``write_requests`` | - -### mysql.buffer_pool.page_flushes - -The number of requests to flush pages from the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### mysql.buffer_pool.pages - -The number of pages in the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| kind | The buffer pool pages types. | Str: ``data``, ``free``, ``misc`` | - -### mysql.buffer_pool.usage +### mysql.client.network.io -The number of bytes in the InnoDB buffer pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | - -### mysql.commands - -The number of times each type of command has been executed. +The number of transmitted bytes between server and clients. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| By | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | +| kind | The name of the transmission direction. | Str: ``received``, ``sent`` | -### mysql.double_writes +### mysql.connection.errors -The number of writes to the InnoDB doublewrite buffer. +Errors that occur during the client connection process. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -478,11 +406,11 @@ The number of writes to the InnoDB doublewrite buffer. | Name | Description | Values | | ---- | ----------- | ------ | -| kind | The doublewrite types. | Str: ``pages_written``, ``writes`` | +| error | The connection error type. | Str: ``accept``, ``internal``, ``max_connections``, ``peer_address``, ``select``, ``tcpwrap`` | -### mysql.handlers +### mysql.joins -The number of requests to various MySQL handlers. +The number of joins that perform table scans. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -492,241 +420,148 @@ The number of requests to various MySQL handlers. | Name | Description | Values | | ---- | ----------- | ------ | -| kind | The handler types. | Str: ``commit``, ``delete``, ``discover``, ``external_lock``, ``mrr_init``, ``prepare``, ``read_first``, ``read_key``, ``read_last``, ``read_next``, ``read_prev``, ``read_rnd``, ``read_rnd_next``, ``rollback``, ``savepoint``, ``savepoint_rollback``, ``update``, ``write`` | +| kind | The kind of join. | Str: ``full``, ``full_range``, ``range``, ``range_check``, ``scan`` | -### mysql.index.io.wait.count - -The total count of I/O wait events for an index. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +### mysql.mysqlx_worker_threads -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | -| table | Table name for event or process. | Any Str | -| schema | The schema of the object. | Any Str | -| index | The name of the index. | Any Str | - -### mysql.index.io.wait.time - -The total time of I/O wait events for an index. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ns | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | -| table | Table name for event or process. | Any Str | -| schema | The schema of the object. | Any Str | -| index | The name of the index. | Any Str | - -### mysql.locked_connects - -The number of attempts to connect to locked user accounts. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -### mysql.locks - -The number of MySQL locks. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| kind | The table locks type. | Str: ``immediate``, ``waited`` | - -### mysql.log_operations - -The number of InnoDB log operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The log operation types. | Str: ``waits``, ``write_requests``, ``writes`` | - -### mysql.mysqlx_connections - -The number of mysqlx connections. +The number of worker threads available. This metric is specific for MySQL working as Document Store (X-Plugin). [more docs](https://dev.mysql.com/doc/refman/8.0/en/document-store.html) | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| 1 | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| status | The connection status. | Str: ``accepted``, ``closed``, ``rejected`` | +| kind | The worker thread count kind. | Str: ``available``, ``active`` | -### mysql.opened_resources +### mysql.query.client.count -The number of opened resources. +The number of statements executed by the server. This includes only statements sent to the server by clients. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | 1 | Sum | Int | Cumulative | true | -#### Attributes +### mysql.query.count -| Name | Description | Values | -| ---- | ----------- | ------ | -| kind | The kind of the resource. | Str: ``file``, ``table_definition``, ``table`` | - -### mysql.operations - -The number of InnoDB operations. +The number of statements executed by the server. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | 1 | Sum | Int | Cumulative | true | -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The operation types. | Str: ``fsyncs``, ``reads``, ``writes`` | - -### mysql.page_operations +### mysql.query.slow.count -The number of InnoDB page operations. +The number of slow queries. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | 1 | Sum | Int | Cumulative | true | -#### Attributes +### mysql.statement_event.count -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The page operation types. | Str: ``created``, ``read``, ``written`` | - -### mysql.prepared_statements - -The number of times each type of prepared statement command has been issued. +Summary of current and recent statement events. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | - -### mysql.row_locks - -The number of InnoDB row locks. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| 1 | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| kind | The row lock type. | Str: ``waits``, ``time`` | +| schema | The schema of the object. | Any Str | +| digest | Digest. | Any Str | +| digest_text | Text before digestion. | Any Str | +| kind | Possible event states. | Str: ``errors``, ``warnings``, ``rows_affected``, ``rows_sent``, ``rows_examined``, ``created_tmp_disk_tables``, ``created_tmp_tables``, ``sort_merge_passes``, ``sort_rows``, ``no_index_used`` | -### mysql.row_operations +### mysql.statement_event.wait.time -The number of InnoDB row operations. +The total wait time of the summarized timed events. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| ns | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The row operation type. | Str: ``deleted``, ``inserted``, ``read``, ``updated`` | +| schema | The schema of the object. | Any Str | +| digest | Digest. | Any Str | +| digest_text | Text before digestion. | Any Str | -### mysql.sorts +### mysql.table.lock_wait.read.count -The number of MySQL sorts. +The total table lock wait read events. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| 1 | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| kind | The sort count type. | Str: ``merge_passes``, ``range``, ``rows``, ``scan`` | +| schema | The schema of the object. | Any Str | +| table | Table name for event or process. | Any Str | +| kind | Read operation types. | Str: ``normal``, ``with_shared_locks``, ``high_priority``, ``no_insert``, ``external`` | -### mysql.table.io.wait.count +### mysql.table.lock_wait.read.time -The total count of I/O wait events for a table. +The total table lock wait read events times. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | +| ns | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | -| table | Table name for event or process. | Any Str | | schema | The schema of the object. | Any Str | +| table | Table name for event or process. | Any Str | +| kind | Read operation types. | Str: ``normal``, ``with_shared_locks``, ``high_priority``, ``no_insert``, ``external`` | -### mysql.table.io.wait.time +### mysql.table.lock_wait.write.count -The total time of I/O wait events for a table. +The total table lock wait write events. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| ns | Sum | Int | Cumulative | true | +| 1 | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | -| table | Table name for event or process. | Any Str | | schema | The schema of the object. | Any Str | +| table | Table name for event or process. | Any Str | +| kind | Write operation types. | Str: ``allow_write``, ``concurrent_insert``, ``low_priority``, ``normal``, ``external`` | -### mysql.threads +### mysql.table.lock_wait.write.time -The state of MySQL threads. +The total table lock wait write events times. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | +| ns | Sum | Int | Cumulative | false | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| kind | The thread count type. | Str: ``cached``, ``connected``, ``created``, ``running`` | +| schema | The schema of the object. | Any Str | +| table | Table name for event or process. | Any Str | +| kind | Write operation types. | Str: ``allow_write``, ``concurrent_insert``, ``low_priority``, ``normal``, ``external`` | -### mysql.tmp_resources +### mysql.table_open_cache -The number of created temporary resources. +The number of hits, misses or overflows for open tables cache lookups. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | @@ -736,7 +571,7 @@ The number of created temporary resources. | Name | Description | Values | | ---- | ----------- | ------ | -| resource | The kind of temporary resources. | Str: ``disk_tables``, ``files``, ``tables`` | +| status | The status of cache access. | Str: ``hit``, ``miss``, ``overflow`` | ## Resource Attributes diff --git a/receiver/nginxreceiver/documentation.md b/receiver/nginxreceiver/documentation.md index e80424b90c91..ee8402ad581b 100644 --- a/receiver/nginxreceiver/documentation.md +++ b/receiver/nginxreceiver/documentation.md @@ -49,51 +49,3 @@ Total number of requests made to the server since it started | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | requests | Sum | Int | Cumulative | true | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### nginx.connections_accepted - -The total number of accepted client connections - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| connections | Sum | Int | Cumulative | true | - -### nginx.connections_current - -The current number of nginx connections by state - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| connections | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of a connection | Str: ``active``, ``reading``, ``writing``, ``waiting`` | - -### nginx.connections_handled - -The total number of handled connections. Generally, the parameter value is the same as nginx.connections_accepted unless some resource limits have been reached (for example, the worker_connections limit). - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| connections | Sum | Int | Cumulative | true | - -### nginx.requests - -Total number of requests made to the server since it started - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| requests | Sum | Int | Cumulative | true | diff --git a/receiver/nsxtreceiver/documentation.md b/receiver/nsxtreceiver/documentation.md index dde06666e2b4..4783fef3eaa2 100644 --- a/receiver/nsxtreceiver/documentation.md +++ b/receiver/nsxtreceiver/documentation.md @@ -93,97 +93,6 @@ The number of packets which have flowed through the network interface on the nod | direction | The direction of network flow. | Str: ``received``, ``transmitted`` | | type | The type of packet counter. | Str: ``dropped``, ``errored``, ``success`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### nsxt.node.cpu.utilization - -The average amount of CPU being used by the node. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| class | The CPU usage of the architecture allocated for either DPDK (datapath) or non-DPDK (services) processes. | Str: ``datapath``, ``services`` | - -### nsxt.node.filesystem.usage - -The amount of storage space used by the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of storage space. | Str: ``used``, ``available`` | - -### nsxt.node.filesystem.utilization - -The percentage of storage space utilized. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### nsxt.node.memory.cache.usage - -The size of the node's memory cache. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| KBy | Sum | Int | Cumulative | false | - -### nsxt.node.memory.usage - -The memory usage of the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| KBy | Sum | Int | Cumulative | false | - -### nsxt.node.network.io - -The number of bytes which have flowed through the network interface. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | - -### nsxt.node.network.packet.count - -The number of packets which have flowed through the network interface on the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | -| type | The type of packet counter. | Str: ``dropped``, ``errored``, ``success`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/oracledbreceiver/documentation.md b/receiver/oracledbreceiver/documentation.md index 0e66c6570ffd..69550763226d 100644 --- a/receiver/oracledbreceiver/documentation.md +++ b/receiver/oracledbreceiver/documentation.md @@ -231,235 +231,6 @@ Number of times users manually issue the ROLLBACK statement or an error occurs d | ---- | ----------- | ---------- | ----------------------- | --------- | | 1 | Sum | Int | Cumulative | true | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### oracledb.cpu_time - -Cumulative CPU time, in seconds - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - -### oracledb.dml_locks.limit - -Maximum limit of active DML (Data Manipulation Language) locks. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {locks} | Gauge | Int | - -### oracledb.dml_locks.usage - -Current count of active DML (Data Manipulation Language) locks. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {locks} | Gauge | Int | - -### oracledb.enqueue_deadlocks - -Total number of deadlocks between table or row locks in different sessions. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {deadlocks} | Sum | Int | Cumulative | true | - -### oracledb.enqueue_locks.limit - -Maximum limit of active enqueue locks. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {locks} | Gauge | Int | - -### oracledb.enqueue_locks.usage - -Current count of active enqueue locks. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {locks} | Gauge | Int | - -### oracledb.enqueue_resources.limit - -Maximum limit of active enqueue resources. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {resources} | Gauge | Int | - -### oracledb.enqueue_resources.usage - -Current count of active enqueue resources. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {resources} | Gauge | Int | - -### oracledb.exchange_deadlocks - -Number of times that a process detected a potential deadlock when exchanging two buffers and raised an internal, restartable error. Index scans are the only operations that perform exchanges. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {deadlocks} | Sum | Int | Cumulative | true | - -### oracledb.executions - -Total number of calls (user and recursive) that executed SQL statements - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {executions} | Sum | Int | Cumulative | true | - -### oracledb.hard_parses - -Number of hard parses - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {parses} | Sum | Int | Cumulative | true | - -### oracledb.logical_reads - -Number of logical reads - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {reads} | Sum | Int | Cumulative | true | - -### oracledb.parse_calls - -Total number of parse calls. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {parses} | Sum | Int | Cumulative | true | - -### oracledb.pga_memory - -Session PGA (Program Global Area) memory - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### oracledb.physical_reads - -Number of physical reads - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {reads} | Sum | Int | Cumulative | true | - -### oracledb.processes.limit - -Maximum limit of active processes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {processes} | Gauge | Int | - -### oracledb.processes.usage - -Current count of active processes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {processes} | Gauge | Int | - -### oracledb.sessions.limit - -Maximum limit of active sessions. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {sessions} | Gauge | Int | - -### oracledb.sessions.usage - -Count of active sessions. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {sessions} | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| session_type | Session type | Any Str | -| session_status | Session status | Any Str | - -### oracledb.tablespace_size.limit - -Maximum size of tablespace in bytes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| tablespace_name | Tablespace name | Any Str | - -### oracledb.tablespace_size.usage - -Used tablespace in bytes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| tablespace_name | Tablespace name | Any Str | - -### oracledb.transactions.limit - -Maximum limit of active transactions. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {transactions} | Gauge | Int | - -### oracledb.transactions.usage - -Current count of active transactions. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {transactions} | Gauge | Int | - -### oracledb.user_commits - -Number of user commits. When a user commits a transaction, the redo generated that reflects the changes made to database blocks must be written to disk. Commits often represent the closest thing to a user transaction rate. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {commits} | Sum | Int | Cumulative | true | - -### oracledb.user_rollbacks - -Number of times users manually issue the ROLLBACK statement or an error occurs during a user's transactions - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/postgresqlreceiver/documentation.md b/receiver/postgresqlreceiver/documentation.md index caf53c04f426..c48a308abb24 100644 --- a/receiver/postgresqlreceiver/documentation.md +++ b/receiver/postgresqlreceiver/documentation.md @@ -262,277 +262,6 @@ Time between flushing recent WAL locally and receiving notification that the sta This metric requires WAL to be enabled with at least one replica. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The operation which is responsible for the lag. | Str: ``flush``, ``replay``, ``write`` | -| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | - -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### postgresql.backends - -The number of backends. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | - -### postgresql.bgwriter.buffers.allocated - -Number of buffers allocated. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {buffers} | Sum | Int | Cumulative | true | - -### postgresql.bgwriter.buffers.writes - -Number of buffers written. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {buffers} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| source | The source of a buffer write. | Str: ``backend``, ``backend_fsync``, ``checkpoints``, ``bgwriter`` | - -### postgresql.bgwriter.checkpoint.count - -The number of checkpoints performed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {checkpoints} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of checkpoint state. | Str: ``requested``, ``scheduled`` | - -### postgresql.bgwriter.duration - -Total time spent writing and syncing files to disk by checkpoints. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Double | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of time spent during the checkpoint. | Str: ``sync``, ``write`` | - -### postgresql.bgwriter.maxwritten - -Number of times the background writer stopped a cleaning scan because it had written too many buffers. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### postgresql.blocks_read - -The number of blocks read. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | -| table | The schema name followed by the table name. | Any Str | -| source | The block read source type. | Str: ``heap_read``, ``heap_hit``, ``idx_read``, ``idx_hit``, ``toast_read``, ``toast_hit``, ``tidx_read``, ``tidx_hit`` | - -### postgresql.commits - -The number of commits. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | - -### postgresql.connection.max - -Configured maximum number of client connections allowed - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {connections} | Gauge | Int | - -### postgresql.database.count - -Number of user databases. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {databases} | Sum | Int | Cumulative | false | - -### postgresql.db_size - -The database disk usage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | - -### postgresql.index.scans - -The number of index scans on a table. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {scans} | Sum | Int | Cumulative | true | - -### postgresql.index.size - -The size of the index on disk. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### postgresql.operations - -The number of db row operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | -| table | The schema name followed by the table name. | Any Str | -| operation | The database operation. | Str: ``ins``, ``upd``, ``del``, ``hot_upd`` | - -### postgresql.replication.data_delay - -The amount of data delayed in replication. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | - -### postgresql.rollbacks - -The number of rollbacks. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | - -### postgresql.rows - -The number of rows in the database. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| 1 | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| database | The name of the database. | Any Str | -| table | The schema name followed by the table name. | Any Str | -| state | The tuple (row) state. | Str: ``dead``, ``live`` | - -### postgresql.table.count - -Number of user tables in a database. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | false | - -### postgresql.table.size - -Disk space used by a table. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### postgresql.table.vacuum.count - -Number of times a table has manually been vacuumed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {vacuums} | Sum | Int | Cumulative | true | - -### postgresql.wal.age - -Age of the oldest WAL file. - -This metric requires WAL to be enabled with at least one replica. - - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - -### postgresql.wal.lag - -Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. - -This metric requires WAL to be enabled with at least one replica. - - | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | | s | Gauge | Int | diff --git a/receiver/rabbitmqreceiver/documentation.md b/receiver/rabbitmqreceiver/documentation.md index 748485f049c5..0b2763208d01 100644 --- a/receiver/rabbitmqreceiver/documentation.md +++ b/receiver/rabbitmqreceiver/documentation.md @@ -66,70 +66,6 @@ The number of messages published to a queue. | ---- | ----------- | ---------- | ----------------------- | --------- | | {messages} | Sum | Int | Cumulative | true | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### rabbitmq.consumer.count - -The number of consumers currently reading from the queue. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {consumers} | Sum | Int | Cumulative | false | - -### rabbitmq.message.acknowledged - -The number of messages acknowledged by consumers. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {messages} | Sum | Int | Cumulative | true | - -### rabbitmq.message.current - -The total number of messages currently in the queue. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {messages} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of messages in a queue. | Str: ``ready``, ``unacknowledged`` | - -### rabbitmq.message.delivered - -The number of messages delivered to consumers. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {messages} | Sum | Int | Cumulative | true | - -### rabbitmq.message.dropped - -The number of messages dropped as unroutable. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {messages} | Sum | Int | Cumulative | true | - -### rabbitmq.message.published - -The number of messages published to a queue. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {messages} | Sum | Int | Cumulative | true | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/redisreceiver/documentation.md b/receiver/redisreceiver/documentation.md index 4832255a839b..0705b2180b3a 100644 --- a/receiver/redisreceiver/documentation.md +++ b/receiver/redisreceiver/documentation.md @@ -278,261 +278,55 @@ metrics: enabled: true ``` -### redis.clients.blocked - -Number of clients pending on a blocking call - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | false | - -### redis.clients.connected - -Number of client connections (excluding connections from replicas) - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | false | - -### redis.clients.max_input_buffer - -Biggest input buffer among current client connections - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | - -### redis.clients.max_output_buffer - -Longest output list among current client connections - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | - -### redis.commands - -Number of commands processed per second - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {ops}/s | Gauge | Int | - -### redis.commands.processed - -Total number of commands processed by the server - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.connections.received - -Total number of connections accepted by the server - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.connections.rejected +### redis.cmd.calls -Number of connections rejected because of maxclients limit +Total number of calls for a command | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | | Sum | Int | Cumulative | true | -### redis.cpu.time - -System CPU consumed by the Redis server in seconds since server start - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Double | Cumulative | true | - #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | Redis CPU usage state | Str: ``sys``, ``sys_children``, ``sys_main_thread``, ``user``, ``user_children``, ``user_main_thread`` | +| cmd | Redis command name | Any Str | -### redis.db.avg_ttl +### redis.cmd.usec -Average keyspace keys TTL +Total time for all executions of this command -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| db | Redis database identifier | Any Str | - -### redis.db.expires - -Number of keyspace keys with an expiration - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| db | Redis database identifier | Any Str | - -### redis.db.keys - -Number of keyspace keys - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| us | Sum | Int | Cumulative | true | #### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| db | Redis database identifier | Any Str | - -### redis.keys.evicted - -Number of evicted keys due to maxmemory limit - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.keys.expired - -Total number of key expiration events - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.keyspace.hits - -Number of successful lookup of keys in the main dictionary - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.keyspace.misses - -Number of failed lookup of keys in the main dictionary - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | true | - -### redis.latest_fork - -Duration of the latest fork operation in microseconds - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| us | Gauge | Int | - -### redis.memory.fragmentation_ratio - -Ratio between used_memory_rss and used_memory - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Double | - -### redis.memory.lua - -Number of bytes used by the Lua engine - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### redis.memory.peak - -Peak memory consumed by Redis (in bytes) - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### redis.memory.rss - -Number of bytes that Redis allocated as seen by the operating system +| cmd | Redis command name | Any Str | -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | - -### redis.memory.used +### redis.maxmemory -Total number of bytes allocated by Redis using its allocator +The value of the maxmemory configuration directive | Unit | Metric Type | Value Type | | ---- | ----------- | ---------- | | By | Gauge | Int | -### redis.net.input +### redis.role -The total number of bytes read from the network - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### redis.net.output - -The total number of bytes written to the network - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -### redis.rdb.changes_since_last_save - -Number of changes since the last dump +Redis node's role | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | | | Sum | Int | Cumulative | false | -### redis.replication.backlog_first_byte_offset - -The master offset of the replication backlog buffer - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | - -### redis.replication.offset - -The server's current replication offset - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| | Gauge | Int | - -### redis.slaves.connected - -Number of connected replicas - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| | Sum | Int | Cumulative | false | - -### redis.uptime - -Number of seconds since Redis server start +#### Attributes -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | true | +| Name | Description | Values | +| ---- | ----------- | ------ | +| role | Redis node's role | Str: ``replica``, ``primary`` | ## Resource Attributes diff --git a/receiver/riakreceiver/documentation.md b/receiver/riakreceiver/documentation.md index 57a12f9d7a54..7cf2c95850de 100644 --- a/receiver/riakreceiver/documentation.md +++ b/receiver/riakreceiver/documentation.md @@ -84,88 +84,6 @@ The number of operations performed by vnodes on the node. | ---- | ----------- | ------ | | request | The request operation type. | Str: ``put``, ``get`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### riak.memory.limit - -The amount of memory allocated to the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### riak.node.operation.count - -The number of operations performed by the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operation} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| request | The request operation type. | Str: ``put``, ``get`` | - -### riak.node.operation.time.mean - -The mean time between request and response for operations performed by the node over the last minute. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| us | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| request | The request operation type. | Str: ``put``, ``get`` | - -### riak.node.read_repair.count - -The number of read repairs performed by the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {read_repair} | Sum | Int | Cumulative | true | - -### riak.vnode.index.operation.count - -The number of index operations performed by vnodes on the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operation} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| operation | The operation type for index operations. | Str: ``read``, ``write``, ``delete`` | - -### riak.vnode.operation.count - -The number of operations performed by vnodes on the node. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operation} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| request | The request operation type. | Str: ``put``, ``get`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/saphanareceiver/documentation.md b/receiver/saphanareceiver/documentation.md index d36d0250f9cb..b252c2be2538 100644 --- a/receiver/saphanareceiver/documentation.md +++ b/receiver/saphanareceiver/documentation.md @@ -634,638 +634,6 @@ The time spent executing operations. | usage_type | The SAP HANA disk & volume usage type. | Any Str | | type | The type of operation. | Str: ``read``, ``write`` | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### saphana.alert.count - -Number of current alerts. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {alerts} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| rating | The alert rating. | Any Str | - -### saphana.backup.latest - -The age of the latest backup by start time. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - -### saphana.column.memory.used - -The memory used in all columns. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of column store memory. | Str: ``main``, ``delta`` | -| subtype | The subtype of column store memory. | Str: ``data``, ``dict``, ``index``, ``misc`` | - -### saphana.component.memory.used - -The memory used in components. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| component | The SAP HANA component. | Any Str | - -### saphana.connection.count - -The number of current connections. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The connection status. | Str: ``running``, ``idle``, ``queueing`` | - -### saphana.cpu.used - -Total CPU time spent. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of cpu. | Str: ``user``, ``system``, ``io_wait``, ``idle`` | - -### saphana.disk.size.current - -The disk size. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| path | The SAP HANA disk path. | Any Str | -| usage_type | The SAP HANA disk & volume usage type. | Any Str | -| state | The state of the disk storage. | Str: ``used``, ``free`` | - -### saphana.host.memory.current - -The amount of physical memory on the host. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of memory. | Str: ``used``, ``free`` | - -### saphana.host.swap.current - -The amount of swap space on the host. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of swap data. | Str: ``used``, ``free`` | - -### saphana.instance.code_size - -The instance code size, including shared libraries of SAP HANA processes. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### saphana.instance.memory.current - -The size of the memory pool for all SAP HANA processes. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of memory. | Str: ``used``, ``free`` | - -### saphana.instance.memory.shared.allocated - -The shared memory size of SAP HANA processes. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### saphana.instance.memory.used.peak - -The peak memory from the memory pool used by SAP HANA processes since the instance started (this is a sample-based value). - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### saphana.license.expiration.time - -The amount of time remaining before license expiration. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| system | The SAP HANA system. | Any Str | -| product | The SAP HANA product. | Any Str | - -### saphana.license.limit - -The allowed product usage as specified by the license (for example, main memory). - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {licenses} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| system | The SAP HANA system. | Any Str | -| product | The SAP HANA product. | Any Str | - -### saphana.license.peak - -The peak product usage value during last 13 months, measured periodically. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {licenses} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| system | The SAP HANA system. | Any Str | -| product | The SAP HANA product. | Any Str | - -### saphana.network.request.average_time - -The average response time calculated over recent requests - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Double | - -### saphana.network.request.count - -The number of active and pending service requests. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | The state of network request. | Str: ``active``, ``pending`` | - -### saphana.network.request.finished.count - -The number of service requests that have completed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of network request. | Str: ``internal``, ``external`` | - -### saphana.replication.average_time - -The average amount of time consumed replicating a log. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| us | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| primary | The primary SAP HANA host in replication. | Any Str | -| secondary | The secondary SAP HANA host in replication. | Any Str | -| port | The SAP HANA port. | Any Str | -| mode | The replication mode. | Any Str | - -### saphana.replication.backlog.size - -The current replication backlog size. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| primary | The primary SAP HANA host in replication. | Any Str | -| secondary | The secondary SAP HANA host in replication. | Any Str | -| port | The SAP HANA port. | Any Str | -| mode | The replication mode. | Any Str | - -### saphana.replication.backlog.time - -The current replication backlog. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| us | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| primary | The primary SAP HANA host in replication. | Any Str | -| secondary | The secondary SAP HANA host in replication. | Any Str | -| port | The SAP HANA port. | Any Str | -| mode | The replication mode. | Any Str | - -### saphana.row_store.memory.used - -The used memory for all row tables. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The type of row store memory. | Str: ``fixed``, ``variable`` | - -### saphana.schema.memory.used.current - -The memory size for all tables in schema. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| schema | The SAP HANA schema. | Any Str | -| type | The type of schema memory. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | - -### saphana.schema.memory.used.max - -The estimated maximum memory consumption for all fully loaded tables in schema (data for open transactions is not included). - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| schema | The SAP HANA schema. | Any Str | - -### saphana.schema.operation.count - -The number of operations done on all tables in schema. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| schema | The SAP HANA schema. | Any Str | -| type | The type of operation. | Str: ``read``, ``write``, ``merge`` | - -### saphana.schema.record.compressed.count - -The number of entries in main during the last optimize compression run for all tables in schema. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {records} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| schema | The SAP HANA schema. | Any Str | - -### saphana.schema.record.count - -The number of records for all tables in schema. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {records} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| schema | The SAP HANA schema. | Any Str | -| type | The type of schema record. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | - -### saphana.service.code_size - -The service code size, including shared libraries. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.count - -The number of services in a given status. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {services} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The status of services. | Str: ``active``, ``inactive`` | - -### saphana.service.memory.compactors.allocated - -The part of the memory pool that can potentially (if unpinned) be freed during a memory shortage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.memory.compactors.freeable - -The memory that can be freed during a memory shortage. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.memory.effective_limit - -The effective maximum memory pool size, calculated considering the pool sizes of other processes. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.memory.heap.current - -The size of the heap portion of the memory pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | -| state | The state of memory. | Str: ``used``, ``free`` | - -### saphana.service.memory.limit - -The configured maximum memory pool size. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.memory.shared.current - -The size of the shared portion of the memory pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | -| state | The state of memory. | Str: ``used``, ``free`` | - -### saphana.service.memory.used - -The used memory from the operating system perspective. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | -| type | The type of service memory. | Str: ``logical``, ``physical`` | - -### saphana.service.stack_size - -The service stack size. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| service | The SAP HANA service. | Any Str | - -### saphana.service.thread.count - -The number of service threads in a given status. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {threads} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| status | The status of threads. | Str: ``active``, ``inactive`` | - -### saphana.transaction.blocked - -The number of transactions waiting for a lock. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {transactions} | Sum | Int | Cumulative | false | - -### saphana.transaction.count - -The number of transactions. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {transactions} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The transaction type. | Str: ``update``, ``commit``, ``rollback`` | - -### saphana.uptime - -The uptime of the database. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| s | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| system | The SAP HANA system. | Any Str | -| database | The SAP HANA database. | Any Str | - -### saphana.volume.operation.count - -The number of operations executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {operations} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| path | The SAP HANA disk path. | Any Str | -| usage_type | The SAP HANA disk & volume usage type. | Any Str | -| type | The type of operation. | Str: ``read``, ``write`` | - -### saphana.volume.operation.size - -The size of operations executed. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| path | The SAP HANA disk path. | Any Str | -| usage_type | The SAP HANA disk & volume usage type. | Any Str | -| type | The type of operation. | Str: ``read``, ``write`` | - -### saphana.volume.operation.time - -The time spent executing operations. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| ms | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| path | The SAP HANA disk path. | Any Str | -| usage_type | The SAP HANA disk & volume usage type. | Any Str | -| type | The type of operation. | Str: ``read``, ``write`` | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/sqlserverreceiver/documentation.md b/receiver/sqlserverreceiver/documentation.md index 6313bf03516c..1c067d6eec22 100644 --- a/receiver/sqlserverreceiver/documentation.md +++ b/receiver/sqlserverreceiver/documentation.md @@ -178,182 +178,6 @@ Number of users connected to the SQL Server. | ---- | ----------- | ---------- | | {connections} | Gauge | Int | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### sqlserver.batch.request.rate - -Number of batch requests received by SQL Server. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {requests}/s | Gauge | Double | - -### sqlserver.batch.sql_compilation.rate - -Number of SQL compilations needed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {compilations}/s | Gauge | Double | - -### sqlserver.batch.sql_recompilation.rate - -Number of SQL recompilations needed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {compilations}/s | Gauge | Double | - -### sqlserver.lock.wait.rate - -Number of lock requests resulting in a wait. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {requests}/s | Gauge | Double | - -### sqlserver.lock.wait_time.avg - -Average wait time for all lock requests that had to wait. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Double | - -### sqlserver.page.buffer_cache.hit_ratio - -Pages found in the buffer pool without having to read from disk. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### sqlserver.page.checkpoint.flush.rate - -Number of pages flushed by operations requiring dirty pages to be flushed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {pages}/s | Gauge | Double | - -### sqlserver.page.lazy_write.rate - -Number of lazy writes moving dirty pages to disk. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {writes}/s | Gauge | Double | - -### sqlserver.page.life_expectancy - -Time a page will stay in the buffer pool. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| s | Gauge | Int | - -### sqlserver.page.operation.rate - -Number of physical database page operations issued. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {operations}/s | Gauge | Double | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| type | The page operation types. | Str: ``read``, ``write`` | - -### sqlserver.page.split.rate - -Number of pages split as a result of overflowing index pages. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {pages}/s | Gauge | Double | - -### sqlserver.transaction.rate - -Number of transactions started for the database (not including XTP-only transactions). - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {transactions}/s | Gauge | Double | - -### sqlserver.transaction.write.rate - -Number of transactions that wrote to the database and committed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {transactions}/s | Gauge | Double | - -### sqlserver.transaction_log.flush.data.rate - -Total number of log bytes flushed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By/s | Gauge | Double | - -### sqlserver.transaction_log.flush.rate - -Number of log flushes. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {flushes}/s | Gauge | Double | - -### sqlserver.transaction_log.flush.wait.rate - -Number of commits waiting for a transaction log flush. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {commits}/s | Gauge | Double | - -### sqlserver.transaction_log.growth.count - -Total number of transaction log expansions for a database. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {growths} | Sum | Int | Cumulative | true | - -### sqlserver.transaction_log.shrink.count - -Total number of transaction log shrinks for a database. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {shrinks} | Sum | Int | Cumulative | true | - -### sqlserver.transaction_log.usage - -Percent of transaction log space used. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Int | - -### sqlserver.user.connection.count - -Number of users connected to the SQL Server. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {connections} | Gauge | Int | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/vcenterreceiver/documentation.md b/receiver/vcenterreceiver/documentation.md index 0d8276ee6594..c385337ccb5d 100644 --- a/receiver/vcenterreceiver/documentation.md +++ b/receiver/vcenterreceiver/documentation.md @@ -373,377 +373,6 @@ As measured over the most recent 20s interval. | ---- | ----------- | ---------- | ----------------------- | --------- | | {KiBy/s} | Sum | Int | Cumulative | false | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### vcenter.cluster.cpu.effective - -The effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {MHz} | Sum | Int | Cumulative | false | - -### vcenter.cluster.cpu.limit - -The amount of CPU available to the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {MHz} | Sum | Int | Cumulative | false | - -### vcenter.cluster.host.count - -The number of hosts in the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {hosts} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| effective | Whether the host is effective in the vCenter cluster. | Any Bool | - -### vcenter.cluster.memory.effective - -The effective memory of the cluster. This value excludes memory from hosts in maintenance mode or are unresponsive. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### vcenter.cluster.memory.limit - -The available memory of the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### vcenter.cluster.memory.used - -The memory that is currently used by the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### vcenter.cluster.vm.count - -the number of virtual machines in the cluster. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {virtual_machines} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| power_state | Whether the virtual machines are powered on or off. | Str: ``on``, ``off`` | - -### vcenter.datastore.disk.usage - -The amount of space in the datastore. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | - -### vcenter.datastore.disk.utilization - -The utilization of the datastore. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### vcenter.host.cpu.usage - -The amount of CPU in Hz used by the host. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| MHz | Sum | Int | Cumulative | false | - -### vcenter.host.cpu.utilization - -The CPU utilization of the host system. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### vcenter.host.disk.latency.avg - -The latency of operations to the host system's disk. - -This latency is the sum of the device and kernel read and write latencies. Requires Performance Counter level 2 for metric to populate. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of disk latency. | Str: ``read``, ``write`` | - -### vcenter.host.disk.latency.max - -Highest latency value across all disks used by the host. - -As measured over the most recent 20s interval. Requires Performance Level 3. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### vcenter.host.disk.throughput - -Average number of kilobytes read from or written to the disk each second. - -As measured over the most recent 20s interval. Aggregated disk I/O rate. Requires Performance Level 4. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {KiBy/s} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of disk latency. | Str: ``read``, ``write`` | - -### vcenter.host.memory.usage - -The amount of memory the host system is using. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| MiBy | Sum | Int | Cumulative | false | - -### vcenter.host.memory.utilization - -The percentage of the host system's memory capacity that is being utilized. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### vcenter.host.network.packet.count - -The number of packets transmitted and received, as measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets/sec} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | - -### vcenter.host.network.packet.errors - -The summation of packet errors on the host network. - -As measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {errors} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | - -### vcenter.host.network.throughput - -The amount of data that was transmitted or received over the network by the host. - -As measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {KiBy/s} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | - -### vcenter.host.network.usage - -The sum of the data transmitted and received for all the NIC instances of the host. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {KiBy/s} | Sum | Int | Cumulative | false | - -### vcenter.resource_pool.cpu.shares - -The amount of shares of CPU in the resource pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {shares} | Sum | Int | Cumulative | false | - -### vcenter.resource_pool.cpu.usage - -The usage of the CPU used by the resource pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {MHz} | Sum | Int | Cumulative | false | - -### vcenter.resource_pool.memory.shares - -The amount of shares of memory in the resource pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {shares} | Sum | Int | Cumulative | false | - -### vcenter.resource_pool.memory.usage - -The usage of the memory by the resource pool. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| MiBy | Sum | Int | Cumulative | false | - -### vcenter.vm.disk.latency.avg - -The latency of operations to the virtual machine's disk. - -Requires Performance Counter level 2 for metric to populate. As measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of disk latency. | Str: ``read``, ``write`` | -| disk_type | The type of storage device that is being recorded. | Str: ``virtual``, ``physical`` | - -### vcenter.vm.disk.latency.max - -The highest reported total latency (device and kernel times) over an interval of 20 seconds. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### vcenter.vm.disk.throughput - -The throughput of the virtual machine's disk. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By/sec | Sum | Int | Cumulative | false | - -### vcenter.vm.disk.usage - -The amount of storage space used by the virtual machine. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | - -### vcenter.vm.disk.utilization - -The utilization of storage on the virtual machine. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| % | Gauge | Double | - -### vcenter.vm.memory.ballooned - -The amount of memory that is ballooned due to virtualization. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### vcenter.vm.memory.usage - -The amount of memory that is used by the virtual machine. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| MiBy | Sum | Int | Cumulative | false | - -### vcenter.vm.network.packet.count - -The amount of packets that was received or transmitted over the instance's network. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets/sec} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | - -### vcenter.vm.network.throughput - -The amount of data that was transmitted or received over the network of the virtual machine. - -As measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By/sec | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | - -### vcenter.vm.network.usage - -The network utilization combined transmit and receive rates during an interval. - -As measured over the most recent 20s interval. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {KiBy/s} | Sum | Int | Cumulative | false | - ## Resource Attributes | Name | Description | Values | diff --git a/receiver/zookeeperreceiver/documentation.md b/receiver/zookeeperreceiver/documentation.md index 766ded6efb1a..549e9ac9550e 100644 --- a/receiver/zookeeperreceiver/documentation.md +++ b/receiver/zookeeperreceiver/documentation.md @@ -144,148 +144,6 @@ Number of z-nodes that a ZooKeeper server has in its data tree. | ---- | ----------- | ---------- | ----------------------- | --------- | | {znodes} | Sum | Int | Cumulative | false | -## Optional Metrics - -The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: - -```yaml -metrics: - : - enabled: true -``` - -### zookeeper.connection.active - -Number of active clients connected to a ZooKeeper server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {connections} | Sum | Int | Cumulative | false | - -### zookeeper.data_tree.ephemeral_node.count - -Number of ephemeral nodes that a ZooKeeper server has in its data tree. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {nodes} | Sum | Int | Cumulative | false | - -### zookeeper.data_tree.size - -Size of data in bytes that a ZooKeeper server has in its data tree. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -### zookeeper.file_descriptor.limit - -Maximum number of file descriptors that a ZooKeeper server can open. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {file_descriptors} | Gauge | Int | - -### zookeeper.file_descriptor.open - -Number of file descriptors that a ZooKeeper server has open. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {file_descriptors} | Sum | Int | Cumulative | false | - -### zookeeper.follower.count - -The number of followers. Only exposed by the leader. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {followers} | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | State of followers | Str: ``synced``, ``unsynced`` | - -### zookeeper.fsync.exceeded_threshold.count - -Number of times fsync duration has exceeded warning threshold. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {events} | Sum | Int | Cumulative | true | - -### zookeeper.latency.avg - -Average time in milliseconds for requests to be processed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### zookeeper.latency.max - -Maximum time in milliseconds for requests to be processed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### zookeeper.latency.min - -Minimum time in milliseconds for requests to be processed. - -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| ms | Gauge | Int | - -### zookeeper.packet.count - -The number of ZooKeeper packets received or sent by a server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {packets} | Sum | Int | Cumulative | true | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| direction | State of a packet based on io direction. | Str: ``received``, ``sent`` | - -### zookeeper.request.active - -Number of currently executing requests. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {requests} | Sum | Int | Cumulative | false | - -### zookeeper.sync.pending - -The number of pending syncs from the followers. Only exposed by the leader. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {syncs} | Sum | Int | Cumulative | false | - -### zookeeper.watch.count - -Number of watches placed on Z-Nodes on a ZooKeeper server. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {watches} | Sum | Int | Cumulative | false | - -### zookeeper.znode.count - -Number of z-nodes that a ZooKeeper server has in its data tree. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| {znodes} | Sum | Int | Cumulative | false | - ## Resource Attributes | Name | Description | Values |