grafana 0.1.3

Ergonomic Rust SDK for Grafana's HTTP API, with async and blocking clients.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

<h1 align="center"><code>grafana-rs</code></h1>

<p align="center">
Ergonomic Rust SDK for Grafana's HTTP API, with async and blocking clients.
</p>

<div align="center">

[![Crates.io](https://img.shields.io/crates/v/grafana.svg)](https://crates.io/crates/grafana)&nbsp;
[![Downloads](https://img.shields.io/crates/d/grafana.svg)](https://crates.io/crates/grafana)&nbsp;
[![Docs.rs](https://img.shields.io/docsrs/grafana)](https://docs.rs/grafana)&nbsp;
[![MSRV](https://img.shields.io/badge/MSRV-1.92-blue)](Cargo.toml)&nbsp;
[![CI](https://github.com/lvillis/grafana-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/lvillis/grafana-rs/actions/workflows/ci.yml)&nbsp;
[![Repo Size](https://img.shields.io/github/repo-size/lvillis/grafana-rs?color=328657)](https://github.com/lvillis/grafana-rs)&nbsp;
[![License](https://img.shields.io/crates/l/grafana.svg)](LICENSE)

</div>

---


## Install

```toml
[dependencies]
grafana = "0.1" # async + rustls (default)
```

Blocking-only (no Tokio):

```toml
[dependencies]
grafana = { version = "0.1", default-features = false, features = ["blocking", "rustls"] }
```

Native TLS: replace `rustls` with `native-tls` (and set `default-features = false`).

### Features

- `async` (default): `tokio` + `reqwest`.
- `blocking`: `reqwest::blocking`.
- `rustls` (default) / `native-tls`: pick one TLS backend.
- `tracing`: request spans.

If you run inside Tokio, call blocking APIs from `spawn_blocking` or a dedicated thread pool.

## Quick start (async)

```rust
use grafana::{Auth, Client};

async fn demo() -> Result<(), grafana::Error> {
    let client = Client::builder("https://grafana.example.com")?
        .auth(Auth::bearer("TOKEN"))
        .build()?;

    let health = client.health().get().await?;
    println!("{health:?}");
    Ok(())
}
```

## Quick start (blocking)

```rust
use grafana::{Auth, BlockingClient};

fn demo() -> Result<(), grafana::Error> {
    let client = BlockingClient::builder("https://grafana.example.com")?
        .auth(Auth::bearer("TOKEN"))
        .build()?;

    let health = client.health().get()?;
    println!("{health:?}");
    Ok(())
}
```

## Base URL

Pass the Grafana root URL (optionally with a subpath). The client automatically targets `/api`.

Examples:
- `https://grafana.example.com`
- `https://example.com/grafana`

## API coverage

- Hand-written wrappers: `client.dashboards()`, `client.folders()`, `client.user()`, ...
- Generated wrappers: `client.openapi()` (method-per-operation, keyed by Grafana `operationId`).
- Escape hatch: `client.raw()` for custom requests.

## Compatibility

Endpoint wrappers follow the latest Grafana OpenAPI spec (`grafana/grafana` `public/openapi3.json`).
For full coverage across Grafana versions, use `raw()` for unwrapped endpoints.

## Contract tests (repo)

Run the ignored contract tests against a real Grafana:

```bash
# Bearer token auth
GRAFANA_BASE_URL="https://grafana.example.com" GRAFANA_TOKEN="..." \
  cargo test --test contract -- --ignored

# Basic auth
GRAFANA_BASE_URL="http://localhost:3000" GRAFANA_USERNAME="admin" GRAFANA_PASSWORD="admin" \
  cargo test --test contract -- --ignored
```