Skip to content

Commit 7277b6a

Browse files
committed
In cluster-virtualization-metric-scopes.md, added note to use cluster=system query parameter to retrieve both system and virtual cluster metrics.
1 parent 7bb62e5 commit 7277b6a

File tree

4 files changed

+18
-12
lines changed

4 files changed

+18
-12
lines changed

src/current/v25.1/cluster-virtualization-metric-scopes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual
1616
- When a metric is scoped to a non-system virtual cluster, the metric is tracked separately for each virtual cluster (including the system virtual cluster). Most metrics are scoped to a virtual cluster. Refer to [Metrics scoped to a virtual cluster](#metrics-scoped-to-a-virtual-cluster).
1717
- When a metric is scoped to the system virtual cluster, it is included only in the metrics for the system virtual cluster. These metrics provide information about the underlying CockroachDB cluster's performance. Refer to [Metrics scoped to the system virtual cluster](#metrics-scoped-to-the-system-virtual-cluster).
1818

19+
{{site.data.alerts.callout_info}}
20+
To retrieve both system (node-level) and virtual cluster metrics, scrape the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) with the `cluster=system` query parameter. If you set the [`server.controller.default_target_cluster` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}), the endpoint without this parameter exposes metrics only for the specified virtual cluster.
21+
{{site.data.alerts.end}}
22+
1923
{% comment %}
2024
Src: cockroach gen metrics-list --format=csv against cockroach-v24.3.0-beta.1.darwin-10.9-amd64
2125

src/current/v25.2/cluster-virtualization-metric-scopes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual
1616
- When a metric is scoped to a non-system virtual cluster, the metric is tracked separately for each virtual cluster (including the system virtual cluster). Most metrics are scoped to a virtual cluster. Refer to [Metrics scoped to a virtual cluster](#metrics-scoped-to-a-virtual-cluster).
1717
- When a metric is scoped to the system virtual cluster, it is included only in the metrics for the system virtual cluster. These metrics provide information about the underlying CockroachDB cluster's performance. Refer to [Metrics scoped to the system virtual cluster](#metrics-scoped-to-the-system-virtual-cluster).
1818

19+
{{site.data.alerts.callout_info}}
20+
To retrieve both system (node-level) and virtual cluster metrics, scrape the [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) with the `cluster=system` query parameter. If you set the [`server.controller.default_target_cluster` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}), the endpoint without this parameter exposes metrics only for the specified virtual cluster.
21+
{{site.data.alerts.end}}
22+
1923
{% comment %}
2024
Src: cockroach gen metrics-list --format=csv against cockroach-v24.3.0-beta.1.darwin-10.9-amd64
2125

src/current/v25.3/cluster-virtualization-metric-scopes.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual
1616
- When a metric is scoped to a non-system virtual cluster, the metric is tracked separately for each virtual cluster (including the system virtual cluster). Most metrics are scoped to a virtual cluster. Refer to [Metrics scoped to a virtual cluster](#metrics-scoped-to-a-virtual-cluster).
1717
- When a metric is scoped to the system virtual cluster, it is included only in the metrics for the system virtual cluster. These metrics provide information about the underlying CockroachDB cluster's performance. Refer to [Metrics scoped to the system virtual cluster](#metrics-scoped-to-the-system-virtual-cluster).
1818

19-
{% comment %}
20-
Src: cockroach gen metrics-list --format=csv against cockroach-v24.3.0-beta.1.darwin-10.9-amd64
21-
22-
23-
Also saved in https://docs.google.com/spreadsheets/d/1HIalzAhwU0CEYzSuG2m1aXSJRpiIyQPJdt8SusHpJ_U/edit?usp=sharing
24-
(shared CRL-internal). Sort by Layer, then Metric. Paste into the correct section below.
19+
{{site.data.alerts.callout_info}}
20+
To retrieve both system (node-level) and virtual cluster metrics, scrape the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}) with the `cluster=system` query parameter. If you set the [`server.controller.default_target_cluster` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}), the endpoint without this parameter exposes metrics only for the specified virtual cluster.
21+
{{site.data.alerts.end}}
2522

23+
{% comment %}
24+
Layers
2625
APPLICATION: Scoped to a virtual cluster
2726
STORAGE: Scoped to the system virtual cluster
2827
SERVER: n/a

src/current/v25.4/cluster-virtualization-metric-scopes.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ When [cluster virtualization]({% link {{ page.version.version }}/cluster-virtual
1616
- When a metric is scoped to a non-system virtual cluster, the metric is tracked separately for each virtual cluster (including the system virtual cluster). Most metrics are scoped to a virtual cluster. Refer to [Metrics scoped to a virtual cluster](#metrics-scoped-to-a-virtual-cluster).
1717
- When a metric is scoped to the system virtual cluster, it is included only in the metrics for the system virtual cluster. These metrics provide information about the underlying CockroachDB cluster's performance. Refer to [Metrics scoped to the system virtual cluster](#metrics-scoped-to-the-system-virtual-cluster).
1818

19-
{% comment %}
20-
Src: cockroach gen metrics-list --format=csv against cockroach-v24.3.0-beta.1.darwin-10.9-amd64
21-
22-
23-
Also saved in https://docs.google.com/spreadsheets/d/1HIalzAhwU0CEYzSuG2m1aXSJRpiIyQPJdt8SusHpJ_U/edit?usp=sharing
24-
(shared CRL-internal). Sort by Layer, then Metric. Paste into the correct section below.
19+
{{site.data.alerts.callout_info}}
20+
To retrieve both system (node-level) and virtual cluster metrics, scrape the [Prometheus endpoint]({% link {{ page.version.version }}/prometheus-endpoint.md %}) with the `cluster=system` query parameter. If you set the [`server.controller.default_target_cluster` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}), the endpoint without this parameter exposes metrics only for the specified virtual cluster.
21+
{{site.data.alerts.end}}
2522

23+
{% comment %}
24+
Layers
2625
APPLICATION: Scoped to a virtual cluster
2726
STORAGE: Scoped to the system virtual cluster
2827
SERVER: n/a

0 commit comments

Comments
 (0)