| Krzysztof Grobelny | 5364764 | 2020-06-25 11:45:38 +0200 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide reports management. Contain information about report |
| 3 | limitations and allows to add report. |
| 4 | |
| 5 | methods: |
| 6 | - name: AddReport |
| 7 | description: > |
| 8 | Create new object that represent Report with |
| 9 | xyz.openbmc_project.Telemetry.Report interface stored in path |
| 10 | /xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where |
| 11 | Domain and Name are parameters of this method. |
| 12 | parameters: |
| 13 | - name: name |
| 14 | type: string |
| 15 | description: > |
| 16 | Defines the name of report to be exposed over D-Bus. Service allows |
| 17 | to use separator '/' in name to group reports in directory. |
| 18 | - name: reportingType |
| 19 | type: enum[xyz.openbmc_project.Telemetry.Report.ReportingType] |
| 20 | description: Defines report type |
| 21 | - name: emitsReadingsUpdate |
| 22 | type: boolean |
| 23 | description: > |
| 24 | Defines presence of PropertiesChanged signal for |
| 25 | xyz.openbmc_project.Telmetry.Report.Readings property. |
| 26 | - name: logToMetricReportsCollection |
| 27 | type: boolean |
| 28 | description: > |
| 29 | Defines presence of Report in Metric Report Collection in Redfish |
| 30 | Telemetry Service. |
| 31 | - name: interval |
| 32 | type: uint64 |
| 33 | description: > |
| 34 | Defines period of time in milliseconds when Report is updated with |
| 35 | new readings. Minimal interval is defined in MinInterval property. |
| 36 | - name: metricParams |
| Wludzik, Jozef | 9969a5b | 2021-02-03 15:39:37 +0100 | [diff] [blame^] | 37 | type: array[struct[object_path,enum[xyz.openbmc_project.Telemetry.Report.OperationType],string,string]] |
| Krzysztof Grobelny | 5364764 | 2020-06-25 11:45:38 +0200 | [diff] [blame] | 38 | description: > |
| Wludzik, Jozef | 9969a5b | 2021-02-03 15:39:37 +0100 | [diff] [blame^] | 39 | Array of metric parameters where first parameter is a DBus sensor |
| 40 | path. Second parameter specifies operation type. Third is a metric |
| 41 | Id and fourth is a metadata, both are used to store user details. |
| Krzysztof Grobelny | 5364764 | 2020-06-25 11:45:38 +0200 | [diff] [blame] | 42 | returns: |
| 43 | - name: reportPath |
| 44 | type: object_path |
| 45 | description: > |
| 46 | Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}. |
| 47 | |
| 48 | properties: |
| 49 | - name: MaxReports |
| 50 | type: size |
| 51 | description: > |
| 52 | Contains the max number of metric reports supported by the Telemetry. |
| 53 | This property is added to be compliant with the Redfish Telemetry |
| 54 | Service schema, that contains MaxReports property. |
| 55 | flags: |
| 56 | - const |
| 57 | - name: MinInterval |
| 58 | type: uint64 |
| 59 | description: > |
| 60 | Minimal allowed time between readings property updates. It limits |
| 61 | Interval property in xyz.openbmc_project.Telemetry.Report and |
| 62 | interval parameter in AddReport method. |
| 63 | flags: |
| 64 | - const |