Skip to content

Commit

Permalink
Merge branch 'main' into azure-storage-2
Browse files Browse the repository at this point in the history
  • Loading branch information
benbardin authored Sep 28, 2023
2 parents df5ba0c + d5921a0 commit 4ce6a62
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
Binary file modified src/current/images/v23.1/ui-cluster-overview-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions src/current/v23.1/monitor-cockroachdb-with-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,39 +170,39 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a
Url | `http://<hostname of machine running prometheus>:9090`
Access | Direct

1. Download the starter [Grafana dashboards](https://github.com/cockroachdb/cockroach/tree/master/monitoring/grafana-dashboards) for CockroachDB:
1. Download the starter [Grafana dashboards](https://github.com/cockroachdb/cockroach/tree/master/monitoring/grafana-dashboards/by-cluster) for CockroachDB:

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/runtime.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/runtime.json
# runtime dashboard: node status, including uptime, memory, and cpu.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/storage.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/storage.json
# storage dashboard: storage availability.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/sql.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/sql.json
# sql dashboard: sql queries/transactions.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/replication.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/replication.json
# replicas dashboard: replica information and operations.
~~~

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.
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

Expand Down
2 changes: 1 addition & 1 deletion src/current/v23.1/multiregion-survival-goals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Mulit-Region Survival Goals
title: Multi-Region Survival Goals
summary: Learn how to set survival goals in a CockroachDB multi-region cluster.
toc: true
keywords: gin, gin index, gin indexes, inverted index, inverted indexes, accelerated index, accelerated indexes
Expand Down
2 changes: 1 addition & 1 deletion src/current/v23.1/ui-cluster-overview-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the **Cluster Overview** panel to quickly assess the capacity and health of
Metric | Description
--------|----
Capacity Usage | <ul><li>Used: The total disk space in use by CockroachDB data across all nodes. This excludes the disk space used by the Cockroach binary, operating system, and other system files.</li><li>Usable: The total disk space usable by CockroachDB data across all nodes. This cannot exceed the store size, if one has been set using [`--store`]({% link {{ page.version.version }}/cockroach-start.md %}#store).</li></ul>See [Capacity metrics](#capacity-metrics) for details on how these values are calculated.
Node Status | <ul><li>The number of `LIVE` nodes in the cluster.</li><li>The number of `SUSPECT` nodes in the cluster. A node is considered suspect if its [liveness status is unavailable]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#node-liveness-issues) or the node is in the process of [decommissioning](#decommissioned-nodes) or draining.</li><li>The number of `DEAD` nodes in the cluster.</li>
Node Status | <ul><li>The number of `LIVE` nodes in the cluster.</li><li>The number of `SUSPECT` nodes in the cluster. A node is considered suspect if its [liveness status is unavailable]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#node-liveness-issues) or the node is in the process of [decommissioning](#decommissioned-nodes).</li><li>The number of `DRAINING` nodes in the cluster.</li><li>The number of `DEAD` nodes in the cluster.</li>
Replication Status | <a name="replication-status"></a> <ul><li>The total number of [ranges]({% link {{ page.version.version }}/architecture/glossary.md %}#architecture-range) in the cluster.</li><li>The number of [under-replicated ranges]({% link {{ page.version.version }}/ui-replication-dashboard.md %}#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li><li>The number of [unavailable ranges]({% link {{ page.version.version }}/ui-replication-dashboard.md %}#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li>

### Capacity metrics
Expand Down
16 changes: 8 additions & 8 deletions src/current/v23.2/monitor-cockroachdb-with-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,39 +170,39 @@ Although Prometheus lets you graph metrics, [Grafana](https://grafana.com/) is a
Url | `http://<hostname of machine running prometheus>:9090`
Access | Direct

1. Download the starter [Grafana dashboards](https://github.com/cockroachdb/cockroach/tree/master/monitoring/grafana-dashboards) for CockroachDB:
1. Download the starter [Grafana dashboards](https://github.com/cockroachdb/cockroach/tree/master/monitoring/grafana-dashboards/by-cluster) for CockroachDB:

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/runtime.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/runtime.json
# runtime dashboard: node status, including uptime, memory, and cpu.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/storage.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/storage.json
# storage dashboard: storage availability.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/sql.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/sql.json
# sql dashboard: sql queries/transactions.
~~~

{% include_cached copy-clipboard.html %}
~~~ shell
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/replication.json
$ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/monitoring/grafana-dashboards/by-cluster/replication.json
# replicas dashboard: replica information and operations.
~~~

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.
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

Expand Down
2 changes: 1 addition & 1 deletion src/current/v23.2/multiregion-survival-goals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Mulit-Region Survival Goals
title: Multi-Region Survival Goals
summary: Learn how to set survival goals in a CockroachDB multi-region cluster.
toc: true
keywords: gin, gin index, gin indexes, inverted index, inverted indexes, accelerated index, accelerated indexes
Expand Down

0 comments on commit 4ce6a62

Please sign in to comment.