1# Telemetry # 2This component implements middleware for sensors and metrics aggregation. 3 4## Capabilities ## 5This application is implementation of Telemetry proposed in OpenBMC design docs 6`[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## How to build ## 19There are two way to build telemetry service: 20- using bitbake in yocto environment 21- using meson as native build 22 23To build it using bitbake follow the guide from OpenBMC docs`[5]`. 24To build it using meson follow the quick guide to install meson`[6]` and then 25run below commands 26``` 27meson build 28cd build 29ninja 30``` 31After successful build you should be able to run telemetry binary or start unit 32tests 33``` 34./tests/telemetry-ut 35./telemetry 36``` 37In case if system is missing boost dependency, it is possible to build it 38locally and set BOOST_ROOT environment variable to location of built files for 39meson. After this change meson should be able to detect boost dependency. See 40`[7]` for more details. 41 42## Notes ## 43More information can be found in OpenBMC docs repository `[8]`. 44 45## References ## 461. [OpenBMC platform telemetry design](https://github.com/openbmc/docs/blob/master/designs/telemetry.md) 472. [Sensor support for OpenBMC](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md) 483. [dbus-sensors](https://github.com/openbmc/dbus-sensors) 494. [Redfish TelemetryService](https://redfish.dmtf.org/schemas/v1/TelemetryService.json) 505. [Yocto-development](https://github.com/openbmc/docs/blob/master/yocto-development.md) 516. [Meson-Quick-Guide](https://mesonbuild.com/Quick-guide.html) 527. [Meson-Boost-dependency](https://mesonbuild.com/Dependencies.html#boost) 538. [OpenBMC-docs-repository](https://github.com/openbmc/docs) 54