summaryrefslogtreecommitdiff
path: root/Redfish.md
diff options
context:
space:
mode:
authorKrzysztof Grobelny <krzysztof.grobelny@intel.com>2021-06-17 16:37:57 +0300
committerEd Tanous <ed@tanous.net>2023-05-23 02:27:07 +0300
commit479e899d5f57a67647f83b7f615d2c8565290bcf (patch)
tree37ac639250ce686746c3d748e52fcc8fb5556db3 /Redfish.md
parent2c5875a20e5f7f38fac74c1850e2283e4195ff57 (diff)
downloadbmcweb-479e899d5f57a67647f83b7f615d2c8565290bcf.tar.xz
Switched bmcweb to use new telemetry service API
Added support for multiple MetricProperties. Added support for new parameters: CollectionTimeScope, CollectionDuration. ReadingParameters was not yet changed in telemetry backend, instead temporary property ReadingParametersFutureVersion was introduced. Once bmcweb is adapted to use ReadingParametersFutureVersion this property will be renamed in backend to ReadingParameters. Then bmcweb will change to use ReadingParameters. Then ReadingParametersFutureVersion will be removed from backend and everything will be exactly like described in phosphor-dbus-interfaces without introducing breaking changes. Related change in phosphor-dbus-interfaces [1], [2]. This change needs to be bumped together with [3]. Tested: - It is possible to create MetricReportDefinitions with multiple MetricProperties. - Stub values for new parameters are correctly passed to telemetry service. - All existing telemetry service functionalities remain unchanged. [1]: https://github.com/openbmc/phosphor-dbus-interfaces/commit/4f9c09144b60edc015291d2c120fc5b33aa0bec2 [2]: https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/60750 [3]: https://gerrit.openbmc.org/c/openbmc/telemetry/+/58229 Change-Id: I2cd17069e3ea015c8f5571c29278f1d50536272a Signed-off-by: Krzysztof Grobelny <krzysztof.grobelny@intel.com> Signed-off-by: Lukasz Kazmierczak <lukasz.kazmierczak@intel.com>
Diffstat (limited to 'Redfish.md')
-rw-r--r--Redfish.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/Redfish.md b/Redfish.md
index aa5ab895de..fb93efa78e 100644
--- a/Redfish.md
+++ b/Redfish.md
@@ -936,6 +936,7 @@ other.
- MinCollectionInterval
- Status
- Triggers
+- SupportedCollectionFunctions
### /redfish/v1/TelemetryService/MetricReportDefinitions/
@@ -944,6 +945,22 @@ other.
- Members
- Members@odata.count
+### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
+
+#### MetricReportDefinition
+
+- AppendLimit
+- Id
+- MetricReport
+- MetricReportDefinitionEnabled
+- MetricReportDefinitionType
+- Metrics
+- Name
+- ReportActions
+- ReportUpdates
+- Schedule
+- Status
+
### /redfish/v1/TelemetryService/MetricReports/
#### MetricReportCollection
@@ -951,6 +968,16 @@ other.
- Members
- Members@odata.count
+### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
+
+#### MetricReport
+
+- Id
+- MetricReportDefinition
+- MetricValues
+- Name
+- Timestamp
+
### /redfish/v1/TelemetryService/Triggers/
#### TriggersCollection