1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
From 34d6bfbcdea771bbfa957fe72f9e3070ccec4202 Mon Sep 17 00:00:00 2001
From: eportnov <eportnov@ibs.ru>
Date: Fri, 15 Jul 2022 17:27:25 +0300
Subject: [PATCH] repair_telemetry_yaml
---
.../Telemetry/ReportManager.interface.yaml | 111 +++++++++++++++---
1 file changed, 95 insertions(+), 16 deletions(-)
diff --git a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
index ae8d36f..decc3d0 100644
--- a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
@@ -10,21 +10,19 @@ methods:
/xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where
Domain and Name are parameters of this method.
parameters:
- - name: name
+ - name: reportId
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
+ type: string
description: >
- Defines the maximum number of entries in 'Readings' property.
+ Defines report type
+ Variants:
+ - Periodic
+ - OnRequest
+ - OnChange
- name: emitsReadingsUpdate
type: boolean
description: >
@@ -35,25 +33,106 @@ methods:
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(default: 1000).
+ - name: metricParams
+ type: array[struct[object_path,string,string,string]]
+ description: >
+ Array of struct of metric parameters where:
+ - first parameter is an array of DBus
+ sensor paths(example /xyz/openbmc_project/sensors/voltage/PVCCIN_CPU1);
+ - second parameter specifies operation type.
+ Variants:
+ -- Maximum
+ -- Minimum
+ -- Average
+ -- Summation
+ - third is a metric Id (store by a user)
+ - fourth is a metadata (store by a user)
+ returns:
+ - name: reportPath
+ type: object_path
+ description: >
+ Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
+
+ - name: AddReportFutureVersion
+ 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: reportId
+ 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: reportName
+ 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: string
+ description: >
+ Defines report type
+ Variants:
+ - Periodic
+ - OnRequest
+ - OnChange
+ - name: reportUpdates
+ type: string
+ description: >
+ Defines report updates
+ Variants:
+ - Overwrite
+ - AppendStopsWhenFull
+ - AppendWrapsWhenFull
+ - name: appendLimit
+ type: uint64
+ description: >
+ Defines limit of values
+ - name: reportActions
+ type: array[string]
+ description: >
+ Defines report actions
+ May add variants:
+ - EmitsReadingsUpdate
+ - LogToMetricReportsCollection
- 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]]
+ type: array[struct[array[struct[object_path,string]],string,string,string,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.
+ Array of struct of metric parameters where:
+ - first parameter is an array of struct of:
+ -- DBus sensor paths
+ (example /xyz/openbmc_project/sensors/voltage/PVCCIN_CPU1);
+ -- metadata (store by a user);
+ - second parameter specifies operation type
+ Variants:
+ -- Maximum
+ -- Minimum
+ -- Average
+ -- Summation
+ - third is a metric Id (store by a user)
+ - fourth is a CollectionTimeScope
+ Variants:
+ -- Point;
+ -- Interval;
+ -- StartupInterval;
+ - fifth is a CollectionTimeScope period
returns:
- name: reportPath
type: object_path
description: >
Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
-
properties:
- name: MaxReports
type: size
|
