> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Grafana

> Open and composable observability platform for metrics, logs, and traces

Open and composable observability platform for metrics, logs, and traces

`grafana` · **11 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth grafana
run auth grafana --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run grafana          # common commands
run grafana --all    # every command
```

```ts theme={"theme":"github-dark"}
import { grafana } from "@boxd/run";
```

## Common tools

| Tool                     | What it does                                                                                                                                                        |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get-health`             | Check Grafana server health and database connectivity. Returns 'ok' if Grafana's web server is running and can access the database.                                 |
| `get-index-gateway-ring` | Tool to retrieve the index gateway hash ring status from Grafana Loki.                                                                                              |
| `get-ruler-ring`         | Tool to retrieve the ruler ring status from Grafana Mimir. Use when you need to check the distributed hash ring topology and operational status of ruler instances. |
| `get-status`             | Tool to check if a valid Grafana Enterprise license is available.                                                                                                   |
| `post-acs`               | Tool to perform SAML Assertion Consumer Service (ACS) operation.                                                                                                    |
| `query-public-dashboard` | Query a panel on a public Grafana dashboard to retrieve time-series data and metrics.                                                                               |
| `retrieve-jwks`          | Tool to retrieve JSON Web Key Set (JWKS) with all public keys for token verification.                                                                               |

<Accordion title="All 11 tools" icon="list">
  | Tool                          | What it does                                                                                                                                                        |
  | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `create-otlp-v1-logs`         | Tool to create OTLP v1 logs in Grafana Loki. Use when you need to send OpenTelemetry Protocol logs to Grafana for ingestion and storage.                            |
  | `get-distributor-ha-tracker`  | Tool to retrieve distributor HA tracker status. Use when you need to check which replica has been elected as leader for each Prometheus HA cluster.                 |
  | `get-health`                  | Check Grafana server health and database connectivity. Returns 'ok' if Grafana's web server is running and can access the database.                                 |
  | `get-index-gateway-ring`      | Tool to retrieve the index gateway hash ring status from Grafana Loki.                                                                                              |
  | `get-overrides-exporter-ring` | Tool to retrieve the overrides-exporter hash ring status as an HTML page.                                                                                           |
  | `get-ruler-ring`              | Tool to retrieve the ruler ring status from Grafana Mimir. Use when you need to check the distributed hash ring topology and operational status of ruler instances. |
  | `get-status`                  | Tool to check if a valid Grafana Enterprise license is available.                                                                                                   |
  | `get-store-gateway-tenants`   | Retrieves store gateway tenants. Returns a list of tenants that have blocks stored in the store-gateway's configured storage.                                       |
  | `post-acs`                    | Tool to perform SAML Assertion Consumer Service (ACS) operation.                                                                                                    |
  | `query-public-dashboard`      | Query a panel on a public Grafana dashboard to retrieve time-series data and metrics.                                                                               |
  | `retrieve-jwks`               | Tool to retrieve JSON Web Key Set (JWKS) with all public keys for token verification.                                                                               |
</Accordion>

[Open Grafana in the console →](https://app.boxd.sh/integrations/detail/grafana)