Skip to content

Commit

Permalink
Docs: Telemetry API endpoint.
Browse files Browse the repository at this point in the history
  • Loading branch information
xsedla1o committed Dec 19, 2023
1 parent db5fcc3 commit 075f4af
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ There are several API endpoints:
- [`POST /entity/<entity_type>/<entity_id>/ttl`](#extend-ttls): extend TTLs of the specified entity
- [`GET /entities`](#entities): list entity configuration
- [`GET /control/<action>`](#control): send a pre-defined action into execution queue.
- [`GET /telemetry/sources_validity`](#telemetry): get information about the validity of the data sources

---

Expand Down Expand Up @@ -417,4 +418,21 @@ You can learn more about the actions in the [Actions](configuration/control.md#a
"detail": "OK"
}
```
## Telemetry

Returns information about the validity of the data sources, i.e. when the last datapoint was received from each source.

### Request

`GET /telemetry/sources_validity`

### Response

```json
{
"module1@collector1": "2023-10-03T11:59:58.063000",
"module2@collector1": "2023-12-06T09:09:37.165000",
"module3@collector2": "2023-12-08T15:52:55.282000",
...
}
```

0 comments on commit 075f4af

Please sign in to comment.