Skip to content

Commit db528be

Browse files
authored
[DOC-779] Added metrics collection level (#28677)
* added metrics collection level * typo fix * changes from review * updtaed table * minor edits from review
1 parent 0546a66 commit db528be

File tree

10 files changed

+114
-26
lines changed

10 files changed

+114
-26
lines changed

docs/content/preview/yugabyte-platform/administer-yugabyte-platform/manage-runtime-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ YugabyteDB Anywhere has a runtime configuration mechanism that is fully compatib
2222

2323
Currently, the scopes can be categorized as follows:
2424

25-
| Scope | Description | User Access |
25+
| Scope | Description |
2626
|:--- |:--- | :--- |
27-
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. | Super Admin |
28-
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope.| Super&nbsp;Admin,<br>Admin |
29-
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
30-
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
27+
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. Only the Super Admin can set global runtime configuration settings. |
28+
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope. |
29+
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
30+
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
3131

3232
For more details about the flags and their scopes, refer to the [list of supported runtime configuration flags](https://github.com/yugabyte/yugabyte-db/blob/master/managed/RUNTIME-FLAGS.md)
3333

docs/content/preview/yugabyte-platform/alerts-monitoring/anywhere-metrics.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,23 @@ label_replace(
4545

4646
For more information, refer to [Querying Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation.
4747

48+
## Metrics collection level
49+
50+
The metrics collection level setting controls how many database metrics are collected and stored. It helps balance system performance with monitoring needs, so that you can optimize resource usage based on your specific observability requirements.
51+
52+
Set the metrics collection level by using the **Metrics Collection Level** Universe Runtime Configuration option (config key `yb.metrics.collection_level`). Refer to [Manage runtime configuration settings](../../../yugabyte-platform/administer-yugabyte-platform/manage-runtime-config/).
53+
54+
You can set the collection level to the following:
55+
56+
| Level | Description |
57+
|:-------|:---------|
58+
| ALL | Collects all metrics from the database. Not recommended for large databases with a lot of tables, as it can overload the YugabyteDB Anywhere Prometheus instance and cause Out of Memory (OOM) errors on the node where YugabyteDB Anywhere is installed. |
59+
| NORMAL (default) | Collects all server-level metrics, and essential table-level metrics (required for YugabyteDB Anywhere UI and alerts). |
60+
| MINIMAL | Collects limited list of server-level metrics (required for YugabyteDB Anywhere UI and alerts), and very limited table-level metrics (required for alerts and table size display). |
61+
| OFF | Disables metric collection. |
62+
63+
The collection level directly affects what data appears in monitoring interfaces. With NORMAL level, all UI components display full metrics. However, when MINIMAL is configured, most per-table monitoring screens display "No Data" messages, though table size information and essential alerts continue functioning. This provides a way to reduce monitoring overhead while maintaining core operational visibility.
64+
4865
## Filter metrics
4966

5067
You can display metrics based on different criteria:
@@ -135,7 +152,7 @@ Resource metrics should be considered on a per-node basis.
135152
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | --------------------------------- |
136153
| Total YSQL Ops / sec | The number of various transaction control operations, such as BEGIN, COMMIT, ROLLBACK, as well as other operations through the YSQL API. | This metric is informational and should not be subject to alerting. You may consider this information while examining alerts on other metrics. | ![Total YSQL Ops / sec](/images/yp/metrics101.png) |
137154
| YSQL Op Latency (Avg) | The average time taken by various transaction control operations, such as BEGIN, COMMIT, ROLLBACK, as well as other operations through the YSQL API. | This metric is informational and should not be subject to alerting. You may consider this information while examining alerts on other metrics. | ![YSQL Op Latency (Avg)](/images/yp/metrics102.png) |
138-
| Catalog Cache Misses | During YSQL query processing, system catalog (pg_catalog) tables that live on the YB-Master are cached on the local YSQL backend. This metric counts the number of YSQL catalog cache misses, where the data had to be fetched from the YB-Master. Also broken down by pg_catalog table that triggered the misses. | This metric is informational and should not be subject to alerting. You may consider this information while examining alerts on other metrics. | ![Catalog Cache Misses](/images/yp/metrics114.png)
155+
| Catalog Cache Misses | During YSQL query processing, system catalog (pg_catalog) tables that live on the YB-Master are cached on the local YSQL backend. This metric counts the number of YSQL catalog cache misses, where the data had to be fetched from the YB-Master. Also broken down by pg_catalog table that triggered the misses. | This metric is informational and should not be subject to alerting. You may consider this information while examining alerts on other metrics. | ![Catalog Cache Misses](/images/yp/metrics114.png)
139156

140157
### YCQL advanced
141158

docs/content/stable/yugabyte-platform/administer-yugabyte-platform/manage-runtime-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ YugabyteDB Anywhere has a runtime configuration mechanism that is fully compatib
2222

2323
Currently, the scopes can be categorized as follows:
2424

25-
| Scope | Description | User Access |
25+
| Scope | Description |
2626
|:--- |:--- | :--- |
27-
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. | Super Admin |
28-
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope.| Super&nbsp;Admin,<br>Admin |
29-
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
30-
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
27+
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. Only the Super Admin can set global runtime configuration settings. |
28+
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope. |
29+
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
30+
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
3131

3232
For more details about the flags and their scopes, refer to the [list of supported runtime configuration flags](https://github.com/yugabyte/yugabyte-db/blob/master/managed/RUNTIME-FLAGS.md)
3333

docs/content/stable/yugabyte-platform/alerts-monitoring/anywhere-metrics.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,24 @@ label_replace(
4545

4646
For more information, refer to [Querying Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation.
4747

48+
## Metrics collection level
49+
50+
The metrics collection level setting controls how many database metrics are collected and stored. It helps balance system performance with monitoring needs, so that you can optimize resource usage based on your specific observability requirements.
51+
52+
Set the metrics collection level by using the **Metrics Collection Level** Universe Runtime Configuration option (config key `yb.metrics.collection_level`). Refer to [Manage runtime configuration settings](../../../yugabyte-platform/administer-yugabyte-platform/manage-runtime-config/).
53+
54+
You can set the collection level to the following:
55+
56+
| Level | Description |
57+
|:-------|:---------|
58+
| ALL | Collects all metrics from the database. Not recommended for large databases with a lot of tables, as it can overload the YugabyteDB Anywhere Prometheus instance and cause Out of Memory (OOM) errors on the node where YugabyteDB Anywhere is installed. |
59+
| NORMAL (default) | Collects all server-level metrics, and essential table-level metrics (required for YugabyteDB Anywhere UI and alerts). |
60+
| MINIMAL | Collects limited list of server-level metrics (required for YugabyteDB Anywhere UI and alerts), and very limited table-level metrics (required for alerts and table size display). |
61+
| OFF | Disables metric collection. |
62+
| TABLE_OFF | Collects only server-level metrics. |
63+
64+
The collection level directly affects what data appears in monitoring interfaces. With NORMAL level, all UI components display full metrics. However, when MINIMAL is configured, most per-table monitoring screens display "No Data" messages, though table size information and essential alerts continue functioning. This provides a way to reduce monitoring overhead while maintaining core operational visibility.
65+
4866
## Filter metrics
4967

5068
You can display metrics based on different criteria:

docs/content/v2.20/yugabyte-platform/administer-yugabyte-platform/manage-runtime-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ YugabyteDB Anywhere has a runtime configuration mechanism that is fully compatib
2222

2323
Currently, the scopes can be categorized as follows:
2424

25-
| Scope | Description | User Access |
25+
| Scope | Description |
2626
|:--- |:--- | :--- |
27-
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. | Super Admin |
28-
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope.| Super&nbsp;Admin,<br>Admin |
29-
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
30-
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
27+
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. Only the Super Admin can set global runtime configuration settings. |
28+
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope. |
29+
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
30+
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
3131

3232
For more details about the flags and their scopes, refer to the [list of supported runtime configuration flags](https://github.com/yugabyte/yugabyte-db/blob/master/managed/RUNTIME-FLAGS.md)
3333

docs/content/v2.20/yugabyte-platform/alerts-monitoring/anywhere-metrics.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,23 @@ label_replace(
4343

4444
For more information, refer to [Querying Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation.
4545

46+
## Metrics collection level
47+
48+
The metrics collection level setting controls how many database metrics are collected and stored. It helps balance system performance with monitoring needs, so that you can optimize resource usage based on your specific observability requirements.
49+
50+
Set the metrics collection level by using the **Metrics Collection Level** Universe Runtime Configuration option (config key `yb.metrics.collection_level`). Refer to [Manage runtime configuration settings](../../../yugabyte-platform/administer-yugabyte-platform/manage-runtime-config/).
51+
52+
You can set the collection level to the following:
53+
54+
| Level | Description |
55+
|:-------|:---------|
56+
| ALL | Collects all metrics from the database. Not recommended for large databases with a lot of tables, as it can overload the YugabyteDB Anywhere Prometheus instance and cause Out of Memory (OOM) errors on the node where YugabyteDB Anywhere is installed. |
57+
| NORMAL (default) | Collects all server-level metrics, and essential table-level metrics (required for YugabyteDB Anywhere UI and alerts). |
58+
| MINIMAL | Collects limited list of server-level metrics (required for YugabyteDB Anywhere UI and alerts), and very limited table-level metrics (required for alerts and table size display). |
59+
| OFF | Disables metric collection. |
60+
61+
The collection level directly affects what data appears in monitoring interfaces. With NORMAL level, all UI components display full metrics. However, when MINIMAL is configured, most per-table monitoring screens display "No Data" messages, though table size information and essential alerts continue functioning. This provides a way to reduce monitoring overhead while maintaining core operational visibility.
62+
4663
## Filter metrics
4764

4865
You can display metrics based on different criteria:

docs/content/v2024.1/yugabyte-platform/administer-yugabyte-platform/manage-runtime-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ YugabyteDB Anywhere has a runtime configuration mechanism that is fully compatib
2222

2323
Currently, the scopes can be categorized as follows:
2424

25-
| Scope | Description | User Access |
25+
| Scope | Description |
2626
|:--- |:--- | :--- |
27-
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. | Super Admin |
28-
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope.| Super&nbsp;Admin,<br>Admin |
29-
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
30-
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
27+
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. Only the Super Admin can set global runtime configuration settings. |
28+
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope. |
29+
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
30+
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
3131

3232
For more details about the flags and their scopes, refer to the [list of supported runtime configuration flags](https://github.com/yugabyte/yugabyte-db/blob/master/managed/RUNTIME-FLAGS.md)
3333

docs/content/v2024.1/yugabyte-platform/alerts-monitoring/anywhere-metrics.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,24 @@ label_replace(
4343

4444
For more information, refer to [Querying Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/) in the Prometheus documentation.
4545

46+
## Metrics collection level
47+
48+
The metrics collection level setting controls how many database metrics are collected and stored. It helps balance system performance with monitoring needs, so that you can optimize resource usage based on your specific observability requirements.
49+
50+
Set the metrics collection level by using the **Metrics Collection Level** Universe Runtime Configuration option (config key `yb.metrics.collection_level`). Refer to [Manage runtime configuration settings](../../../yugabyte-platform/administer-yugabyte-platform/manage-runtime-config/).
51+
52+
You can set the collection level to the following:
53+
54+
| Level | Description |
55+
|:-------|:---------|
56+
| ALL | Collects all metrics from the database. Not recommended for large databases with a lot of tables, as it can overload the YugabyteDB Anywhere Prometheus instance and cause Out of Memory (OOM) errors on the node where YugabyteDB Anywhere is installed. |
57+
| NORMAL (default) | Collects all server-level metrics, and essential table-level metrics (required for YugabyteDB Anywhere UI and alerts). |
58+
| MINIMAL | Collects limited list of server-level metrics (required for YugabyteDB Anywhere UI and alerts), and very limited table-level metrics (required for alerts and table size display). |
59+
| OFF | Disables metric collection. |
60+
| TABLE_OFF | Collects only server-level metrics. |
61+
62+
The collection level directly affects what data appears in monitoring interfaces. With NORMAL level, all UI components display full metrics. However, when MINIMAL is configured, most per-table monitoring screens display "No Data" messages, though table size information and essential alerts continue functioning. This provides a way to reduce monitoring overhead while maintaining core operational visibility.
63+
4664
## Filter metrics
4765

4866
You can display metrics based on different criteria:

docs/content/v2024.2/yugabyte-platform/administer-yugabyte-platform/manage-runtime-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ YugabyteDB Anywhere has a runtime configuration mechanism that is fully compatib
2222

2323
Currently, the scopes can be categorized as follows:
2424

25-
| Scope | Description | User Access |
25+
| Scope | Description |
2626
|:--- |:--- | :--- |
27-
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. | Super Admin |
28-
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope.| Super&nbsp;Admin,<br>Admin |
29-
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
30-
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. | Super Admin,<br>Admin |
27+
| Global | Applies to the entire platform, persists across installs and any value defined in this scope overrides the defaults. Only the Super Admin can set global runtime configuration settings. |
28+
| Customer | Applies to a specific customer, persists across installs and any value defined in this scope overrides defaults in Global scope. |
29+
| Provider | Applies to a specific provider, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
30+
| Universe | Applies to a specific universe, persists across installs and any value defined in this scope overrides defaults in Customer scope. |
3131

3232
For more details about the flags and their scopes, refer to the [list of supported runtime configuration flags](https://github.com/yugabyte/yugabyte-db/blob/master/managed/RUNTIME-FLAGS.md)
3333

0 commit comments

Comments
 (0)