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