xref: /openbmc/telemetry/README.md (revision 73da69064f48aa99d1e4e9a6d9fff4701ed3dea9)
1# Telemetry #
2This component implements middleware for sensors and metrics aggregation.
3
4
5## Capabilities ##
6This application is implementation of Telemetry proposed in design`[1]`.
7
8It's responsible for:
9- on-demand creation of metric reports,
10  - aggregated sets of sensor values available in system `[2]`,
11- access to metric report in both  pull and push model (triggers),
12- run-time monitoring of sensor`[3]` updates.
13
14## Use-cases ##
15- generic and centralized way to observe telemetry data inside system
16- back-end for Redfish TelemetryService`[4]`
17
18## References ##
191. [OpenBMC platform telemetry design](https://github.com/openbmc/docs/blob/master/designs/telemetry.md)
202. [Sensor support for OpenBMC](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md)
213. [dbus-sensors](https://github.com/openbmc/dbus-sensors)
224. [Redfish TelemetryService](https://redfish.dmtf.org/schemas/v1/TelemetryService.json)
23