Skip to main content
emisar

Typesense search

v0.1.6

Read-only diagnostics for a Typesense search node over its HTTP API: health and node/raft state, per-endpoint request stats and system metrics, the collection catalog and individual schemas, API-key metadata, and a tail of slow requests from the server log. One admin API key, streamed over curl stdin, unlocks the stats/metrics/debug endpoints a search-only key cannot read.

8 allowed by default
Pack ID
typesense
Vendor
emisar
OS
linux
Actions
8
Required binaries. Install these on the host before relying on the pack — an action that calls a missing one fails at run time.
curl

Install

emisar pack install fetches this pack, re-validates it, and verifies its content hash against the --hash below — the exact bytes this page was rendered against, so a tampered copy is rejected — before copying it into the runner's packs dir. The command reloads a running daemon itself; no manual restart.

on the runner host 
sudo emisar pack install typesense --hash sha256:991b0d6278865b7a0a7fd47b9a2a1172150d1a2d03476a132f4ec4ca4ab54ed5

Actions 8 total

View on GitHub
  • typesense.collection script low

    GET /collections/{name}

    Returns the schema and document count for a single collection by name. Use when you already know the collection and want just its definition. Requires the admin API key.

    View source on GitHub
  • typesense.collections script low

    GET /collections

    Lists all collections on the node with their full schemas and document counts. Use to inventory what is indexed and how big each collection is. Requires the admin API key.

    View source on GitHub
  • typesense.debug script low

    GET /debug

    Show node version and raft state. The "state" field reports this node's role in the cluster: 1 = LEADER, 4 = FOLLOWER. This is how you read which node is leader vs follower per node. Requires the admin API key.

    View source on GitHub
  • typesense.health script low

    GET /health

    Check liveness for the Typesense node. Returns {"ok": true} when healthy, and surfaces resource-exhaustion states (out of memory, out of disk) when the node has stopped accepting writes. No API key required.

    View source on GitHub
  • typesense.keys script low

    GET /keys

    Lists API key metadata — the key prefix, description, scoped actions, and collections each key may access. The secret value is never returned; only which keys exist and what they are allowed to do. Sensitive: it discloses the set of credentials configured on the node. Requires the admin API key.

    View source on GitHub
  • typesense.metrics script low

    GET /metrics.json

    Show system and process metrics for the node — CPU utilization, memory usage, and disk usage. Use to see whether the node is resource-constrained. Requires the admin API key.

    View source on GitHub
  • typesense.slow_requests exec low

    Recent slow requests from the server log

    Tail slow requests from the Typesense server log — slow requests are written to the server log prefixed "SLOW REQUEST" (enable with --log-slow-requests-time-ms). This greps the log for those lines and tails the most recent ones. Read-only.

    View source on GitHub
  • typesense.stats script low

    GET /stats.json

    Show per-endpoint request statistics over the last 10 seconds — requests-per-second counters and latency_ms breakdowns per API path. Use to see which endpoints are hot and how slow they are right now. Requires the admin API key.

    View source on GitHub
← Back to registry
Pack reference Publish your own →