Typesense Cluster Overview

Health, raft leader, versions, replication lag, documents, search rate and latency for every node of a Typesense cluster. Uses typesense-prometheus-exporter 1.x.

Typesense Cluster Overview screenshot 1

The health of a whole Typesense cluster at a glance: unhealthy nodes, the current raft leader, document count, search rate, worst-node p95 search latency and cache hit ratio, plus per-node health, raft role, Typesense version, replication lag, raft commit rate, queued writes, request rates and p95/p99 search latency.

Part of a set of four Typesense dashboards for typesense-prometheus-exporter, an open-source Prometheus exporter for Typesense: Cluster Overview, Stats, Metrics and By Collection. The dashboards link to each other from the top bar.

Requirements

Setup

  1. Run the exporter next to each Typesense node, or one exporter for the whole cluster with /probe?target=typesense-1.internal:8108:

    docker run -d -p 8888:8888 \
      -e TYPESENSE_HOST=typesense-1.internal \
      -e TYPESENSE_API_KEY_FILE=/run/secrets/typesense/api-key \
      imatefx/typesense-prometheus-exporter:latest
    
  2. Add it to Prometheus:

    scrape_configs:
      - job_name: typesense-exporter
        scrape_timeout: 10s
        static_configs:
          - targets: [exporter-1.internal:8888]
    
  3. Import this dashboard and pick your Prometheus data source. Use the host variable to filter nodes.

Documentation

Revisions
RevisionDescriptionCreated

Get this dashboard

Import the dashboard template

or

Download JSON

Datasource
Dependencies