Documentation

Everything you need to install the agent, connect your cluster, and get diagnostics running.

5 min read

Installation

Download and install the agent on Linux, macOS, or Windows. Includes the interactive --init wizard and service setup.

Read

3 min read

Configuration reference

Every YAML field explained — cluster connection, TLS options, run interval, heartbeat, log file, and category filters.

Read

4 min read

What it checks

All 11 diagnostic categories: cluster health, node resources, shards, indices, performance, snapshots, ISM, security, plugins, ingest pipelines, and index templates.

Read

3 min read

FAQ

Agent not connecting, no data showing, TLS issues, minimum permissions, self-hosting, and more.

Read

Quick start — 3 steps

1Sign up at opensearchdoctor.com and go to Settings → Agent Keys to create an API key.
2Download the agent for your platform and run ./agent --init.
3The wizard tests your connections, writes config.yaml, and optionally installs a systemd service. Done.