| Krzysztof Grobelny | 5364764 | 2020-06-25 11:45:38 +0200 | [diff] [blame] | 1 | description: > |
| 2 | Implement this interface to provide report inspection features. An |
| 3 | implementation service should additionally implement |
| 4 | xyz.openbmc_project.Object.Delete for deletion of individual report objects. |
| 5 | |
| 6 | methods: |
| 7 | - name: Update |
| 8 | description: > |
| 9 | The Update method is defined for the on demand metric report update. |
| 10 | It triggers update of the Readings property. If ReportingType is not |
| 11 | set to OnRequest then method does nothing. |
| 12 | |
| 13 | properties: |
| 14 | - name: Persistency |
| 15 | type: boolean |
| 16 | description: > |
| 17 | Defines if the report configuration is stored in non volatile memory. |
| 18 | Configuration contains all Report properties excluding Readings. |
| 19 | - name: ReadingParameters |
| 20 | type: array[struct[array[object_path],enum[self.OperationType],string,string]] |
| 21 | description: > |
| 22 | Array of structure that contains list of sensor paths, operation type, |
| 23 | metric Id and metadata. Metric Id and metadata are used to store user |
| 24 | details, e.g. metadata can be used to map sensor name to DBus path. |
| 25 | - name: Readings |
| 26 | type: struct[uint64,array[struct[string,string,double,uint64]]] |
| 27 | description: > |
| 28 | Structure that contains timestamp of readings update in milliseconds and |
| 29 | array of metric Id, metadata, reading value and timestamp of single |
| 30 | reading update in milliseconds. Metric Id and metadata are equal to its |
| 31 | counterparts in ReadingParameters property. |
| 32 | flags: |
| 33 | - readonly |
| 34 | - name: EmitsReadingsUpdate |
| 35 | type: boolean |
| 36 | description: > |
| 37 | On Readings update PropertiesChanged signal is emitted. It allows to |
| 38 | decrease generation of load on DBus when Readings property is updated. |
| 39 | Redfish Event Service requires this option to be equal to true. |
| 40 | flags: |
| 41 | - const |
| 42 | - name: LogToMetricReportsCollection |
| 43 | type: boolean |
| 44 | description: > |
| 45 | Presence of Report in Metric Report Collection in Redfish Telemetry |
| 46 | Service. |
| 47 | flags: |
| 48 | - const |
| 49 | - name: ReportingType |
| 50 | type: enum[self.ReportingType] |
| 51 | description: Defines how readings are updated. |
| 52 | - name: Interval |
| 53 | type: uint64 |
| 54 | description: > |
| 55 | Defines period of time in milliseconds when readings are updated. |
| 56 | |
| 57 | enumerations: |
| 58 | - name: OperationType |
| 59 | descritpion: Type of action that is executed on readings. |
| 60 | values: |
| 61 | - name: Single |
| 62 | description: Store a single reading, only allowed on single sensor. |
| 63 | - name: Max |
| 64 | description: Store maximal reading during defined time period. |
| 65 | - name: Min |
| 66 | description: Store minimal reading during defined time period. |
| 67 | - name: Avg |
| 68 | description: Calulate average of readings during defined time period. |
| 69 | - name: Sum |
| 70 | description: Calulate sum of readings over defined time period. |
| 71 | - name: ReportingType |
| 72 | description: > |
| 73 | The type that defines when Readings are updated. |
| 74 | values: |
| 75 | - name: OnChange |
| 76 | description: > |
| 77 | On sensor reading change. |
| 78 | - name: OnRequest |
| 79 | description: > |
| 80 | On Update method call. |
| 81 | - name: Periodic |
| 82 | description: > |
| 83 | After period of time defined by ScanPeriod property. |