Yandex Monitoring metric reference

Written by

Yandex Cloud

Improved by

Max Z.

Updated at November 21, 2024

DB metrics
Resource usage metrics
API metrics
Session metrics
Transaction processing metrics
Query processing metrics
Table partition metrics (DataShards)
Table partition metrics (ColumnShards)
Resource usage metrics (for Dedicated mode only)
Query processing metrics (for Dedicated mode only)

This section describes Managed Service for YDB metrics delivered to Monitoring.

The name of the metric is written to the name label.

DB metrics

Metric name Type, units	Description Labels
`database_size` `DGAUGE`, bytes	Database size

Resource usage metrics

Metric name Type, units	Description Labels
`resources.storage.limit_bytes` `IGAUGE`, bytes	Limit on the size of user and service data that a database can store in distributed network storage.
`resources.storage.topic.used_bytes` `DGAUGE`, bytes	Topic storage size in use
`resources.storage.used_bytes` `IGAUGE`, bytes	Size of user and service data stored in the distributed network storage. Housekeeping data include the data of the primary and secondary indexes.
`resources.stream.limit_shards` `DGAUGE`, number	Limit on the number of shards per stream
`resources.stream.storage.limit_bytes` `DGAUGE`, bytes	Stream storage size limit
`resources.stream.storage.reserved_bytes` `DGAUGE`, bytes	Reserved stream storage size
`resources.stream.throughput.limit_bytes_per_second` `DGAUGE`, bytes per second	Stream throughput limit
`resources.stream.used_shards` `DGAUGE`, number	Number of shards used by the stream

API metrics

Metric name Type, units	Description Labels
`api.grpc.request.bytes` `RATE`, bytes	Size of queries received by the database over a certain period of time. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.request.count` `RATE`, number	Total number of DB queries. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.request.dropped_count` `RATE`, number	Number of queries dropped at the transport (gRPC) layer due to an error. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.request.inflight_bytes` `IGAUGE`, bytes	Size of queries concurrently handled by the database over a certain period of time. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.request.inflight_count` `IGAUGE`, number	Number of queries concurrently handled by the database over a certain period of time. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.response.bytes` `RATE`, bytes	Size of responses sent by the database over a certain period of time. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.response.count` `RATE`, number	Number of responses sent by the database over a certain period of time. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`. `status`: Query execution status. For a more detailed description of statuses, see Error Handling.
`api.grpc.response.dropped_count` `RATE`, number	Number of responses dropped at the transport (gRPC) layer due to an error. Labels: `api_service`: gRPC API service name, e.g., `table`. `method`: gRPC API service method name, e.g., `ExecuteDataQuery`.
`api.grpc.response.issues` `RATE`, number	Number of errors of a certain type, which occurred when executing queries during a certain period of time. Labels: `issue_type`: Error type; the only value is `optimistic_locks_invalidation`. For more information about lock invalidation, see YDB transactions and queries.
`api.request.completed_per_second` `DGAUGE`, requests/s	API request completion rate
`api.request.latency_milliseconds` `IGAUGE`, ms	API latency
`api.request.latency_milliseconds_count` `COUNTER`, request count	Total number of API requests for which latency was measured
`api.request.latency_milliseconds_sum` `COUNTER`, ms	Overall API latency
`api.request.size_bytes_per_second` `DGAUGE`, bytes per second	API request processing rate
`api.response.size_bytes_per_second` `DGAUGE`, bytes per second	API response processing rate
`api.units.consumed_by_method_per_second` `DGAUGE`, units per second	Rate of resource consumption by a specific API method
`api.units.consumed_per_second` `DGAUGE`, units per second	Overall rate of resource consumption by API methods

Session metrics

Metric name Type, units	Description Labels
`table.session.active_count` `IGAUGE`, number	Number of sessions run by clients at the moment
`table.session.closed_by_idle_count` `RATE`, number	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

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	Description Labels
`table.transaction.client_duration_milliseconds` `HIST_RATE`, number	Number of transactions of a certain duration on the client. The duration is the waiting time on the client between sending individual requests within a single transaction. It does not include the time of executing requests on the server. Labels: `tx_kind`: Transaction type, possible values are `read_only`, `read_write`, `write_only`, or `pure`.
`table.transaction.server_duration_milliseconds` `HIST_RATE`, number	Number of transactions of a certain duration on the server. The duration is the time of executing requests within a transaction on the server. It does not include the waiting time on the client between sending separate requests within a single transaction. Labels: `tx_kind`: Transaction type, possible values are `read_only`, `read_write`, `write_only`, or `pure`.
`table.transaction.total_duration_milliseconds` `HIST_RATE`, number	Number of transactions of 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. It 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`: Transaction type, possible values are `read_only`, `read_write`, `write_only`, or `pure`.

Query processing metrics

