monitoring.md

Monitoring

GreptimeDB 暴露了 Prometheus 指标, 用户可以使用 Prometheus 来采集指标。

Prometheus Configuration

编写 Prometheus 配置文件，并保存为prometheus.yml:

global:
  scrape_interval: 15s

scrape_configs:
  - job_name: 'greptimedb'
    static_configs:
      - targets: ['localhost:4000']

Start GreptimeDB and Prometheus

Binary

使用二进制安装 GreptimeDB 和 Prometheus

1. 根据文档 安装 GreptimeDB

2. 进入 Prometheus 官方文档 下载二进制，并执行以下命令:

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

在浏览器输入localhost:9090访问 Prometheus。

Docker

使用 Docker 安装 GreptimeDB 和 Prometheus

1. 根据文档 安装 GreptimeDB

2. 运行 Prometheus:

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

Kubernetes

1. 安装 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

2. 使用 gtctl 安装 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

可以通过执行curl http://<host>:<port>/metrics的输出来获取 GreptimeDB 的最新指标。

Frontend

Key	Type
greptime_table_operator_ingest_rows	counter
greptime_servers_error	counter
greptime_servers_http_requests_total	counter
greptime_servers_postgres_connection_count	gauge
greptime_servers_mysql_connection_count	gauge
greptime_query_merge_scan_regions	summary
greptime_servers_http_sql_elapsed	summary
greptime_query_optimize_physicalplan_elapsed	summary
greptime_frontend_handle_sql_elapsed	summary
greptime_http_track_metrics	summary
greptime_query_create_physicalplan_elapsed	summary
greptime_servers_mysql_query_elapsed	summary
greptime_servers_http_requests_elapsed	summary
greptime_query_execute_plan_elapsed	summary
greptime_catalog_kv_get_remote	summary
greptime_grpc_region_request	summary
greptime_query_merge_scan_poll_elapsed	summary
greptime_catalog_kv_get	summary
greptime_table_operator_create_table	summary

Datanode

Key	Type
greptime_opendal_bytes_total	counter
greptime_servers_http_requests_total	counter
greptime_opendal_requests_total	counter
greptime_catalog_catalog_count	gauge
greptime_catalog_schema_count	gauge
greptime_opendal_requests_duration_seconds	summary
greptime_http_track_metrics	summary
greptime_servers_http_requests_elapsed	summary

Meta

Key	Type
greptime_meta_create_schema	counter
greptime_servers_http_requests_total	counter
greptime_meta_create_catalog	counter
greptime_meta_heartbeat_connection_num	gauge
greptime_meta_txn_request	summary
greptime_meta_kv_request	summary
greptime_meta_create_schema	summary
greptime_meta_create_catalog	summary
greptime_meta_handler_execute	summary
greptime_servers_http_requests_elapsed	summary
greptime_http_track_metrics	summary
greptime_meta_procedure_create_table	summary
greptime_grpc_region_request	summary