Monitoring

The GreptimeDB exposes the Prometheus metrics, and the users can also use Prometheus to collect the metrics.

Promethues Configuration

Write a Prometheus configuration file and save it as prometheus.yml:

1. global:
2. scrape_interval: 15s

4. scrape_configs:
5. - job_name: 'greptimedb'
6. static_configs:
7. - targets: ['localhost:4000']

Start GreptimeDB and Prometheus

Binary

Use Binary to deploy Prometheus and GreptimeDB:

1. Install GreptimeDB according to the documentation.
2. Visit the official documentation for Prometheus to download the binary. Afterward, execute the following command:

1. ./prometheus --config.file=prometheus.yml

Access Prometheus by entering localhost:9090 in your web browser.

Docker

Use Docker to deploy Prometheus and GreptimeDB:

1. Install GreptimeDB according to the documentation.
2. Start the Prometheus:

1. docker run \
2. -p 9090:9090 \
3. -v $(pwd)/prometheus.yml:/etc/prometheus/prometheus.yml \
4. prom/prometheus

Kubernetes

1. Install kube-prometheus-stack chart:

1. helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
2. helm repo update
3. helm install prometheus prometheus-community/kube-prometheus-stack

1. Use gtctl to deploy GreptimeDB cluster:

1. gtctl cluster create mycluster -n default \
2. --set cluster.prometheusMonitor.enabled=true \
3. --set cluster.prometheusMonitor.path="/metrics" \
4. --set cluster.prometheusMonitor.port="http" \
5. --set cluster.prometheusMonitor.interval="30s" \
6. --set cluster.prometheusMonitor.honorLabels=true \
7. --set cluster.prometheusMonitor.labelsSelector.release="prometheus"

Metrics Detail

You can check the output of curl http://<host>:<port>/metrics by getting the latest metrics of GreptimeDB. We will add more documents of the metrics sooner.

Frontend

Datanode

Meta