Metric name Type, units	Description Labels
`table.query.compilation.latency_milliseconds` `HIST_RATE`, number	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`, number	Number of active compilations at the moment
`table.query.compilation.count` `RATE`, number	Number of compilations completed successfully over a certain time period
`table.query.compilation.error_count` `RATE`, number	Number of compilations failed over a certain period of time
`table.query.compilation.cache_hits` `RATE`, number	Number of queries over a certain period of time, which did not require any compilation, because there was an existing plan in the cache of prepared queries
`table.query.compilation.cache_misses` `RATE`, number	Number of queries over a certain period of time that required query compilation
`table.query.execution.latency_milliseconds` `HIST_RATE`, number	Histogram counter. The intervals are set in milliseconds. Shows the number of queries whose execution time falls within a certain interval.
`table.query.request.bytes` `RATE`, bytes	Size of YQL query text and parameter values to queries received by the database over a certain period of time
`table.query.request.parameters_bytes` `RATE`, bytes	Parameter size to queries received by the database over a certain period of time
`table.query.response.bytes` `RATE`, bytes	Size of responses sent by the database over a certain period of time

Table partition metrics (DataShards)

Metric name Type, units	Description Labels
`table.datashard.bulk_upsert.bytes` `RATE`, bytes	Size of data added through the `BulkUpsert` gRPC API call to all partitions of all DB tables over a certain period of time
`table.datashard.bulk_upsert.rows` `RATE`, number	Number of rows added through the `BulkUpsert` gRPC API call to all partitions of all DB tables over a certain period of time
`table.datashard.erase.bytes` `RATE`, bytes	Size of data deleted from the database over a certain period of time
`table.datashard.erase.rows` `RATE`, number	Number of rows deleted from the database over a certain period of time
`table.datashard.read.bytes` `RATE`, bytes	Size of data read by all partitions of all DB tables over a certain period of time
`table.datashard.read.rows` `RATE`, number	Number of rows read by all partitions of all DB tables over a certain period of time
`table.datashard.row_count` `GAUGE`, number	Number of rows in DB tables
`table.datashard.scan.bytes` `RATE`, bytes	Size of data read through the `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all DB tables over a certain period of time
`table.datashard.scan.rows` `RATE`, number	Number of rows read through the `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all DB tables over a certain period of time
`table.datashard.size_bytes` `GAUGE`, bytes	Size of data in DB tables
`table.datashard.used_core_percents` `HIST_GAUGE`, %	Histogram counter. The intervals are set as a percentage. Shows the number of table partitions using computing resources in the ratio that falls within a certain interval.
`table.datashard.write.rows` `RATE`, number	Number of rows written by all partitions of all DB tables over a certain period of time
`table.datashard.write.bytes` `RATE`, bytes	Size of data written by all partitions of all DB tables over a certain period of time

Table partition metrics (ColumnShards)

Metric name Type, units	Description Labels
`table.columnshard.bulk_upsert.bytes` `RATE`, bytes per second	Size of data added through the `BulkUpsert` gRPC API call to all partitions of all DB tables over a certain period of time
`table.columnshard.bulk_upsert.rows` `RATE`, rows per second	Number of rows added through the `BulkUpsert` gRPC API call to all partitions of all DB tables over a certain period of time
`table.columnshard.scan.bytes` `RATE`, bytes per second	Size of data read through the `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all DB tables over a certain period of time
`table.columnshard.scan.rows` `RATE`, rows per second	Number of rows read through the `StreamExecuteScanQuery` or `StreamReadTable` gRPC API calls by all partitions of all DB tables over a certain period of time

Resource usage metrics (for Dedicated mode only)

Metric name Type units	Description Labels
`resources.cpu.limit_core_percents` `IGAUGE`, %	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`: Computing pool, possible values are `user`, `system`, `batch`, `io`, or `ic`.
`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`: Computing pool, possible values are `user`, `system`, `batch`, `io`, or `ic`.
`resources.memory.limit_bytes` `IGAUGE`, bytes	RAM available to the database nodes
`resources.memory.used_bytes` `IGAUGE`, bytes	Amount of RAM used by the database nodes

Query processing metrics (for Dedicated mode only)

Metric name Type units	Description Labels
`table.query.compilation.cache_evictions` `RATE`, number	The number of queries evicted from the cache of prepared queries over a period.
`table.query.compilation.cache_size_bytes` `IGAUGE`, bytes	Size of the cache of prepared queries
`table.query.compilation.cached_query_count` `IGAUGE`, number	Size of the cache of prepared queries

Yandex Monitoring metric reference

DB metricsDB metrics

Resource usage metricsResource usage metrics

API metricsAPI metrics

Session metricsSession metrics

Transaction processing metricsTransaction processing metrics

Query processing metricsQuery processing metrics

Table partition metrics (DataShards)Table partition metrics (DataShards)

Table partition metrics (ColumnShards)Table partition metrics (ColumnShards)

Resource usage metrics (for Dedicated mode only)Resource usage metrics (for Dedicated mode only)

Query processing metrics (for Dedicated mode only)Query processing metrics (for Dedicated mode only)

Was the article helpful?