Skip to content

Commit 7d2d394

Browse files
authored
DOC-11796 Clarify that Prometheus endpoint is not deprecated (#19187)
* In monitoring-and-alerting.md, clarify that Prometheus endpoint is not deprecated. * Incorporated Kathryn’s feedback. * Updated v25.1 version of file.
1 parent d5c6da2 commit 7d2d394

File tree

6 files changed

+30
-18
lines changed

6 files changed

+30
-18
lines changed

src/current/v23.1/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
140140
### Raw status endpoints
141141

142142
{{site.data.alerts.callout_info}}
143-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
143+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
144+
145+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
144146
{{site.data.alerts.end}}
145147

146-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
148+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
147149

148150
<img src="{{ 'images/v23.1/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
149151

@@ -160,7 +162,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
160162

161163
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
162164

163-
To access the Prometheus of a cluster running on `localhost:8080`:
165+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
164166

165167
{% include_cached copy-clipboard.html %}
166168
~~~ shell

src/current/v23.2/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
140140
### Raw status endpoints
141141

142142
{{site.data.alerts.callout_info}}
143-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
143+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
144+
145+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
144146
{{site.data.alerts.end}}
145147

146-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
148+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
147149

148150
<img src="{{ 'images/v23.2/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
149151

@@ -160,7 +162,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
160162

161163
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
162164

163-
To access the Prometheus of a cluster running on `localhost:8080`:
165+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
164166

165167
{% include_cached copy-clipboard.html %}
166168
~~~ shell

src/current/v24.1/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
138138
### Raw status endpoints
139139

140140
{{site.data.alerts.callout_info}}
141-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
141+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
142+
143+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
142144
{{site.data.alerts.end}}
143145

144-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
146+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
145147

146148
<img src="{{ 'images/v24.1/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
147149

@@ -158,7 +160,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
158160

159161
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
160162

161-
To access the Prometheus of a cluster running on `localhost:8080`:
163+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
162164

163165
{% include_cached copy-clipboard.html %}
164166
~~~ shell

src/current/v24.2/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
138138
### Raw status endpoints
139139

140140
{{site.data.alerts.callout_info}}
141-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
141+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
142+
143+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
142144
{{site.data.alerts.end}}
143145

144-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
146+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
145147

146148
<img src="{{ 'images/v24.2/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
147149

@@ -158,7 +160,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
158160

159161
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
160162

161-
To access the Prometheus of a cluster running on `localhost:8080`:
163+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
162164

163165
{% include_cached copy-clipboard.html %}
164166
~~~ shell

src/current/v24.3/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
138138
### Raw status endpoints
139139

140140
{{site.data.alerts.callout_info}}
141-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
141+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
142+
143+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
142144
{{site.data.alerts.end}}
143145

144-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
146+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
145147

146148
<img src="{{ 'images/v24.2/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
147149

@@ -158,7 +160,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
158160

159161
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
160162

161-
To access the Prometheus of a cluster running on `localhost:8080`:
163+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
162164

163165
{% include_cached copy-clipboard.html %}
164166
~~~ shell

src/current/v25.1/monitoring-and-alerting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,12 @@ Otherwise, it returns an HTTP `200 OK` status response code with an empty body:
138138
### Raw status endpoints
139139

140140
{{site.data.alerts.callout_info}}
141-
These endpoints are deprecated in favor of the [Cluster API](#cluster-api).
141+
The JSON endpoints are deprecated in favor of the [Cluster API](#cluster-api).
142+
143+
The `/_status/vars` metrics endpoint is in Prometheus format and is not deprecated. For more information, refer to [Prometheus endpoint](#prometheus-endpoint).
142144
{{site.data.alerts.end}}
143145

144-
Several endpoints return raw status metrics in JSON at `http://<host>:<http-port>/#/debug`. Feel free to investigate and use these endpoints, but note that they are subject to change.
146+
Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change.
145147

146148
<img src="{{ 'images/v24.2/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" />
147149

@@ -158,7 +160,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.
158160

159161
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
160162

161-
To access the Prometheus of a cluster running on `localhost:8080`:
163+
To access the Prometheus endpoint of a cluster running on `localhost:8080`:
162164

163165
{% include_cached copy-clipboard.html %}
164166
~~~ shell

0 commit comments

Comments
 (0)