xref: /openbmc/bmcweb/features/redfish/include/registries/telemetry_message_registry.hpp (revision 665e7602d5580dfe69a9686f35ef40f8f64673df) 
1*665e7602SGunnar Mills #pragma once
2*665e7602SGunnar Mills /****************************************************************
3*665e7602SGunnar Mills  *                 READ THIS WARNING FIRST
4*665e7602SGunnar Mills  * This is an auto-generated header which contains definitions
5*665e7602SGunnar Mills  * for Redfish DMTF defined messages.
6*665e7602SGunnar Mills  * DO NOT modify this registry outside of running the
7*665e7602SGunnar Mills  * parse_registries.py script.  The definitions contained within
8*665e7602SGunnar Mills  * this file are owned by DMTF.  Any modifications to these files
9*665e7602SGunnar Mills  * should be first pushed to the relevant registry in the DMTF
10*665e7602SGunnar Mills  * github organization.
11*665e7602SGunnar Mills  ***************************************************************/
12*665e7602SGunnar Mills #include "registries.hpp"
13*665e7602SGunnar Mills 
14*665e7602SGunnar Mills #include <array>
15*665e7602SGunnar Mills 
16*665e7602SGunnar Mills // clang-format off
17*665e7602SGunnar Mills 
18*665e7602SGunnar Mills namespace redfish::registries::telemetry
19*665e7602SGunnar Mills {
20*665e7602SGunnar Mills const Header header = {
21*665e7602SGunnar Mills     "Copyright 2023 DMTF. All rights reserved.",
22*665e7602SGunnar Mills     "#MessageRegistry.v1_6_2.MessageRegistry",
23*665e7602SGunnar Mills     "Telemetry.1.0.0",
24*665e7602SGunnar Mills     "Telemetry Message Registry",
25*665e7602SGunnar Mills     "en",
26*665e7602SGunnar Mills     "This registry defines the messages for telemetry related events.",
27*665e7602SGunnar Mills     "Telemetry",
28*665e7602SGunnar Mills     "1.0.0",
29*665e7602SGunnar Mills     "DMTF",
30*665e7602SGunnar Mills };
31*665e7602SGunnar Mills constexpr const char* url =
32*665e7602SGunnar Mills     "https://redfish.dmtf.org/registries/Telemetry.1.0.0.json";
33*665e7602SGunnar Mills 
34*665e7602SGunnar Mills constexpr std::array registry =
35*665e7602SGunnar Mills {
36*665e7602SGunnar Mills     MessageEntry{
37*665e7602SGunnar Mills         "TriggerDiscreteConditionMet",
38*665e7602SGunnar Mills         {
39*665e7602SGunnar Mills             "Indicates that a discrete trigger condition is met.",
40*665e7602SGunnar Mills             "Metric '%1' has the value '%2', which meets the discrete condition of trigger '%3'",
41*665e7602SGunnar Mills             "OK",
42*665e7602SGunnar Mills             3,
43*665e7602SGunnar Mills             {
44*665e7602SGunnar Mills                 "string",
45*665e7602SGunnar Mills                 "string",
46*665e7602SGunnar Mills                 "string",
47*665e7602SGunnar Mills             },
48*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
49*665e7602SGunnar Mills         }},
50*665e7602SGunnar Mills     MessageEntry{
51*665e7602SGunnar Mills         "TriggerNumericAboveLowerCritical",
52*665e7602SGunnar Mills         {
53*665e7602SGunnar Mills             "Indicates that a numeric metric reading is no longer below the lower critical trigger threshold, but is still outside of normal operating range.",
54*665e7602SGunnar Mills             "Metric '%1' value of %2 is now above the %3 lower critical threshold of trigger '%4' but remains outside of normal range",
55*665e7602SGunnar Mills             "Warning",
56*665e7602SGunnar Mills             4,
57*665e7602SGunnar Mills             {
58*665e7602SGunnar Mills                 "string",
59*665e7602SGunnar Mills                 "number",
60*665e7602SGunnar Mills                 "number",
61*665e7602SGunnar Mills                 "string",
62*665e7602SGunnar Mills             },
63*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
64*665e7602SGunnar Mills         }},
65*665e7602SGunnar Mills     MessageEntry{
66*665e7602SGunnar Mills         "TriggerNumericAboveUpperCritical",
67*665e7602SGunnar Mills         {
68*665e7602SGunnar Mills             "Indicates that a numeric metric reading is above the upper critical trigger threshold.",
69*665e7602SGunnar Mills             "Metric '%1' value of %2 is above the %3 upper critical threshold of trigger '%4'",
70*665e7602SGunnar Mills             "Critical",
71*665e7602SGunnar Mills             4,
72*665e7602SGunnar Mills             {
73*665e7602SGunnar Mills                 "string",
74*665e7602SGunnar Mills                 "number",
75*665e7602SGunnar Mills                 "number",
76*665e7602SGunnar Mills                 "string",
77*665e7602SGunnar Mills             },
78*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
79*665e7602SGunnar Mills         }},
80*665e7602SGunnar Mills     MessageEntry{
81*665e7602SGunnar Mills         "TriggerNumericAboveUpperWarning",
82*665e7602SGunnar Mills         {
83*665e7602SGunnar Mills             "Indicates that a numeric metric reading is above the upper warning trigger threshold.",
84*665e7602SGunnar Mills             "Metric '%1' value of %2 is above the %3 upper warning threshold of trigger '%4'",
85*665e7602SGunnar Mills             "Warning",
86*665e7602SGunnar Mills             4,
87*665e7602SGunnar Mills             {
88*665e7602SGunnar Mills                 "string",
89*665e7602SGunnar Mills                 "number",
90*665e7602SGunnar Mills                 "number",
91*665e7602SGunnar Mills                 "string",
92*665e7602SGunnar Mills             },
93*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
94*665e7602SGunnar Mills         }},
95*665e7602SGunnar Mills     MessageEntry{
96*665e7602SGunnar Mills         "TriggerNumericBelowLowerCritical",
97*665e7602SGunnar Mills         {
98*665e7602SGunnar Mills             "Indicates that a numeric metric reading is below the lower critical trigger threshold.",
99*665e7602SGunnar Mills             "Metric '%1' value of %2 is below the %3 lower critical threshold of trigger '%4'",
100*665e7602SGunnar Mills             "Critical",
101*665e7602SGunnar Mills             4,
102*665e7602SGunnar Mills             {
103*665e7602SGunnar Mills                 "string",
104*665e7602SGunnar Mills                 "number",
105*665e7602SGunnar Mills                 "number",
106*665e7602SGunnar Mills                 "string",
107*665e7602SGunnar Mills             },
108*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
109*665e7602SGunnar Mills         }},
110*665e7602SGunnar Mills     MessageEntry{
111*665e7602SGunnar Mills         "TriggerNumericBelowLowerWarning",
112*665e7602SGunnar Mills         {
113*665e7602SGunnar Mills             "Indicates that a numeric metric reading is below the lower warning trigger threshold.",
114*665e7602SGunnar Mills             "Metric '%1' value of %2 is below the %3 lower warning threshold of trigger '%4'",
115*665e7602SGunnar Mills             "Warning",
116*665e7602SGunnar Mills             4,
117*665e7602SGunnar Mills             {
118*665e7602SGunnar Mills                 "string",
119*665e7602SGunnar Mills                 "number",
120*665e7602SGunnar Mills                 "number",
121*665e7602SGunnar Mills                 "string",
122*665e7602SGunnar Mills             },
123*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
124*665e7602SGunnar Mills         }},
125*665e7602SGunnar Mills     MessageEntry{
126*665e7602SGunnar Mills         "TriggerNumericBelowUpperCritical",
127*665e7602SGunnar Mills         {
128*665e7602SGunnar Mills             "Indicates that a numeric metric reading is no longer above the upper critical trigger threshold, but is still outside of normal operating range.",
129*665e7602SGunnar Mills             "Metric '%1' value of %2 is now below the %3 upper critical threshold of trigger '%4' but remains outside of normal range",
130*665e7602SGunnar Mills             "Warning",
131*665e7602SGunnar Mills             4,
132*665e7602SGunnar Mills             {
133*665e7602SGunnar Mills                 "string",
134*665e7602SGunnar Mills                 "number",
135*665e7602SGunnar Mills                 "number",
136*665e7602SGunnar Mills                 "string",
137*665e7602SGunnar Mills             },
138*665e7602SGunnar Mills             "Check the condition of the metric that reported the trigger.",
139*665e7602SGunnar Mills         }},
140*665e7602SGunnar Mills     MessageEntry{
141*665e7602SGunnar Mills         "TriggerNumericReadingNormal",
142*665e7602SGunnar Mills         {
143*665e7602SGunnar Mills             "Indicates that a numeric metric reading is now within normal operating range.",
144*665e7602SGunnar Mills             "Metric '%1' value of %2 is within normal operating range of trigger '%3'",
145*665e7602SGunnar Mills             "OK",
146*665e7602SGunnar Mills             3,
147*665e7602SGunnar Mills             {
148*665e7602SGunnar Mills                 "string",
149*665e7602SGunnar Mills                 "number",
150*665e7602SGunnar Mills                 "string",
151*665e7602SGunnar Mills             },
152*665e7602SGunnar Mills             "None.",
153*665e7602SGunnar Mills         }},
154*665e7602SGunnar Mills 
155*665e7602SGunnar Mills };
156*665e7602SGunnar Mills 
157*665e7602SGunnar Mills enum class Index
158*665e7602SGunnar Mills {
159*665e7602SGunnar Mills     triggerDiscreteConditionMet = 0,
160*665e7602SGunnar Mills     triggerNumericAboveLowerCritical = 1,
161*665e7602SGunnar Mills     triggerNumericAboveUpperCritical = 2,
162*665e7602SGunnar Mills     triggerNumericAboveUpperWarning = 3,
163*665e7602SGunnar Mills     triggerNumericBelowLowerCritical = 4,
164*665e7602SGunnar Mills     triggerNumericBelowLowerWarning = 5,
165*665e7602SGunnar Mills     triggerNumericBelowUpperCritical = 6,
166*665e7602SGunnar Mills     triggerNumericReadingNormal = 7,
167*665e7602SGunnar Mills };
168*665e7602SGunnar Mills } // namespace redfish::registries::telemetry
169