yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
index 6d992fc..041f582 100644
--- a/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
@@ -4,137 +4,137 @@
xyz.openbmc_project.Object.Delete for deletion of individual report objects.
methods:
- - name: Update
- description: >
- The Update method is defined for the on demand metric report update.
- It triggers update of the Readings property. If ReportingType is not
- set to OnRequest then method does nothing.
+ - name: Update
+ description: >
+ The Update method is defined for the on demand metric report update.
+ It triggers update of the Readings property. If ReportingType is not
+ set to OnRequest then method does nothing.
properties:
- - name: Persistency
- type: boolean
- description: >
- Defines if the report configuration is stored in non volatile memory.
- Configuration contains all Report properties excluding Readings.
- - name: ReadingParameters
- type: array[struct[array[object_path],enum[self.OperationType],string,string,enum[self.CollectionTimescope],uint64]]
- description: >
- Array of structures that contains array of sensor paths that are
- monitored by Telemetry service, operation type, metric Id, metadata,
- collection timescope and collection duration. Metric Id and metadata are
- used to store user details, e.g. metadata can be used to map sensor name
- to DBus path.
- - name: Readings
- type: struct[uint64,array[struct[string,string,double,uint64]]]
- description: >
- Structure that contains timestamp of readings update in milliseconds and
- array of metric Id, metadata, reading value and timestamp of single
- reading update in milliseconds. Metric Id and metadata are equal to its
- counterparts in ReadingParameters property.
- flags:
- - readonly
- - name: EmitsReadingsUpdate
- type: boolean
- description: >
- On Readings update PropertiesChanged signal is emitted. It allows to
- decrease generation of load on DBus when Readings property is updated.
- Redfish Event Service requires this option to be equal to true.
- flags:
- - const
- - name: LogToMetricReportsCollection
- type: boolean
- description: >
- Presence of Report in Metric Report Collection in Redfish Telemetry
- Service.
- flags:
- - const
- - name: ReportingType
- type: enum[self.ReportingType]
- description: Defines how readings are updated.
- - name: ReportUpdates
- type: enum[self.ReportUpdates]
- description: Defines how Readings array is filled.
- - name: AppendLimit
- type: size
- description: Defines the maximum number of entries in 'Readings' property.
- flags:
- - readonly
- - name: Interval
- type: uint64
- description: >
- Defines period of time in milliseconds when readings are updated.
- - name: Enabled
- type: boolean
- description: >
- Indicates if readings in report will be updated. This may be set to
- false by the service if ReportUpdates property is 'AppendStopsWhenFull'
- and readings limit specified by AppendLimit is reached.
+ - name: Persistency
+ type: boolean
+ description: >
+ Defines if the report configuration is stored in non volatile memory.
+ Configuration contains all Report properties excluding Readings.
+ - name: ReadingParameters
+ type: array[struct[array[object_path],enum[self.OperationType],string,string,enum[self.CollectionTimescope],uint64]]
+ description: >
+ Array of structures that contains array of sensor paths that are
+ monitored by Telemetry service, operation type, metric Id, metadata,
+ collection timescope and collection duration. Metric Id and metadata are
+ used to store user details, e.g. metadata can be used to map sensor name
+ to DBus path.
+ - name: Readings
+ type: struct[uint64,array[struct[string,string,double,uint64]]]
+ description: >
+ Structure that contains timestamp of readings update in milliseconds and
+ array of metric Id, metadata, reading value and timestamp of single
+ reading update in milliseconds. Metric Id and metadata are equal to its
+ counterparts in ReadingParameters property.
+ flags:
+ - readonly
+ - name: EmitsReadingsUpdate
+ type: boolean
+ description: >
+ On Readings update PropertiesChanged signal is emitted. It allows to
+ decrease generation of load on DBus when Readings property is updated.
+ Redfish Event Service requires this option to be equal to true.
+ flags:
+ - const
+ - name: LogToMetricReportsCollection
+ type: boolean
+ description: >
+ Presence of Report in Metric Report Collection in Redfish Telemetry
+ Service.
+ flags:
+ - const
+ - name: ReportingType
+ type: enum[self.ReportingType]
+ description: Defines how readings are updated.
+ - name: ReportUpdates
+ type: enum[self.ReportUpdates]
+ description: Defines how Readings array is filled.
+ - name: AppendLimit
+ type: size
+ description: Defines the maximum number of entries in 'Readings' property.
+ flags:
+ - readonly
+ - name: Interval
+ type: uint64
+ description: >
+ Defines period of time in milliseconds when readings are updated.
+ - name: Enabled
+ type: boolean
+ description: >
+ Indicates if readings in report will be updated. This may be set to
+ false by the service if ReportUpdates property is 'AppendStopsWhenFull'
+ and readings limit specified by AppendLimit is reached.
enumerations:
- - name: OperationType
- description: Type of action that is executed on readings.
- values:
- - name: Single
- description: Store the latest reading.
- - name: Max
- description: Store maximal reading during defined time period.
- - name: Min
- description: Store minimal reading during defined time period.
- - name: Avg
- description: Calculate average of readings during defined time period.
- - name: Sum
- description: Calculate sum of readings over defined time period.
- - name: ReportingType
- description: >
- The type that defines when Readings are updated.
- values:
- - name: OnChange
- description: >
- On sensor reading change.
- - name: OnRequest
- description: >
- On Update method call.
- - name: Periodic
- description: >
- After period of time defined by Interval property.
- - name: ReportUpdates
- description: >
- The type that defines how Readings are updated.
- values:
- - name: Overwrite
- description: >
- Last sensor reading is written to Readings overwriting the previous
- value. AppendLimit set by user is ignored. Readings size is equal to
- count of all sensors across all metrics.
- - name: AppendWrapsWhenFull
- description: >
- Append sensor reading to Readings up to limit specify in AppendLimit
- then start from the beginning.
- - name: AppendStopsWhenFull
- description: >
- Append sensor reading to Readings up to limit specify in AppendLimit
- then stop till report update.
- - name: NewReport
- description: >
- A new report is created, whose name is the current metric report name
- concatenated with the timestamp.
- - name: CollectionTimescope
- description: >
- The time scope of the related metric values.
- values:
- - name: Point
- description: >
- The corresponding metric apply to a point in time. The reading
- timestamp in Readings property specifies point in time.
- - name: Interval
- description: >
- The corresponding metric apply to a time interval. The reading
- timestamp in Readings property specifies the end of the time interval
- and the collection duration of ReadingParameters specify its duration.
- - name: StartupInterval
- description: >
- The corresponding metric apply to a time interval that began on
- report creation. The reading timestamp in Readings property specifies
- the end of the time interval. Collection duration of
- ReadingParameters specifies the duration between the startup of
- resource and timestamp.
+ - name: OperationType
+ description: Type of action that is executed on readings.
+ values:
+ - name: Single
+ description: Store the latest reading.
+ - name: Max
+ description: Store maximal reading during defined time period.
+ - name: Min
+ description: Store minimal reading during defined time period.
+ - name: Avg
+ description: Calculate average of readings during defined time period.
+ - name: Sum
+ description: Calculate sum of readings over defined time period.
+ - name: ReportingType
+ description: >
+ The type that defines when Readings are updated.
+ values:
+ - name: OnChange
+ description: >
+ On sensor reading change.
+ - name: OnRequest
+ description: >
+ On Update method call.
+ - name: Periodic
+ description: >
+ After period of time defined by Interval property.
+ - name: ReportUpdates
+ description: >
+ The type that defines how Readings are updated.
+ values:
+ - name: Overwrite
+ description: >
+ Last sensor reading is written to Readings overwriting the previous
+ value. AppendLimit set by user is ignored. Readings size is equal to
+ count of all sensors across all metrics.
+ - name: AppendWrapsWhenFull
+ description: >
+ Append sensor reading to Readings up to limit specify in AppendLimit
+ then start from the beginning.
+ - name: AppendStopsWhenFull
+ description: >
+ Append sensor reading to Readings up to limit specify in AppendLimit
+ then stop till report update.
+ - name: NewReport
+ description: >
+ A new report is created, whose name is the current metric report name
+ concatenated with the timestamp.
+ - name: CollectionTimescope
+ description: >
+ The time scope of the related metric values.
+ values:
+ - name: Point
+ description: >
+ The corresponding metric apply to a point in time. The reading
+ timestamp in Readings property specifies point in time.
+ - name: Interval
+ description: >
+ The corresponding metric apply to a time interval. The reading
+ timestamp in Readings property specifies the end of the time interval
+ and the collection duration of ReadingParameters specify its duration.
+ - name: StartupInterval
+ description: >
+ The corresponding metric apply to a time interval that began on
+ report creation. The reading timestamp in Readings property specifies
+ the end of the time interval. Collection duration of
+ ReadingParameters specifies the duration between the startup of
+ resource and timestamp.
diff --git a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
index baefb9a..ae8d36f 100644
--- a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
@@ -3,71 +3,71 @@
limitations and allows to add report.
methods:
- - name: AddReport
- description: >
- Create new object that represent Report with
- xyz.openbmc_project.Telemetry.Report interface stored in path
- /xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where
- Domain and Name are parameters of this method.
- parameters:
- - name: name
- type: string
- description: >
- Defines the name of report to be exposed over D-Bus. Service allows
- to use separator '/' in name to group reports in directory.
- - name: reportingType
- type: enum[xyz.openbmc_project.Telemetry.Report.ReportingType]
- description: Defines report type
- - name: reportUpdates
- type: enum[xyz.openbmc_project.Telemetry.Report.ReportUpdates]
- description: Defines report update type
- - name: appendLimit
- type: size
- description: >
- Defines the maximum number of entries in 'Readings' property.
- - name: emitsReadingsUpdate
- type: boolean
- description: >
- Defines presence of PropertiesChanged signal for
- xyz.openbmc_project.Telmetry.Report.Readings property.
- - name: logToMetricReportsCollection
- type: boolean
- description: >
- Defines presence of Report in Metric Report Collection in Redfish
- Telemetry Service.
- - name: interval
- type: uint64
- description: >
- Defines period of time in milliseconds when Report is updated with
- new readings. Minimal interval is defined in MinInterval property.
- - name: metricParams
- type: array[struct[array[object_path],enum[xyz.openbmc_project.Telemetry.Report.OperationType],string,string,enum[xyz.openbmc_project.Telemetry.Report.CollectionTimescope],uint64]]
- description: >
- Array of metric parameters where first parameter is an array of DBus
- sensor paths. Second parameter specifies operation type. Third is a
- metric Id and fourth is a metadata, both are used to store user
- details. Fifth and sixth are used for collection timescope and
- collection duration.
- returns:
- - name: reportPath
- type: object_path
- description: >
- Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
+ - name: AddReport
+ description: >
+ Create new object that represent Report with
+ xyz.openbmc_project.Telemetry.Report interface stored in path
+ /xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where
+ Domain and Name are parameters of this method.
+ parameters:
+ - name: name
+ type: string
+ description: >
+ Defines the name of report to be exposed over D-Bus. Service allows
+ to use separator '/' in name to group reports in directory.
+ - name: reportingType
+ type: enum[xyz.openbmc_project.Telemetry.Report.ReportingType]
+ description: Defines report type
+ - name: reportUpdates
+ type: enum[xyz.openbmc_project.Telemetry.Report.ReportUpdates]
+ description: Defines report update type
+ - name: appendLimit
+ type: size
+ description: >
+ Defines the maximum number of entries in 'Readings' property.
+ - name: emitsReadingsUpdate
+ type: boolean
+ description: >
+ Defines presence of PropertiesChanged signal for
+ xyz.openbmc_project.Telmetry.Report.Readings property.
+ - name: logToMetricReportsCollection
+ type: boolean
+ description: >
+ Defines presence of Report in Metric Report Collection in Redfish
+ Telemetry Service.
+ - name: interval
+ type: uint64
+ description: >
+ Defines period of time in milliseconds when Report is updated with
+ new readings. Minimal interval is defined in MinInterval property.
+ - name: metricParams
+ type: array[struct[array[object_path],enum[xyz.openbmc_project.Telemetry.Report.OperationType],string,string,enum[xyz.openbmc_project.Telemetry.Report.CollectionTimescope],uint64]]
+ description: >
+ Array of metric parameters where first parameter is an array of DBus
+ sensor paths. Second parameter specifies operation type. Third is a
+ metric Id and fourth is a metadata, both are used to store user
+ details. Fifth and sixth are used for collection timescope and
+ collection duration.
+ returns:
+ - name: reportPath
+ type: object_path
+ description: >
+ Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
properties:
- - name: MaxReports
- type: size
- description: >
- Contains the max number of metric reports supported by the Telemetry.
- This property is added to be compliant with the Redfish Telemetry
- Service schema, that contains MaxReports property.
- flags:
- - const
- - name: MinInterval
- type: uint64
- description: >
- Minimal allowed time between readings property updates. It limits
- Interval property in xyz.openbmc_project.Telemetry.Report and
- interval parameter in AddReport method.
- flags:
- - const
+ - name: MaxReports
+ type: size
+ description: >
+ Contains the max number of metric reports supported by the Telemetry.
+ This property is added to be compliant with the Redfish Telemetry
+ Service schema, that contains MaxReports property.
+ flags:
+ - const
+ - name: MinInterval
+ type: uint64
+ description: >
+ Minimal allowed time between readings property updates. It limits
+ Interval property in xyz.openbmc_project.Telemetry.Report and
+ interval parameter in AddReport method.
+ flags:
+ - const
diff --git a/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
index bb6fd4d..b9984ff 100644
--- a/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
@@ -4,91 +4,91 @@
xyz.openbmc_project.Object.Delete for deletion of individual trigger.
properties:
- - name: Discrete
- type: boolean
- description: >
- If true than trigger uses discrete thresholds as threshold conditions.
- Otherwise numeric thresholds is used.
- flags:
- - const
- - name: TriggerActions
- type: array[enum[self.TriggerAction]]
- description: >
- Defines actions which are taken when threshold conditions are met.
- flags:
- - const
- - name: Persistent
- type: boolean
- description: Defines if Trigger is stored in non volatile memory.
- - name: ReportNames
- type: array[string]
- description: >
- Collection of report names that are updated when threshold conditions
- are met. List is ignored if TriggerActions property does not contain
- 'UpdateReport' action.
- - name: Sensors
- type: array[struct[object_path, string]]
- description: >
- Array of sensors that is monitored within trigger. First parameter of a
- structure is a sensor path. Second parameter is a metadata that is used
- to store user data about sensor.
- - name: Thresholds
- type: variant[array[struct[enum[self.Type],uint64,enum[self.Direction],double]],array[struct[string,enum[self.Severity],uint64,string]]]
- description: >
- First type in variant is a collection of numeric thresholds that has
- following fields - type, dwell time, direction and threshold value.
- Second type holds by variant is a collection of discrete thresholds that
- contains following fields - user id, severity, dwell time and threshold
- value. Discrete value does not need to be a number. Numeric threshold
- array is limited by Type enumeration, only 4 elements are allowed.
- Discrete threshold array size is not limited. If discrete threshold
- array is empty than every value change is taken into account of
- threshold condition. Dwell time specify for how long condition has to
- persist to trigger an action.
+ - name: Discrete
+ type: boolean
+ description: >
+ If true than trigger uses discrete thresholds as threshold conditions.
+ Otherwise numeric thresholds is used.
+ flags:
+ - const
+ - name: TriggerActions
+ type: array[enum[self.TriggerAction]]
+ description: >
+ Defines actions which are taken when threshold conditions are met.
+ flags:
+ - const
+ - name: Persistent
+ type: boolean
+ description: Defines if Trigger is stored in non volatile memory.
+ - name: ReportNames
+ type: array[string]
+ description: >
+ Collection of report names that are updated when threshold conditions
+ are met. List is ignored if TriggerActions property does not contain
+ 'UpdateReport' action.
+ - name: Sensors
+ type: array[struct[object_path, string]]
+ description: >
+ Array of sensors that is monitored within trigger. First parameter of a
+ structure is a sensor path. Second parameter is a metadata that is used
+ to store user data about sensor.
+ - name: Thresholds
+ type: variant[array[struct[enum[self.Type],uint64,enum[self.Direction],double]],array[struct[string,enum[self.Severity],uint64,string]]]
+ description: >
+ First type in variant is a collection of numeric thresholds that has
+ following fields - type, dwell time, direction and threshold value.
+ Second type holds by variant is a collection of discrete thresholds that
+ contains following fields - user id, severity, dwell time and threshold
+ value. Discrete value does not need to be a number. Numeric threshold
+ array is limited by Type enumeration, only 4 elements are allowed.
+ Discrete threshold array size is not limited. If discrete threshold
+ array is empty than every value change is taken into account of
+ threshold condition. Dwell time specify for how long condition has to
+ persist to trigger an action.
enumerations:
- - name: TriggerAction
- description: >
- Defines a action which is taken once threshold condition is met.
- values:
- - name: LogToLogService
- description: Trigger will log to journal.
- - name: RedfishEvent
- description: Trigger will log Redfish message.
- - name: UpdateReport
- description: >
- Trigger will update reports. Reports that will be updated are
- specified in ReportNames property.
- - name: Type
- description: >
- Defines a context of a message that is logged when numeric threshold
- condition is met.
- values:
- - name: LowerCritical
- - name: LowerWarning
- - name: UpperWarning
- - name: UpperCritical
- - name: Direction
- description: >
- Defines in which direction threshold value is crossed to fulfill numeric
- threshold condition.
- values:
- - name: Either
- description: >
- Crossing threshold value fulfill numeric threshold condition.
- - name: Decreasing
- description: >
- If threshold value is crossed and previous sensor value was greater
- then threshold value then numeric threshold condition is met.
- - name: Increasing
- description: >
- If threshold value is crossed and previous sensor value was less
- then threshold value then numeric threshold condition is met.
- - name: Severity
- description: >
- Defines a context of a message that is logged when discrete threshold
- condition is met.
- values:
- - name: OK
- - name: Warning
- - name: Critical
+ - name: TriggerAction
+ description: >
+ Defines a action which is taken once threshold condition is met.
+ values:
+ - name: LogToLogService
+ description: Trigger will log to journal.
+ - name: RedfishEvent
+ description: Trigger will log Redfish message.
+ - name: UpdateReport
+ description: >
+ Trigger will update reports. Reports that will be updated are
+ specified in ReportNames property.
+ - name: Type
+ description: >
+ Defines a context of a message that is logged when numeric threshold
+ condition is met.
+ values:
+ - name: LowerCritical
+ - name: LowerWarning
+ - name: UpperWarning
+ - name: UpperCritical
+ - name: Direction
+ description: >
+ Defines in which direction threshold value is crossed to fulfill numeric
+ threshold condition.
+ values:
+ - name: Either
+ description: >
+ Crossing threshold value fulfill numeric threshold condition.
+ - name: Decreasing
+ description: >
+ If threshold value is crossed and previous sensor value was greater
+ then threshold value then numeric threshold condition is met.
+ - name: Increasing
+ description: >
+ If threshold value is crossed and previous sensor value was less
+ then threshold value then numeric threshold condition is met.
+ - name: Severity
+ description: >
+ Defines a context of a message that is logged when discrete threshold
+ condition is met.
+ values:
+ - name: OK
+ - name: Warning
+ - name: Critical
diff --git a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
index a384ab0..e92d269 100644
--- a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
@@ -2,42 +2,41 @@
Implement to provide triggers management.
methods:
- - name: AddTrigger
- description:
- Create new object that represent Trigger with
- xyz.openbmc_project.Telemetry.Trigger interface stored in path
- /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
- Domain and Name are parameters of this method.
- parameters:
- - name: name
- type: string
- description: >
- Defines the name of report to be exposed over D-Bus. Service allows
- to use separator '/' in name to group reports in directory.
- - name: triggerActions
- type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
- description: >
- Defines which actions are taken when threshold conditions are met.
- - name: sensors
- type: array[struct[object_path,string]]
- description: >
- Array of sensors that is monitored within trigger. Object path
- points to a sensor in DBus envrionment. String is used as user
- metadata.
- - name: reportNames
- type: array[string]
- description: >
- Collection of report names that are updated when threshold
- conditions are met. This parameter is ignored if triggerActions
- parameter does not contain 'UpdateReport' action.
- - name: thresholds
- type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
- description: >
- Contains array of numeric or discrete thresholds that are described
- in xyz.openbmc_project.Telemetry.Trigger interface.
- returns:
- - name: triggerPath
- type: object_path
- description: >
- Path to new trigger ->
- /xyz/openbmc_project/Telemetry/Triggers/{name}.
+ - name: AddTrigger
+ description: Create new object that represent Trigger with
+ xyz.openbmc_project.Telemetry.Trigger interface stored in path
+ /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
+ Domain and Name are parameters of this method.
+ parameters:
+ - name: name
+ type: string
+ description: >
+ Defines the name of report to be exposed over D-Bus. Service allows
+ to use separator '/' in name to group reports in directory.
+ - name: triggerActions
+ type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
+ description: >
+ Defines which actions are taken when threshold conditions are met.
+ - name: sensors
+ type: array[struct[object_path,string]]
+ description: >
+ Array of sensors that is monitored within trigger. Object path
+ points to a sensor in DBus envrionment. String is used as user
+ metadata.
+ - name: reportNames
+ type: array[string]
+ description: >
+ Collection of report names that are updated when threshold
+ conditions are met. This parameter is ignored if triggerActions
+ parameter does not contain 'UpdateReport' action.
+ - name: thresholds
+ type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
+ description: >
+ Contains array of numeric or discrete thresholds that are described
+ in xyz.openbmc_project.Telemetry.Trigger interface.
+ returns:
+ - name: triggerPath
+ type: object_path
+ description: >
+ Path to new trigger ->
+ /xyz/openbmc_project/Telemetry/Triggers/{name}.