---
metadata:
- name: generator
content: Diplodoc Platform v5.52.0
alternate:
- https://ydb.tech/docs/en/reference/observability/metrics.md?version=v25.4
- https://ydb.tech/docs/ru/reference/observability/metrics.md?version=v25.4
- href: en/reference/observability/metrics/index.md
type: text/markdown
title: Markdown version
- href: ../../../llms.txt
type: text/markdown
title: llms.txt
sourcePath: en/core/reference/observability/metrics/index.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/en/llms.txt
# Metrics reference
## Resource usage metrics {#resources}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `resources.storage.used_bytes`
`IGAUGE`, bytes | The size of user and service data stored in distributed network storage. `resources.storage.used_bytes` = `resources.storage.table.used_bytes` + `resources.storage.topic.used_bytes`. |
| `resources.storage.table.used_bytes`
`IGAUGE`, bytes | The size of user and service data stored by tables in distributed network storage. Service data includes the data of the primary, [secondary indexes](../../../concepts/glossary.md#secondary-index) and [vector indexes](../../../concepts/glossary.md#vector-index). |
| `resources.storage.topic.used_bytes`
`IGAUGE`, bytes | The size of storage used by topics. This metric sums the `topic.storage_bytes` values of all topics. |
| `resources.storage.limit_bytes`
`IGAUGE`, bytes | A limit on the size of user and service data that a database can store in distributed network storage. |
## API metrics {#api}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `api.grpc.request.bytes`
`RATE`, bytes | The size of queries received by the database in a certain period of time.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.request.dropped_count`
`RATE`, pieces | The number of requests dropped at the transport (gRPC) layer due to an error.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.request.inflight_count`
`IGAUGE`, pieces | The number of requests that a database is simultaneously handling in a certain period of time.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.request.inflight_bytes`
`IGAUGE`, bytes | The size of requests that a database is simultaneously handling in a certain period of time.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.response.bytes`
`RATE`, bytes | The size of responses sent by the database in a certain period of time.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.response.count`
`RATE`, pieces | The number of responses sent by the database in a certain period of time.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`.
- _status_ is the request execution status. See a more detailed description of statuses under [Error Handling](../../../reference/ydb-sdk/error_handling.md). |
| `api.grpc.response.dropped_count`
`RATE`, pieces | The number of responses dropped at the transport (gRPC) layer due to an error.
Labels:
- _api_service_: The name of the gRPC API service, such as `table`.
- _method_: The name of a gRPC API service method, such as `ExecuteDataQuery`. |
| `api.grpc.response.issues`
`RATE`, pieces | The number of errors of a certain type arising in the execution of a request over a certain period of time.
Tags:
- _issue_type_ is the error type wth the only value being `optimistic_locks_invalidation`. For more on lock invalidation, review [Transactions and requests to YDB](../../../concepts/transactions.md). |
## Session metrics {#sessions}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `table.session.active_count`
`IGAUGE`, pieces | The number of sessions started by clients and running at a given time. |
| `table.session.closed_by_idle_count`
`RATE`, pieces | The number of sessions closed by the DB server in a certain period of time due to exceeding the lifetime allowed for an idle session. |
## Transaction processing metrics {#transactions}
You can analyze a transaction's execution time using a histogram counter. The intervals are set in milliseconds. The chart shows the number of transactions whose duration falls within a certain time interval.
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `table.transaction.total_duration_milliseconds`
`HIST_RATE`, pieces | The number of transactions with a certain duration on the server and client. The duration of a transaction is counted from the point of its explicit or implicit start to committing changes or its rollback. Includes the transaction processing time on the server and the time on the client between sending different requests within the same transaction.
Labels:
- _tx_kind_: The transaction type, possible values are `read_only`, `read_write`, `write_only`, and `pure`. |
| `table.transaction.server_duration_milliseconds`
`HIST_RATE`, pieces | The number of transactions with a certain duration on the server. The duration is the time of executing requests within a transaction on the server. Does not include the waiting time on the client between sending separate requests within a single transaction.
Labels:
-_tx_kind_: The transaction type, possible values are`read_only`, `read_write`, `write_only`, and `pure`. |
| `table.transaction.client_duration_milliseconds`
`HIST_RATE`, pieces | The number of transactions with a certain duration on the client. The duration is the waiting time on the client between sending individual requests within a single transaction. Does not include the time of executing requests on the server.
Labels:
- _tx_kind_: The transaction type, possible values are `read_only`, `read_write`, `write_only`, and `pure`. |
## Query processing metrics {#queries}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `table.query.request.bytes`
`RATE`, bytes | The size of YQL query text and parameter values to queries received by the database in a certain period of time. |
| `table.query.request.parameters_bytes`
`RATE`, bytes | The parameter size to the queries received by the database in a certain period of time. |
| `table.query.response.bytes`
`RATE`, bytes | The size of responses sent by the database in a certain period of time. |
| `table.query.compilation.latency_milliseconds`
`HIST_RATE`, pieces | Histogram counter. The intervals are set in milliseconds. Shows the number of successfully executed compilation queries whose duration falls within a certain time interval. |
| `table.query.compilation.active_count`
`IGAUGE`, pieces | The number of active compilations at a given time. |
| `table.query.compilation.count`
`RATE`, pieces | The number of compilations that completed successfully in a certain time period. |
| `table.query.compilation.errors`
`RATE`, pieces | The number of compilations that failed in a certain period of time. |
| `table.query.compilation.cache_hits`
`RATE`, pieces | The number of queries in a certain period of time, which didn't require any compilation, because there was an existing plan in the cache of prepared queries. |
| `table.query.compilation.cache_misses`
`RATE`, pieces | The number of queries in a certain period of time that required query compilation. |
| `table.query.execution.latency_milliseconds`
`HIST_RATE`, pieces | Histogram counter. The intervals are set in milliseconds. Shows the number of queries whose execution time falls within a certain interval. |
## Row-oriented table partition metrics {#datashards}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `table.datashard.row_count`
`GAUGE`, pieces | The number of rows in all row-oriented tables in the database. |
| `table.datashard.size_bytes`
`GAUGE`, bytes | The size of data in all row-oriented tables in the database. |
| `table.datashard.used_core_percents`
`HIST_GAUGE`, % | Histogram counter. The intervals are set as a percentage. Shows the number of row-oriented table partitions using computing resources in the ratio that falls within a certain interval. |
| `table.datashard.read.rows`
`RATE`, pieces | The number of rows that are read by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.read.bytes`
`RATE`, bytes | The size of data that is read by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.write.rows`
`RATE`, pieces | The number of rows that are written by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.write.bytes`
`RATE`, bytes | The size of data that is written by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.scan.rows`
`RATE`, pieces | The number of rows that are read through `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.scan.bytes`
`RATE`, bytes | The size of data that is read through `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.bulk_upsert.rows`
`RATE`, pieces | The number of rows that are added through a `BulkUpsert` gRPC API call to all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.bulk_upsert.bytes`
`RATE`, bytes | The size of data that is added through a `BulkUpsert` gRPC API call to all partitions of all row-oriented tables in the database in a certain period of time. |
| `table.datashard.erase.rows`
`RATE`, pieces | The number of rows deleted from row-oriented tables in the database in a certain period of time. |
| `table.datashard.erase.bytes`
`RATE`, bytes | The size of data deleted from row-oriented tables in the database in a certain period of time. |
| `table.datashard.cache_hit.bytes`
`RATE`, bytes | The total amount of data successfully retrieved from memory (cache), indicating efficient cache utilization in serving frequently accessed data without accessing distributed storage. |
| `table.datashard.cache_miss.bytes`
`RATE`, bytes | The total amount of data that was requested but not found in memory (cache) and was read from distributed storage, highlighting potential areas for cache optimization. |
## Column-oriented table partition metrics {#columnshards}
| Metric name
Type, units of measurement | Description
Labels |
| ----- | ----- |
| `table.columnshard.write.rows`
`RATE`, pieces | The number of rows that are written by all partitions of all column-oriented tables in the database in a certain period of time. |
| `table.columnshard.write.bytes`
`RATE`, bytes | The size of data that is written by all partitions of all column-oriented tables in the database in a certain period of time. |
| `table.columnshard.scan.rows`
`RATE`, pieces | The number of rows that are read through `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all column-oriented tables in the database in a certain period of time. |
| `table.columnshard.scan.bytes`
`RATE`, bytes | The size of data that is read through `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all column-oriented tables in the database in a certain period of time. |
| `table.columnshard.bulk_upsert.rows`
`RATE`, pieces | The number of rows that are added through a `BulkUpsert` gRPC API call to all partitions of all column-oriented tables in the database in a certain period of time. |
| `table.columnshard.bulk_upsert.bytes`
`RATE`, bytes | The size of data that is added through a `BulkUpsert` gRPC API call to all partitions of all column-oriented tables in the database in a certain period of time. |
## Resource usage metrics (for Dedicated mode only) {#ydb_dedicated_resources}
| Metric name
Type
units of measurement | Description
Labels |
| ----- | ----- |
| `resources.cpu.used_core_percents`
`RATE`, % | CPU usage. If the value is `100`, one of the cores is being used for 100%. The value may be greater than `100` for multi-core configurations.
Labels:
- _pool_: The computing pool, possible values are `user`, `system`, `batch`, `io`, and `ic`. |
| `resources.cpu.limit_core_percents`
`IGAUGE`, % | The percentage of CPU available to a database. For example, for a database that has three nodes with four cores in `pool=user` per node, the value of this metric will be `1200`.
Labels:
- _pool_: The computing pool, possible values are `user`, `system`, `batch`, `io`, and `ic`. |
| `resources.memory.used_bytes`
`IGAUGE`, bytes | The amount of RAM used by the database nodes. |
| `resources.memory.limit_bytes`
`IGAUGE`, bytes | RAM available to the database nodes. |
## Query processing metrics (for Dedicated mode only) {#ydb_dedicated_queries}
| Metric name
Type
units of measurement | Description
Labels |
| ----- | ----- |
| `table.query.compilation.cache_evictions`
`RATE`, pieces | The number of queries evicted from the cache of prepared queries in a certain period of time. |
| `table.query.compilation.cache_size_bytes`
`IGAUGE`, bytes | The size of the cache of prepared queries. |
| `table.query.compilation.cached_query_count`
`IGAUGE`, pieces | The size of the cache of prepared queries. |
## Topic metrics {#topics}
| Metric name
Type
units of measurement | Description
Labels |
| ----- | ----- |
|`topic.producers_count`
`GAUGE`, pieces | The number of unique topic [producers](../../../concepts/topic#producer-id).
Labels:
- _topic_ – the name of the topic. |
| `topic.storage_bytes`
`GAUGE`, bytes | The size of the topic in bytes.
Labels:
- _topic_ - the name of the topic. |
| `topic.read.bytes`
`RATE`, bytes | The number of bytes read by the consumer from the topic.
Labels:
- _topic_ – the name of the topic.
- _consumer_ – the name of the consumer. |
| `topic.read.messages`
`RATE`, pieces | The number of messages read by the consumer from the topic.
Labels:
- _topic_ – the name of the topic.
- _consumer_ – the name of the consumer. |
| `topic.read.lag_messages`
`RATE`, pieces | The number of unread messages by the consumer in the topic.
Labels:
- _topic_ – the name of the topic.
- _consumer_ – the name of the consumer. |
| `topic.read.lag_milliseconds`
`HIST_RATE`, pieces | A histogram counter. The intervals are specified in milliseconds. It shows the number of messages where the difference between the reading time and the message creation time falls within the specified interval.
Labels:
- _topic_ – the name of the topic.
- _consumer_ – the name of the consumer. |
| `topic.write.bytes`
`RATE`, bytes | The size of the written data.
Labels:
- _topic_ – the name of the topic. |
| `topic.write.uncommited_bytes`
`RATE`, bytes | The size of data written as part of ongoing transactions.
Labels:
- _topic_ — the name of the topic. |
| `topic.write.uncompressed_bytes`
`RATE`, bytes | The size of uncompressed written data.
Метки:
- _topic_ – the name of the topic. |
| `topic.write.messages`
`RATE`, pieces | The number of written messages.
Labels:
- _topic_ – the name of the topic. |
| `topic.write.uncommitted_messages`
`RATE`, pieces | The number of messages written as part of ongoing transactions.
Labels:
- _topic_ — the name of the topic. |
| `topic.write.message_size_bytes`
`HIST_RATE`, pieces | A histogram counter. The intervals are specified in bytes. It shows the number of messages which size falls within the boundaries of the interval.
Labels:
- _topic_ – the name of the topic. |
| `topic.write.lag_milliseconds`
`HIST_RATE`, pieces | A histogram counter. The intervals are specified in milliseconds. It shows the number of messages where the difference between the write time and the message creation time falls within the specified interval.
Labels:
- _topic_ – the name of the topic. |