prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I20c1cb77e30d3072e9a8709690306011319e9007
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/README.md b/README.md
index 43bd09a..edb9e2f 100644
--- a/README.md
+++ b/README.md
@@ -1,48 +1,60 @@
-# Telemetry #
+# Telemetry
+
This component implements middleware for sensors and metrics aggregation.
-## Capabilities ##
+## Capabilities
+
This application is implementation of Telemetry proposed in OpenBMC design docs
`[1]`.
It's responsible for:
+
- on-demand creation of metric reports,
- aggregated sets of sensor values available in system `[2]`,
-- access to metric report in both pull and push model (triggers),
+- access to metric report in both pull and push model (triggers),
- run-time monitoring of sensor`[3]` updates.
-## Use-cases ##
+## Use-cases
+
- generic and centralized way to observe telemetry data inside system
- back-end for Redfish TelemetryService`[4]`
-## How to build ##
+## How to build
+
There are two way to build telemetry service:
+
- using bitbake in yocto environment
- using meson as native build
-To build it using bitbake follow the guide from OpenBMC docs`[5]`.
-To build it using meson follow the quick guide to install meson`[6]` and then
-run below commands
+To build it using bitbake follow the guide from OpenBMC docs`[5]`. To build it
+using meson follow the quick guide to install meson`[6]` and then run below
+commands
+
```
meson build
cd build
ninja
```
+
After successful build you should be able to run telemetry binary or start unit
tests
+
```
./tests/telemetry-ut
./telemetry
```
+
In case if system is missing boost dependency, it is possible to build it
locally and set BOOST_ROOT environment variable to location of built files for
meson. After this change meson should be able to detect boost dependency. See
`[7]` for more details.
-## Notes ##
+## Notes
+
More information can be found in OpenBMC docs repository `[8]`.
-## References ##
+## References
+
1. [OpenBMC platform telemetry design](https://github.com/openbmc/docs/blob/master/designs/telemetry.md)
2. [Sensor support for OpenBMC](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md)
3. [dbus-sensors](https://github.com/openbmc/dbus-sensors)
diff --git a/redfish-tests/README.md b/redfish-tests/README.md
index 553fe62..a8ad815 100644
--- a/redfish-tests/README.md
+++ b/redfish-tests/README.md
@@ -16,13 +16,14 @@
# Config
There are few options included to tests:
+
- `--host_addr` - address of an OpenBMC together with protocol and port, ex.
-'https://localhost:443', default: 'https://localhost:4443'
+ 'https://localhost:443', default: 'https://localhost:4443'
- `--username` - name of the user that is used during tests, user should have
-'ConfigureManager' privilege, default: 'root'
+ 'ConfigureManager' privilege, default: 'root'
- `--password` - plain password, default: '0penBmc'
- `--metric_limit` - allows to limit number of detected metrics in system,
-default: 200
+ default: 200
SSL verification is disabled during tests.