22(monitoring)=
33
44# Monitoring and diagnostics
5- :::{toctree}
6- Prometheus+Grafana <prometheus-grafana >
7- :::
85
96It is important to continuously monitor your CrateDB database cluster
10- to detect anomalies and follow usage trends, so you can react to
11- them properly and timely.
7+ to detect anomalies, so you can react to them properly and timely.
8+ Collecting statistics and following usage trends is also important
9+ for proper capacity planning.
1210
1311CrateDB provides system information about the cluster as a whole,
1412individual cluster nodes, and about the entities and resources it manages.
@@ -81,12 +79,12 @@ This enumeration includes a few popular and recommended options.
8179
8280:Prometheus:
8381
84- The [ Crate JMX HTTP Exporter] is a Prometheus exporter that consumes
82+ The {ref} ` Crate JMX HTTP Exporter <prometheus-jmx-exporter> ` is a Prometheus exporter that consumes
8583 metrics information from CrateDB's JMX collectors and exposes them
8684 via HTTP so they can be scraped by Prometheus, and, for example,
8785 subsequently displayed in Grafana, or processed into Alertmanager.
8886
89- [ Monitoring a CrateDB cluster with Prometheus and Grafana ] illustrates
87+ {ref} ` monitoring-prometheus-grafana ` illustrates
9088 a full setup for making CrateDB-specific metrics available to Prometheus.
9189 The tutorial uses the _ Crate JMX HTTP Exporter_ for exposing telemetry
9290 information, the _ Prometheus SQL Exporter_ for conducting system table
@@ -113,5 +111,9 @@ This enumeration includes a few popular and recommended options.
113111 real-time information about the cluster, its nodes, and their shards.
114112
115113
116- [ Crate JMX HTTP Exporter ] : https://github.com/crate/jmx_exporter
117- [ Monitoring a CrateDB cluster with Prometheus and Grafana ] : https://community.cratedb.com/t/monitoring-a-self-managed-cratedb-cluster-with-prometheus-and-grafana/1236
114+ :::{toctree}
115+ :hidden:
116+ Prometheus and Grafana <prometheus-grafana >
117+ prometheus-jmx-exporter
118+ prometheus-sql-exporter
119+ :::
0 commit comments