bees-prometheus-exporter 2.0.0

Prometheus exporter for the bees deduplication daemon
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

# Bees Prometheus Exporter

A Prometheus metrics exporter for the [Bees](https://github.com/zygo/bees) deduplication daemon.

## Installation

Install directly from crates.io:

```bash
cargo install bees-prometheus-exporter
```

## Usage

Basic usage with default settings:

```bash
bees-prometheus-exporter
```

The exporter will start on port 8080 and read Bees statistics from `/run/bees/`.

### Command Line Options

```bash
bees-prometheus-exporter [OPTIONS]
```

- `-b, --bees-work-dir PATH`: Path to Bees work directory (default: `/run/bees`)
- `-p, --port PORT`: Port to bind the HTTP server to (default: `8080`)
- `-a, --address ADDRESS`: Address to bind the HTTP server to (default: `::0`)
- `-l, --log-level LEVEL`: Logging level - error, warn, info, debug, trace (default: `info`)

### Examples

Bind to localhost only:

```bash
bees-prometheus-exporter --address 127.0.0.1
```

Enable debug logging:

```bash
bees-prometheus-exporter --log-level debug
```

## Metrics

The exporter reads Bees status files (`<fs-uuid>.status`) from bees' stats directory, by default `/run/bees`.

The available metrics are described in https://github.com/Zygo/bees/blob/master/docs/event-counters.md

Additionally, the exporter reads the per-extent-size progress summary.

### Metric Format

All metrics follow the pattern `bees_{metric_name}_total` and include a `uuid` label identifying the filesystem.

The per-extent-size progress summary is formatted as `bees_progress_summary_{column_name}`, with the columns `datasz_bytes`, `point`, `gen_min` and `gen_max`. The extent size is provided as a label.  
When `point` is idle, `bees_progress_summary_point_idle` reports 1, else 0

## Configuration

Note that, by default, `/run/bees` is root-owned. The exporter requires read access to the directory.  
The exporter uses landlock to confine filesystem and network access. Landlock operates on fds, not paths, which means that deleting and recreating the bees directory will not show up in the exporter.

### Prometheus Configuration

Add the exporter to your Prometheus configuration:

```yaml
scrape_configs:
  - job_name: "bees"
    static_configs:
      - targets: ["localhost:8080"]
    scrape_interval: 1s # bees updates the stats file once per second
```

## Monitoring Examples

### Grafana Dashboard Queries

Deduplication ratio:

```promql
rate(bees_bytes_deduped_total[5m]) / rate(bees_bytes_scanned_total[5m])
```

Deduplication rate in MiB/s:

```promql
rate(bees_bytes_deduped_total[5m]) / 1024 / 1024
```

Files processed per second:

```promql
rate(bees_files_scanned_total[5m])
```

## Requirements

- Rust 1.85+ (for building from source)
- Bees deduplication daemon running and producing status files