# SlashObserve

> Observability dashboards from a sentence, on your own data.

Full documentation in one file: https://slashobserve.com/llms-full.txt

## Get started

- [What is SlashObserve](https://slashobserve.com/docs/get-started/what-is-slashobserve/index.md): What SlashObserve does and what you run to host it.
- [Quick start](https://slashobserve.com/docs/get-started/quick-start/index.md): Run the demo stack with Docker Compose and send your first prompt.
- [Run your own deployment](https://slashobserve.com/docs/get-started/install/index.md): Pull the image and run SlashObserve against your own Postgres, identity provider and datasources.
- [Your first dashboard](https://slashobserve.com/docs/get-started/first-dashboard/index.md): Ask the agent for a dashboard on the demo stack, watch it work, and change the result.
- [Known limitations](https://slashobserve.com/docs/get-started/known-limitations/index.md): What SlashObserve does not do yet, so you can check it against your needs before you adopt it.

## Connect

- [Connect Prometheus](https://slashobserve.com/docs/connect/prometheus/index.md): Add a Prometheus server as a datasource and set its authentication.
- [Connect ClickHouse](https://slashobserve.com/docs/connect/clickhouse/index.md): Add a ClickHouse server as a datasource, with the read-only user it requires.
- [Sign-in with OIDC](https://slashobserve.com/docs/connect/oidc/index.md): Set up sign-in through an OpenID Connect identity provider and decide who may sign in.
- [LLM providers](https://slashobserve.com/docs/connect/llm-providers/index.md): Turn the built-in agent on with Anthropic or an OpenAI-compatible server.

## Use

- [Chat and follow-ups](https://slashobserve.com/docs/use/chat/index.md): How a prompt becomes a dashboard, what the agent does at each step, and how follow-ups revise the same dashboard.
- [Comments, agent requests and versions](https://slashobserve.com/docs/use/review/index.md): Review a dashboard with comments, send changes to the agent, and compare or restore saved versions.
- [Edit a panel](https://slashobserve.com/docs/use/edit-panel/index.md): Change a panel's queries, settings or JSON in the panel editor and save the result as a new version.
- [Import Grafana dashboards](https://slashobserve.com/docs/use/import-grafana/index.md): Import a Grafana dashboard from the web page, the CLI or MCP, and how datasources and folders are matched.
- [CLI](https://slashobserve.com/docs/use/cli/index.md): Install and use the observe command line client.
- [MCP](https://slashobserve.com/docs/use/mcp/index.md): Connect Claude Code, OpenCode, Cursor and other MCP clients to the server.

## Teams

- [Roles](https://slashobserve.com/docs/teams/roles/index.md): The four instance roles and how a person's role is decided.
- [Folders and access](https://slashobserve.com/docs/teams/folders/index.md): How folders hold dashboards and who can see or change them.
- [Saved prompts](https://slashobserve.com/docs/teams/saved-prompts/index.md): Save a prompt once, keep it private or share it, and run it again from the chat home, the picker or the CLI.

## Concepts

- [ObserveSpec](https://slashobserve.com/docs/concepts/observespec/index.md): The JSON document SlashObserve stores for each dashboard version, and what it contains.
- [How the agent builds a dashboard](https://slashobserve.com/docs/concepts/agent/index.md): The tool loop the built-in agent runs, what a save checks, and whose permissions it uses.
- [Datasources and variables](https://slashobserve.com/docs/concepts/datasources-and-variables/index.md): How a dashboard names its datasources, the eight variable types, and how multi-value, All and datasource variables work.
- [Versions](https://slashobserve.com/docs/concepts/versions/index.md): How every save becomes a version, how to see who made it and what changed, restore an old one, and how comments attach to panels.

## Operate

- [Run in production](https://slashobserve.com/docs/operate/production/index.md): Put TLS in front of the server and use its health endpoints.
- [Upgrades and backups](https://slashobserve.com/docs/operate/upgrades-and-backups/index.md): Back up Postgres, upgrade the server and return to an older version.
- [Security model](https://slashobserve.com/docs/operate/security-model/index.md): What SlashObserve protects and what an operator should know.
- [Logging](https://slashobserve.com/docs/operate/logging/index.md): What the server logs and what it never logs.
- [Outbound access](https://slashobserve.com/docs/operate/outbound-access/index.md): Control which domains the server may fetch from or call, including the feeds in news panels, the images and GeoJSON files that panels show and the requests that canvas actions send.
- [Service-account keys](https://slashobserve.com/docs/operate/service-account-keys/index.md): Create and revoke the keys that the CLI, MCP clients and scripts use.

## Reference

- [Configuration](https://slashobserve.com/docs/reference/configuration/index.md): Every `SLASHOBSERVE_*` environment variable with its default and notes.
- [Datasources file](https://slashobserve.com/docs/reference/datasources-file/index.md): The YAML file that lists the Prometheus and ClickHouse servers, and its rules for secrets and limits.
- [HTTP API](https://slashobserve.com/docs/reference/api/index.md): Base URL, authentication, errors and every endpoint of the SlashObserve HTTP API.
- [Sign-in and session](https://slashobserve.com/docs/reference/api/auth/index.md): The sign-in and session endpoints of the HTTP API.
- [Service accounts](https://slashobserve.com/docs/reference/api/service-accounts/index.md): The service accounts endpoints of the HTTP API.
- [People](https://slashobserve.com/docs/reference/api/users/index.md): The people endpoints of the HTTP API.
- [Outbound domains](https://slashobserve.com/docs/reference/api/outbound-domains/index.md): The outbound domains endpoints of the HTTP API.
- [Saved prompts](https://slashobserve.com/docs/reference/api/prompts/index.md): The saved prompts endpoints of the HTTP API.
- [Datasources](https://slashobserve.com/docs/reference/api/datasources/index.md): The datasources endpoints of the HTTP API.
- [Folders](https://slashobserve.com/docs/reference/api/folders/index.md): The folders endpoints of the HTTP API.
- [Dashboards](https://slashobserve.com/docs/reference/api/dashboards/index.md): The dashboards endpoints of the HTTP API.
- [Grafana imports](https://slashobserve.com/docs/reference/api/imports/index.md): The grafana imports endpoints of the HTTP API.
- [Actions](https://slashobserve.com/docs/reference/api/actions/index.md): The actions endpoints of the HTTP API.
- [Live events](https://slashobserve.com/docs/reference/api/events/index.md): The live events endpoints of the HTTP API.
- [Comments](https://slashobserve.com/docs/reference/api/comments/index.md): The comments endpoints of the HTTP API.
- [Panel and variable data](https://slashobserve.com/docs/reference/api/queryproxy/index.md): The panel and variable data endpoints of the HTTP API.
- [Draft panel preview](https://slashobserve.com/docs/reference/api/preview/index.md): The draft panel preview endpoints of the HTTP API.
- [Metric and label names](https://slashobserve.com/docs/reference/api/names/index.md): The metric and label names endpoints of the HTTP API.
- [Revision requests](https://slashobserve.com/docs/reference/api/revisions/index.md): The revision requests endpoints of the HTTP API.
- [Panel suggestions](https://slashobserve.com/docs/reference/api/suggestions/index.md): The panel suggestions endpoints of the HTTP API.
- [Agent requests](https://slashobserve.com/docs/reference/api/observe/index.md): The agent requests endpoints of the HTTP API.
- [News feeds](https://slashobserve.com/docs/reference/api/news/index.md): The news feeds endpoints of the HTTP API.
- [Assets](https://slashobserve.com/docs/reference/api/assets/index.md): The assets endpoints of the HTTP API.
- [Schemas](https://slashobserve.com/docs/reference/api/schemas/index.md): The request and response objects the HTTP API endpoints use.
- [ObserveSpec schema](https://slashobserve.com/docs/reference/observespec/index.md): ObserveSpec v0: one SlashObserve dashboard. Absent fields mean the default.
- [query](https://slashobserve.com/docs/reference/observespec/variables/query/index.md): Fields of a `query` variable.
- [custom](https://slashobserve.com/docs/reference/observespec/variables/custom/index.md): Fields of a `custom` variable.
- [constant](https://slashobserve.com/docs/reference/observespec/variables/constant/index.md): Fields of a `constant` variable.
- [interval](https://slashobserve.com/docs/reference/observespec/variables/interval/index.md): Fields of a `interval` variable.
- [textbox](https://slashobserve.com/docs/reference/observespec/variables/textbox/index.md): Fields of a `textbox` variable.
- [datasource](https://slashobserve.com/docs/reference/observespec/variables/datasource/index.md): Fields of a `datasource` variable.
- [adhoc](https://slashobserve.com/docs/reference/observespec/variables/adhoc/index.md): Fields of a `adhoc` variable.
- [groupby](https://slashobserve.com/docs/reference/observespec/variables/groupby/index.md): Fields of a `groupby` variable.
- [timeseries](https://slashobserve.com/docs/reference/observespec/panels/timeseries/index.md): Fields and display options of a `timeseries` panel.
- [stat](https://slashobserve.com/docs/reference/observespec/panels/stat/index.md): Fields and display options of a `stat` panel.
- [gauge](https://slashobserve.com/docs/reference/observespec/panels/gauge/index.md): Fields and display options of a `gauge` panel.
- [bargauge](https://slashobserve.com/docs/reference/observespec/panels/bargauge/index.md): Fields and display options of a `bargauge` panel.
- [table](https://slashobserve.com/docs/reference/observespec/panels/table/index.md): Fields and display options of a `table` panel.
- [piechart](https://slashobserve.com/docs/reference/observespec/panels/piechart/index.md): Fields and display options of a `piechart` panel.
- [heatmap](https://slashobserve.com/docs/reference/observespec/panels/heatmap/index.md): Fields and display options of a `heatmap` panel.
- [histogram](https://slashobserve.com/docs/reference/observespec/panels/histogram/index.md): Fields and display options of a `histogram` panel.
- [state-timeline](https://slashobserve.com/docs/reference/observespec/panels/state-timeline/index.md): Fields and display options of a `state-timeline` panel.
- [logs](https://slashobserve.com/docs/reference/observespec/panels/logs/index.md): Fields and display options of a `logs` panel.
- [barchart](https://slashobserve.com/docs/reference/observespec/panels/barchart/index.md): Fields and display options of a `barchart` panel.
- [status-history](https://slashobserve.com/docs/reference/observespec/panels/status-history/index.md): Fields and display options of a `status-history` panel.
- [trend](https://slashobserve.com/docs/reference/observespec/panels/trend/index.md): Fields and display options of a `trend` panel.
- [xychart](https://slashobserve.com/docs/reference/observespec/panels/xychart/index.md): Fields and display options of a `xychart` panel.
- [candlestick](https://slashobserve.com/docs/reference/observespec/panels/candlestick/index.md): Fields and display options of a `candlestick` panel.
- [nodeGraph](https://slashobserve.com/docs/reference/observespec/panels/nodegraph/index.md): Fields and display options of a `nodeGraph` panel.
- [traces](https://slashobserve.com/docs/reference/observespec/panels/traces/index.md): Fields and display options of a `traces` panel.
- [flamegraph](https://slashobserve.com/docs/reference/observespec/panels/flamegraph/index.md): Fields of a `flamegraph` panel.
- [geomap](https://slashobserve.com/docs/reference/observespec/panels/geomap/index.md): Fields and display options of a `geomap` panel.
- [canvas](https://slashobserve.com/docs/reference/observespec/panels/canvas/index.md): Fields and display options of a `canvas` panel.
- [alertlist](https://slashobserve.com/docs/reference/observespec/panels/alertlist/index.md): Fields and display options of a `alertlist` panel.
- [text](https://slashobserve.com/docs/reference/observespec/panels/text/index.md): Fields of a `text` panel.
- [placeholder](https://slashobserve.com/docs/reference/observespec/panels/placeholder/index.md): Written only by the importer for a Grafana panel we cannot render yet; the agent may move or delete it but not create one.
- [row](https://slashobserve.com/docs/reference/observespec/panels/row/index.md): Child panels are always nested, collapsed or not.
- [dashlist](https://slashobserve.com/docs/reference/observespec/panels/dashlist/index.md): Links to other dashboards on this server; no datasource or queries.
- [news](https://slashobserve.com/docs/reference/observespec/panels/news/index.md): The latest items of one RSS or Atom feed, fetched by the server for allowlisted domains; no datasource or queries.
- [Field options](https://slashobserve.com/docs/reference/observespec/field-options/index.md): Options every data panel and every override accepts, such as unit, decimals, thresholds and mappings.
- [Overrides and mappings](https://slashobserve.com/docs/reference/observespec/overrides-and-mappings/index.md): Change field options for matching series, and map raw values to text and colours.
- [Transforms](https://slashobserve.com/docs/reference/observespec/transforms/index.md): Transforms that reshape query results in the browser before a panel draws them.