Skip to content

Commit 075f4af

Browse files
committed
Docs: Telemetry API endpoint.
1 parent db5fcc3 commit 075f4af

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/api.md

+18
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ There are several API endpoints:
1515
- [`POST /entity/<entity_type>/<entity_id>/ttl`](#extend-ttls): extend TTLs of the specified entity
1616
- [`GET /entities`](#entities): list entity configuration
1717
- [`GET /control/<action>`](#control): send a pre-defined action into execution queue.
18+
- [`GET /telemetry/sources_validity`](#telemetry): get information about the validity of the data sources
1819

1920
---
2021

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

423+
Returns information about the validity of the data sources, i.e. when the last datapoint was received from each source.
424+
425+
### Request
426+
427+
`GET /telemetry/sources_validity`
428+
429+
### Response
430+
431+
```json
432+
{
433+
"module1@collector1": "2023-10-03T11:59:58.063000",
434+
"module2@collector1": "2023-12-06T09:09:37.165000",
435+
"module3@collector2": "2023-12-08T15:52:55.282000",
436+
...
437+
}
438+
```

0 commit comments

Comments
 (0)