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:

global:
  scrape_interval: 15s 
scrape_configs:
  - job_name: 'greptimedb'
    static_configs:
      - 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:

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

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

Kubernetes

1. Install kube-prometheus-stack chart:

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

1. Use gtctl to deploy GreptimeDB cluster:

gtctl cluster create mycluster -n default \
  --set cluster.prometheusMonitor.enabled=true \
  --set cluster.prometheusMonitor.path="/metrics" \
  --set cluster.prometheusMonitor.port="http" \
  --set cluster.prometheusMonitor.interval="30s" \
  --set cluster.prometheusMonitor.honorLabels=true \
  --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