Docs menu
On this page
  1. Typesense Cluster Overview
  2. Typesense Metrics
  3. Typesense Stats
  4. Typesense By Collection

The four dashboards that ship with the exporter, captured from the bundled Docker Compose stack: a 3-node Typesense cluster under generated traffic. Each has a Node filter. Click a screenshot for the full-size image.

Typesense Cluster Overview#

The one to keep open. Is every node healthy, who is the raft leader, are all nodes on the same version, is replication keeping up, and how much traffic is the cluster serving.

Typesense Cluster Overview Grafana dashboard for Typesense: The one to keep open. Is every node healthy, who is the raft leader, are all nodes on the same version, is replication keeping up, and how much traffic is the cluster serving.
Typesense Cluster Overview dashboard, 3-node cluster. Import it by ID 26064 from grafana.com, or get the dashboard JSON.
Panels on this dashboard
  • Cluster: Unhealthy Nodes, Leader, Documents, Search Rate, Search p95 (worst node), Cache Hit Ratio, Health, Raft State, Typesense Version
  • Replication: Replication Lag (approx.), Raft Commit Rate, Queued Writes
  • Traffic: Requests per Second, Search Latency p95 / p99

Typesense Metrics#

System resources per node: CPU for every core, memory, swap, disk and network, plus Typesense's own allocator memory and fragmentation.

Typesense Metrics Grafana dashboard for Typesense: System resources per node: CPU for every core, memory, swap, disk and network, plus Typesense's own allocator memory and fragmentation.
Typesense Metrics dashboard, 3-node cluster. Import it by ID 26066 from grafana.com, or get the dashboard JSON.
Panels on this dashboard
  • System Metrics: System CPU Active Percentage, System Disk Usage, System Memory Usage, System Network - Received, System Network - Sent, System Swap Usage
  • Typesense Memory Metrics: Typesense Memory Active, Typesense Memory Metadata, Typesense Memory Fragmentation, Typesense Memory Mapped, Typesense Memory Retained, Typesense Memory Resident, Typesense Memory Allocated

Typesense Stats#

Requests per second and latency for search, write, import and delete, with the average, p95, p99 and max, and the search cache hit ratio.

Typesense Stats Grafana dashboard for Typesense: Requests per second and latency for search, write, import and delete, with the average, p95, p99 and max, and the search cache hit ratio.
Typesense Stats dashboard, 3-node cluster. Import it by ID 26065 from grafana.com, or get the dashboard JSON.
Panels on this dashboard
  • Requests Per Second: Total Requests Per Second, Write Requests Per Second, Search Requests Per Second, Import Requests Per Second, Delete Requests Per Second, Overloaded Requests Per Second
  • Latency: Import Latency, Search Latency, Write Latency, Delete Latency
  • Cache: Cache Hit Ratio, Cache Hits and Misses

Typesense By Collection#

Request rate, latency and document count per collection, to find the collection behind a slowdown.

Typesense By Collection Grafana dashboard for Typesense: Request rate, latency and document count per collection, to find the collection behind a slowdown.
Typesense By Collection dashboard, 3-node cluster. Import it by ID 26067 from grafana.com, or get the dashboard JSON.
Panels on this dashboard
  • Collection Stats - $collection: Requests Per Second, Latency
  • Documents: Documents per Collection, Documents in $collection

To install them, see importing the dashboards. To reproduce these screenshots, run the stack from getting started.

This page is generated from README.md on GitHub. Found a mistake? Open an issue.