epazote 3.3.0

Automated HTTP (microservices) supervisor 🌿
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

[![Test & Build](https://github.com/epazote/epazote/actions/workflows/build.yml/badge.svg)](https://github.com/epazote/epazote/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/epazote/epazote/branch/main/graph/badge.svg?token=ztiGQV2sTm)](https://codecov.io/gh/epazote/epazote)

# Epazote 🌿
Automated HTTP (microservices) supervisor

# How to use it
First you need to install **Epazote**:

    cargo install epazote

Or download the latest release from the [releases](https://github.com/epazote/epazote/releases)


## Basic example

```yaml
services:
    my_app:
        url: http://0.0.0.0:8080
        every: 1m
        expect:
            status: 200
            if_not:
                cmd: systemctl restart app
```

## Match JSON responses

```yaml
services:
    vmagent_targets:
        url: http://127.0.0.1:8429/api/v1/targets
        every: 30s
        expect:
            status: 200
            json:
                status: success
                data:
                    activeTargets:
                        - labels:
                            job: DBMI-lab-nico
                          health: up
```

`expect.body` still performs text or regex matching against the raw response body. Use `expect.json` for structured JSON subset matching.

## Delay Fallback Actions With `threshold`

```yaml
services:
    vmagent_targets:
        url: http://127.0.0.1:8429/api/v1/targets
        every: 30s
        expect:
            status: 200
            json:
                status: success
            if_not:
                threshold: 3
                stop: 2
                cmd: systemctl restart vmagent
```

`threshold` waits for N consecutive failures before running `if_not` actions. `stop` limits how many times those fallback actions will be executed after the threshold is reached.

## Use `EPAZOTE_*` Variables In `if_not.cmd`

Fallback commands receive service context through environment variables, which makes alert scripts easier to write:

```yaml
services:
    vmagent_targets:
        url: http://127.0.0.1:8429/api/v1/targets
        every: 30s
        expect:
            status: 200
            json:
                status: success
            if_not:
                threshold: 3
                stop: 1
                cmd: /usr/local/bin/send-alert.sh
```

Available variables:

- `EPAZOTE_SERVICE_NAME`
- `EPAZOTE_SERVICE_TYPE`
- `EPAZOTE_URL` for HTTP checks
- `EPAZOTE_TEST` for command checks
- `EPAZOTE_EXPECTED_STATUS`
- `EPAZOTE_ACTUAL_STATUS` when available
- `EPAZOTE_ERROR`
- `EPAZOTE_FAILURE_COUNT`
- `EPAZOTE_THRESHOLD`

## Run Epazote

    epazote -c epazote.yml

> default configuration file is `epazote.yml`

Logs are pretty-printed by default for easier debugging. Use `--json-logs` if you want structured JSON logs instead.


https://epazote.io