From abb5818822748a71b6e22fe0fd8f367755cf4762 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Thu, 30 Oct 2025 16:56:38 -0400 Subject: [PATCH] Remove instructions for disabling TS data Fixes DOC-11184 NB. These changes are backported to supported versions v23.2+ --- src/current/v23.2/cluster-setup-troubleshooting.md | 2 +- src/current/v23.2/kibana.md | 6 ------ .../v23.2/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v23.2/monitoring-and-alerting.md | 8 +------- src/current/v23.2/operational-faqs.md | 10 +++++----- src/current/v23.2/ui-overview-dashboard.md | 2 +- src/current/v24.1/cluster-setup-troubleshooting.md | 2 +- src/current/v24.1/kibana.md | 6 ------ .../v24.1/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v24.1/monitoring-and-alerting.md | 8 +------- src/current/v24.1/operational-faqs.md | 10 +++++----- src/current/v24.1/ui-overview-dashboard.md | 2 +- src/current/v24.3/cluster-setup-troubleshooting.md | 2 +- src/current/v24.3/kibana.md | 6 ------ .../v24.3/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v24.3/monitoring-and-alerting.md | 8 +------- src/current/v24.3/operational-faqs.md | 10 +++++----- src/current/v24.3/ui-overview-dashboard.md | 2 +- src/current/v25.2/cluster-setup-troubleshooting.md | 2 +- src/current/v25.2/kibana.md | 6 ------ .../v25.2/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v25.2/monitoring-and-alerting.md | 8 +------- src/current/v25.2/operational-faqs.md | 10 +++++----- src/current/v25.2/ui-overview-dashboard.md | 2 +- src/current/v25.3/cluster-setup-troubleshooting.md | 2 +- src/current/v25.3/kibana.md | 6 ------ .../v25.3/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v25.3/monitoring-and-alerting.md | 8 +------- src/current/v25.3/operational-faqs.md | 10 +++++----- src/current/v25.3/prometheus-endpoint.md | 4 ++-- src/current/v25.3/ui-overview-dashboard.md | 2 +- src/current/v25.4/cluster-setup-troubleshooting.md | 2 +- src/current/v25.4/kibana.md | 6 ------ .../v25.4/monitor-cockroachdb-with-prometheus.md | 6 ------ src/current/v25.4/monitoring-and-alerting.md | 8 +------- src/current/v25.4/operational-faqs.md | 10 +++++----- src/current/v25.4/prometheus-endpoint.md | 4 ++-- src/current/v25.4/ui-overview-dashboard.md | 2 +- 38 files changed, 52 insertions(+), 160 deletions(-) diff --git a/src/current/v23.2/cluster-setup-troubleshooting.md b/src/current/v23.2/cluster-setup-troubleshooting.md index 03b31f44ddc..eb80363e049 100644 --- a/src/current/v23.2/cluster-setup-troubleshooting.md +++ b/src/current/v23.2/cluster-setup-troubleshooting.md @@ -385,7 +385,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) ###### Automatic ballast files diff --git a/src/current/v23.2/kibana.md b/src/current/v23.2/kibana.md index 0728cc9b58c..bc80514783f 100644 --- a/src/current/v23.2/kibana.md +++ b/src/current/v23.2/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v23.2/monitor-cockroachdb-with-prometheus.md b/src/current/v23.2/monitor-cockroachdb-with-prometheus.md index 5b250efca2f..7f4d671aa52 100644 --- a/src/current/v23.2/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v23.2/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v23.2/monitoring-and-alerting.md b/src/current/v23.2/monitoring-and-alerting.md index 0f99a5fac9b..f80cc618eb3 100644 --- a/src/current/v23.2/monitoring-and-alerting.md +++ b/src/current/v23.2/monitoring-and-alerting.md @@ -45,9 +45,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint](#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1001,10 +999,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v23.2/operational-faqs.md b/src/current/v23.2/operational-faqs.md index 41bc09654b7..1ce3d73a13b 100644 --- a/src/current/v23.2/operational-faqs.md +++ b/src/current/v23.2/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -136,11 +136,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -171,7 +171,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v23.2/ui-overview-dashboard.md b/src/current/v23.2/ui-overview-dashboard.md index bcc12ce33df..03a183786df 100644 --- a/src/current/v23.2/ui-overview-dashboard.md +++ b/src/current/v23.2/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation diff --git a/src/current/v24.1/cluster-setup-troubleshooting.md b/src/current/v24.1/cluster-setup-troubleshooting.md index 0b5f32aac77..8286bae7c86 100644 --- a/src/current/v24.1/cluster-setup-troubleshooting.md +++ b/src/current/v24.1/cluster-setup-troubleshooting.md @@ -385,7 +385,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) In rare cases, disk usage can increase on nodes with [Raft followers]({% link {{ page.version.version }}/architecture/replication-layer.md %}#raft) due to a [leader-leaseholder split]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leader-leaseholder-splits). diff --git a/src/current/v24.1/kibana.md b/src/current/v24.1/kibana.md index 889c1896088..310097953b5 100644 --- a/src/current/v24.1/kibana.md +++ b/src/current/v24.1/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v24.1/monitor-cockroachdb-with-prometheus.md b/src/current/v24.1/monitor-cockroachdb-with-prometheus.md index eceee578492..ad08d818b4e 100644 --- a/src/current/v24.1/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v24.1/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v24.1/monitoring-and-alerting.md b/src/current/v24.1/monitoring-and-alerting.md index 780d019ae4c..53224596aec 100644 --- a/src/current/v24.1/monitoring-and-alerting.md +++ b/src/current/v24.1/monitoring-and-alerting.md @@ -43,9 +43,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint](#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1042,10 +1040,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v24.1/operational-faqs.md b/src/current/v24.1/operational-faqs.md index d132ffcded5..5cc1fbd907b 100644 --- a/src/current/v24.1/operational-faqs.md +++ b/src/current/v24.1/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -136,11 +136,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -171,7 +171,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v24.1/ui-overview-dashboard.md b/src/current/v24.1/ui-overview-dashboard.md index 638d45cf979..76f72df5dfd 100644 --- a/src/current/v24.1/ui-overview-dashboard.md +++ b/src/current/v24.1/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation diff --git a/src/current/v24.3/cluster-setup-troubleshooting.md b/src/current/v24.3/cluster-setup-troubleshooting.md index 0b5f32aac77..8286bae7c86 100644 --- a/src/current/v24.3/cluster-setup-troubleshooting.md +++ b/src/current/v24.3/cluster-setup-troubleshooting.md @@ -385,7 +385,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) In rare cases, disk usage can increase on nodes with [Raft followers]({% link {{ page.version.version }}/architecture/replication-layer.md %}#raft) due to a [leader-leaseholder split]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leader-leaseholder-splits). diff --git a/src/current/v24.3/kibana.md b/src/current/v24.3/kibana.md index 77f9bdc8806..ba125267c27 100644 --- a/src/current/v24.3/kibana.md +++ b/src/current/v24.3/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v24.3/monitor-cockroachdb-with-prometheus.md b/src/current/v24.3/monitor-cockroachdb-with-prometheus.md index eceee578492..ad08d818b4e 100644 --- a/src/current/v24.3/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v24.3/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v24.3/monitoring-and-alerting.md b/src/current/v24.3/monitoring-and-alerting.md index d21939a64c3..7103096cc16 100644 --- a/src/current/v24.3/monitoring-and-alerting.md +++ b/src/current/v24.3/monitoring-and-alerting.md @@ -43,9 +43,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint](#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1042,10 +1040,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v24.3/operational-faqs.md b/src/current/v24.3/operational-faqs.md index 7a073b9c0dc..2c1019e981b 100644 --- a/src/current/v24.3/operational-faqs.md +++ b/src/current/v24.3/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -136,11 +136,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -171,7 +171,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v24.3/ui-overview-dashboard.md b/src/current/v24.3/ui-overview-dashboard.md index cbdba407007..569c2f739a8 100644 --- a/src/current/v24.3/ui-overview-dashboard.md +++ b/src/current/v24.3/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation diff --git a/src/current/v25.2/cluster-setup-troubleshooting.md b/src/current/v25.2/cluster-setup-troubleshooting.md index ffe0f9cb20c..9df807f685a 100644 --- a/src/current/v25.2/cluster-setup-troubleshooting.md +++ b/src/current/v25.2/cluster-setup-troubleshooting.md @@ -370,7 +370,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) In rare cases, disk usage can increase on nodes with [Raft followers]({% link {{ page.version.version }}/architecture/replication-layer.md %}#raft) due to a [leader-leaseholder split]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leader-leaseholder-splits). diff --git a/src/current/v25.2/kibana.md b/src/current/v25.2/kibana.md index 77f9bdc8806..ba125267c27 100644 --- a/src/current/v25.2/kibana.md +++ b/src/current/v25.2/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.2/monitor-cockroachdb-with-prometheus.md b/src/current/v25.2/monitor-cockroachdb-with-prometheus.md index 4d391044080..573576f0097 100644 --- a/src/current/v25.2/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v25.2/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.2/monitoring-and-alerting.md b/src/current/v25.2/monitoring-and-alerting.md index 310811cc371..5a5816fb1b3 100644 --- a/src/current/v25.2/monitoring-and-alerting.md +++ b/src/current/v25.2/monitoring-and-alerting.md @@ -43,9 +43,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint](#prometheus-endpoint). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1039,10 +1037,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v25.2/operational-faqs.md b/src/current/v25.2/operational-faqs.md index 7a073b9c0dc..2c1019e981b 100644 --- a/src/current/v25.2/operational-faqs.md +++ b/src/current/v25.2/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -136,11 +136,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -171,7 +171,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v25.2/ui-overview-dashboard.md b/src/current/v25.2/ui-overview-dashboard.md index cbdba407007..569c2f739a8 100644 --- a/src/current/v25.2/ui-overview-dashboard.md +++ b/src/current/v25.2/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation diff --git a/src/current/v25.3/cluster-setup-troubleshooting.md b/src/current/v25.3/cluster-setup-troubleshooting.md index 8368afb1eb4..c6f774750cd 100644 --- a/src/current/v25.3/cluster-setup-troubleshooting.md +++ b/src/current/v25.3/cluster-setup-troubleshooting.md @@ -370,7 +370,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) In rare cases, disk usage can increase on nodes with [Raft followers]({% link {{ page.version.version }}/architecture/replication-layer.md %}#raft) due to a [leader-leaseholder split]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leader-leaseholder-splits). diff --git a/src/current/v25.3/kibana.md b/src/current/v25.3/kibana.md index f2fecbd1679..c20560244ee 100644 --- a/src/current/v25.3/kibana.md +++ b/src/current/v25.3/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.3/monitor-cockroachdb-with-prometheus.md b/src/current/v25.3/monitor-cockroachdb-with-prometheus.md index 6a2a1919551..2a9ff6f04ae 100644 --- a/src/current/v25.3/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v25.3/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.3/monitoring-and-alerting.md b/src/current/v25.3/monitoring-and-alerting.md index b1221eebe7e..fb1a926937d 100644 --- a/src/current/v25.3/monitoring-and-alerting.md +++ b/src/current/v25.3/monitoring-and-alerting.md @@ -43,9 +43,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1016,10 +1014,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v25.3/operational-faqs.md b/src/current/v25.3/operational-faqs.md index 017fcf71222..158603d84ea 100644 --- a/src/current/v25.3/operational-faqs.md +++ b/src/current/v25.3/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -138,11 +138,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -173,7 +173,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v25.3/prometheus-endpoint.md b/src/current/v25.3/prometheus-endpoint.md index 0a8461a7cc1..811b8fd4a20 100644 --- a/src/current/v25.3/prometheus-endpoint.md +++ b/src/current/v25.3/prometheus-endpoint.md @@ -15,7 +15,7 @@ The metrics are formatted for integration with [Prometheus](https://prometheus.i In addition to using the exported time-series data to monitor a cluster through an external system, you can write alerting rules to ensure prompt notification of critical events or issues requiring intervention or investigation. Refer to [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) for more details. {{site.data.alerts.end}} -Even if you rely on external tools for storing and visualizing your cluster's time-series metrics, CockroachDB continues to store time-series metrics for its [DB Console Metrics dashboards]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#metrics-dashboards), unless you manually [disable this collection]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). These stored time-series metrics may be used to generate a [tsdump]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %}), which may be critical during escalations to Cockroach Labs support. +Even if you rely on external tools for storing and visualizing your cluster's time-series metrics, CockroachDB continues to store time-series metrics for its [DB Console Metrics dashboards]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#metrics-dashboards). These stored time-series metrics may be used to generate a [tsdump]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %}), which may be critical during investigations with Cockroach Labs support. ## `_status/vars` @@ -159,4 +159,4 @@ This approach avoids a proliferation of metric names and allows third-party tool - [Monitor CockroachDB Self-Hosted Clusters with Datadog]({% link {{ page.version.version }}/datadog.md %}) - [Monitor CockroachDB with Kibana]({% link {{ page.version.version }}/kibana.md %}) - [Essential Metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %}) -- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) \ No newline at end of file +- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) diff --git a/src/current/v25.3/ui-overview-dashboard.md b/src/current/v25.3/ui-overview-dashboard.md index cbdba407007..569c2f739a8 100644 --- a/src/current/v25.3/ui-overview-dashboard.md +++ b/src/current/v25.3/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation diff --git a/src/current/v25.4/cluster-setup-troubleshooting.md b/src/current/v25.4/cluster-setup-troubleshooting.md index 8368afb1eb4..c6f774750cd 100644 --- a/src/current/v25.4/cluster-setup-troubleshooting.md +++ b/src/current/v25.4/cluster-setup-troubleshooting.md @@ -370,7 +370,7 @@ Like any database system, if you run out of disk space the system will no longer - [What happens when a node runs out of disk space?]({% link {{ page.version.version }}/operational-faqs.md %}#what-happens-when-a-node-runs-out-of-disk-space) - [Why is memory usage increasing despite lack of traffic?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-memory-usage-increasing-despite-lack-of-traffic) - [Why is disk usage increasing despite lack of writes?]({% link {{ page.version.version }}/operational-faqs.md %}#why-is-disk-usage-increasing-despite-lack-of-writes) -- [Can I reduce or disable the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data) +- [Can I reduce the storage of timeseries data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data) In rare cases, disk usage can increase on nodes with [Raft followers]({% link {{ page.version.version }}/architecture/replication-layer.md %}#raft) due to a [leader-leaseholder split]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leader-leaseholder-splits). diff --git a/src/current/v25.4/kibana.md b/src/current/v25.4/kibana.md index f2fecbd1679..c20560244ee 100644 --- a/src/current/v25.4/kibana.md +++ b/src/current/v25.4/kibana.md @@ -111,12 +111,6 @@ Click **Refresh**. The query metrics will appear on the dashboard: CockroachDB Overview dashboard for Metricbeat with SQL metrics -## Step 5. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Kibana for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Kibana based on the data it is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.4/monitor-cockroachdb-with-prometheus.md b/src/current/v25.4/monitor-cockroachdb-with-prometheus.md index 6a2a1919551..2a9ff6f04ae 100644 --- a/src/current/v25.4/monitor-cockroachdb-with-prometheus.md +++ b/src/current/v25.4/monitor-cockroachdb-with-prometheus.md @@ -201,12 +201,6 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a 1. [Add the dashboards to Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). -## Step 6. Disable DB Console's local storage of metrics (optional) - -If you rely on external tools such as Prometheus for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. You can create queries, visualizations, and alerts in Prometheus and AlertManager based on the data Prometheus is collecting from your cluster's Prometheus endpoint. - ## See also - [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}) diff --git a/src/current/v25.4/monitoring-and-alerting.md b/src/current/v25.4/monitoring-and-alerting.md index f53b8bfe8e6..af74229479c 100644 --- a/src/current/v25.4/monitoring-and-alerting.md +++ b/src/current/v25.4/monitoring-and-alerting.md @@ -43,9 +43,7 @@ Each cluster automatically exposes its metrics at an [endpoint in Prometheus for - Allow you to create and share dashboards, reports, and alerts based on metrics. - Do not run within the cluster, and can help you to investigate a situation that led up to cluster outage even if the cluster is unavailable. -Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. To avoid this additional load, or if you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the cluster continues to expose its metrics via the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}). The DB Console stops storing new time-series cluster metrics and eventually deletes historical data. The Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. +Metrics collected by the DB Console are stored within the cluster, and the SQL queries that create the reports on the Metrics dashboards also impose load on the cluster. #### SQL Activity pages @@ -1016,10 +1014,6 @@ Many of the [third-party monitoring integrations]({% link {{ page.version.versio If you have configured [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) to monitor your CockroachDB instance, you can also configure alerting rule definitions to have Alertmanager detect [important events](#events-to-alert-on) and alert you when they occur. -If you rely on external tools for storing and visualizing your cluster's time-series metrics, Cockroach Labs recommends that you [disable the DB Console's storage of time-series metrics]({% link {{ page.version.version }}/operational-faqs.md %}#disable-time-series-storage). - -When storage of time-series metrics is disabled, the DB Console Metrics dashboards in the DB Console are still available, but their visualizations are blank. This is because the dashboards rely on data that is no longer available. - #### Prometheus alerting rules endpoint Every CockroachDB node exports an alerting rules template at `http://:/api/v2/rules/`. These rule definitions are formatted for easy integration with Alertmanager. diff --git a/src/current/v25.4/operational-faqs.md b/src/current/v25.4/operational-faqs.md index 017fcf71222..158603d84ea 100644 --- a/src/current/v25.4/operational-faqs.md +++ b/src/current/v25.4/operational-faqs.md @@ -45,7 +45,7 @@ For the first 10 days of your cluster's life, you can expect storage per node to or about 6 GiB. With on-disk compression, the actual disk usage is likely to be about 4 GiB. -However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, or to disable it altogether, refer to [Can I reduce or disable the storage of time-series data?](#can-i-reduce-or-disable-the-storage-of-time-series-data) +However, depending on your usage of time-series charts in the [DB Console]({% link {{ page.version.version }}/ui-overview-dashboard.md %}), you may prefer to reduce the amount of disk used by time-series data. To reduce the amount of time-series data stored, refer to [Can I reduce the storage of time-series data?](#can-i-reduce-the-storage-of-time-series-data) ## Why is my disk usage not decreasing after deleting data? @@ -138,11 +138,11 @@ The CockroachDB `internal-delete-old-sql-stats` process cleans up query executio In general, the `internal-delete-old-sql-stats` process is not expected to impact cluster performance. There are a few cases where there has been a spike in CPU due to an incredibly large amount of data being processed; however, those cases were resolved through [workload optimizations]({% link {{ page.version.version }}/make-queries-fast.md %}) and general improvements over time. -## Can I reduce or disable the storage of time-series data? +## Can I reduce the storage of time-series data? -Yes, you can either [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage) or [disable time-series storage entirely](#disable-time-series-storage). +Yes, you can [reduce the interval for time-series storage](#reduce-the-interval-for-time-series-storage). -After reducing or disabling time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. +After reducing time-series storage, it can take up to 24 hours for time-series data to be deleted and for the change to be reflected in DB Console metrics. ### Reduce the interval for time-series storage @@ -173,7 +173,7 @@ To reduce the interval for storage of time-series data: - For data stored at 30-minute resolution, reduce the `timeseries.storage.resolution_30m.ttl` cluster setting to an [`INTERVAL`]({% link {{ page.version.version }}/interval.md %}) value less than `2160h0m0s` (90 days). -Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect the cluster's metrics and disabling the DB Console's collection of time-series metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). +Cockroach Labs recommends that you avoid _increasing_ the period of time that DB Console retains time-series metrics. If you need to retain this data for a longer period, consider using a third-party tool such as Prometheus to collect and store metrics. Refer to [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). ### Disable time-series storage diff --git a/src/current/v25.4/prometheus-endpoint.md b/src/current/v25.4/prometheus-endpoint.md index 3aa36ecc50b..ca3edca97d9 100644 --- a/src/current/v25.4/prometheus-endpoint.md +++ b/src/current/v25.4/prometheus-endpoint.md @@ -15,7 +15,7 @@ The metrics are formatted for integration with [Prometheus](https://prometheus.i In addition to using the exported time-series data to monitor a cluster through an external system, you can write alerting rules to ensure prompt notification of critical events or issues requiring intervention or investigation. Refer to [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) for more details. {{site.data.alerts.end}} -Even if you rely on external tools for storing and visualizing your cluster's time-series metrics, CockroachDB continues to store time-series metrics for its [DB Console Metrics dashboards]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#metrics-dashboards), unless you manually [disable this collection]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). These stored time-series metrics may be used to generate a [tsdump]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %}), which may be critical during escalations to Cockroach Labs support. +Even if you rely on external tools for storing and visualizing your cluster's time-series metrics, CockroachDB continues to store time-series metrics for its [DB Console Metrics dashboards]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#metrics-dashboards). These stored time-series metrics may be used to generate a [tsdump]({% link {{ page.version.version }}/cockroach-debug-tsdump.md %}), which may be critical during investigations with Cockroach Labs support. ## `_status/vars` @@ -159,4 +159,4 @@ This approach avoids a proliferation of metric names and allows third-party tool - [Monitor CockroachDB Self-Hosted Clusters with Datadog]({% link {{ page.version.version }}/datadog.md %}) - [Monitor CockroachDB with Kibana]({% link {{ page.version.version }}/kibana.md %}) - [Essential Metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %}) -- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) \ No newline at end of file +- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %}) diff --git a/src/current/v25.4/ui-overview-dashboard.md b/src/current/v25.4/ui-overview-dashboard.md index cbdba407007..569c2f739a8 100644 --- a/src/current/v25.4/ui-overview-dashboard.md +++ b/src/current/v25.4/ui-overview-dashboard.md @@ -9,7 +9,7 @@ The **Overview** dashboard lets you monitor important SQL performance, replicati To view this dashboard, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default. -The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see this [How Can I Reduce or Disable the Storage of Time-series Data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-or-disable-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. +The time-series data displayed in DB Console graphs is stored within the CockroachDB cluster and steadily increases for the first several days of a cluster's life, before an automatic job begins to prune it. By default, time-series data is stored for at 10-second resolution for 10 days, and at 30-minute resolution for 90 days. For details about managing this process, see [Can I reduce the storage of time-series data?]({% link {{ page.version.version }}/operational-faqs.md %}#can-i-reduce-the-storage-of-time-series-data). In a new cluster, you will observe a steady increase in disk usage and the number of ranges even if you aren't writing data to the cluster. ## Dashboard navigation