File: cicd_attributes.h

package info (click to toggle)
opentelemetry-cpp 1.23.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,368 kB
  • sloc: cpp: 96,239; sh: 1,766; makefile: 38; python: 31
file content (258 lines) | stat: -rw-r--r-- 6,921 bytes parent folder | download
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

/*
 * DO NOT EDIT, this is an Auto-generated file from:
 * buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2
 */

#pragma once

#include "opentelemetry/common/macros.h"
#include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace semconv
{
namespace cicd
{

/**
  The kind of action a pipeline run is performing.
 */
static constexpr const char *kCicdPipelineActionName = "cicd.pipeline.action.name";

/**
  The human readable name of the pipeline within a CI/CD system.
 */
static constexpr const char *kCicdPipelineName = "cicd.pipeline.name";

/**
  The result of a pipeline run.
 */
static constexpr const char *kCicdPipelineResult = "cicd.pipeline.result";

/**
  The unique identifier of a pipeline run within a CI/CD system.
 */
static constexpr const char *kCicdPipelineRunId = "cicd.pipeline.run.id";

/**
  The pipeline run goes through these states during its lifecycle.
 */
static constexpr const char *kCicdPipelineRunState = "cicd.pipeline.run.state";

/**
  The <a href="https://wikipedia.org/wiki/URL">URL</a> of the pipeline run, providing the complete
  address in order to locate and identify the pipeline run.
 */
static constexpr const char *kCicdPipelineRunUrlFull = "cicd.pipeline.run.url.full";

/**
  The human readable name of a task within a pipeline. Task here most closely aligns with a <a
  href="https://wikipedia.org/wiki/Pipeline_(computing)">computing process</a> in a pipeline. Other
  terms for tasks include commands, steps, and procedures.
 */
static constexpr const char *kCicdPipelineTaskName = "cicd.pipeline.task.name";

/**
  The unique identifier of a task run within a pipeline.
 */
static constexpr const char *kCicdPipelineTaskRunId = "cicd.pipeline.task.run.id";

/**
  The result of a task run.
 */
static constexpr const char *kCicdPipelineTaskRunResult = "cicd.pipeline.task.run.result";

/**
  The <a href="https://wikipedia.org/wiki/URL">URL</a> of the pipeline task run, providing the
  complete address in order to locate and identify the pipeline task run.
 */
static constexpr const char *kCicdPipelineTaskRunUrlFull = "cicd.pipeline.task.run.url.full";

/**
  The type of the task within a pipeline.
 */
static constexpr const char *kCicdPipelineTaskType = "cicd.pipeline.task.type";

/**
  The name of a component of the CICD system.
 */
static constexpr const char *kCicdSystemComponent = "cicd.system.component";

/**
  The unique identifier of a worker within a CICD system.
 */
static constexpr const char *kCicdWorkerId = "cicd.worker.id";

/**
  The name of a worker within a CICD system.
 */
static constexpr const char *kCicdWorkerName = "cicd.worker.name";

/**
  The state of a CICD worker / agent.
 */
static constexpr const char *kCicdWorkerState = "cicd.worker.state";

/**
  The <a href="https://wikipedia.org/wiki/URL">URL</a> of the worker, providing the complete address
  in order to locate and identify the worker.
 */
static constexpr const char *kCicdWorkerUrlFull = "cicd.worker.url.full";

namespace CicdPipelineActionNameValues
{
/**
  The pipeline run is executing a build.
 */
static constexpr const char *kBuild = "BUILD";

/**
  The pipeline run is executing.
 */
static constexpr const char *kRun = "RUN";

/**
  The pipeline run is executing a sync.
 */
static constexpr const char *kSync = "SYNC";

}  // namespace CicdPipelineActionNameValues

namespace CicdPipelineResultValues
{
/**
  The pipeline run finished successfully.
 */
static constexpr const char *kSuccess = "success";

/**
  The pipeline run did not finish successfully, eg. due to a compile error or a failing test. Such
  failures are usually detected by non-zero exit codes of the tools executed in the pipeline run.
 */
static constexpr const char *kFailure = "failure";

/**
  The pipeline run failed due to an error in the CICD system, eg. due to the worker being killed.
 */
static constexpr const char *kError = "error";

/**
  A timeout caused the pipeline run to be interrupted.
 */
static constexpr const char *kTimeout = "timeout";

/**
  The pipeline run was cancelled, eg. by a user manually cancelling the pipeline run.
 */
static constexpr const char *kCancellation = "cancellation";

/**
  The pipeline run was skipped, eg. due to a precondition not being met.
 */
static constexpr const char *kSkip = "skip";

}  // namespace CicdPipelineResultValues

namespace CicdPipelineRunStateValues
{
/**
  The run pending state spans from the event triggering the pipeline run until the execution of the
  run starts (eg. time spent in a queue, provisioning agents, creating run resources).
 */
static constexpr const char *kPending = "pending";

/**
  The executing state spans the execution of any run tasks (eg. build, test).
 */
static constexpr const char *kExecuting = "executing";

/**
  The finalizing state spans from when the run has finished executing (eg. cleanup of run
  resources).
 */
static constexpr const char *kFinalizing = "finalizing";

}  // namespace CicdPipelineRunStateValues

namespace CicdPipelineTaskRunResultValues
{
/**
  The task run finished successfully.
 */
static constexpr const char *kSuccess = "success";

/**
  The task run did not finish successfully, eg. due to a compile error or a failing test. Such
  failures are usually detected by non-zero exit codes of the tools executed in the task run.
 */
static constexpr const char *kFailure = "failure";

/**
  The task run failed due to an error in the CICD system, eg. due to the worker being killed.
 */
static constexpr const char *kError = "error";

/**
  A timeout caused the task run to be interrupted.
 */
static constexpr const char *kTimeout = "timeout";

/**
  The task run was cancelled, eg. by a user manually cancelling the task run.
 */
static constexpr const char *kCancellation = "cancellation";

/**
  The task run was skipped, eg. due to a precondition not being met.
 */
static constexpr const char *kSkip = "skip";

}  // namespace CicdPipelineTaskRunResultValues

namespace CicdPipelineTaskTypeValues
{
/**
  build
 */
static constexpr const char *kBuild = "build";

/**
  test
 */
static constexpr const char *kTest = "test";

/**
  deploy
 */
static constexpr const char *kDeploy = "deploy";

}  // namespace CicdPipelineTaskTypeValues

namespace CicdWorkerStateValues
{
/**
  The worker is not performing work for the CICD system. It is available to the CICD system to
  perform work on (online / idle).
 */
static constexpr const char *kAvailable = "available";

/**
  The worker is performing work for the CICD system.
 */
static constexpr const char *kBusy = "busy";

/**
  The worker is not available to the CICD system (disconnected / down).
 */
static constexpr const char *kOffline = "offline";

}  // namespace CicdWorkerStateValues

}  // namespace cicd
}  // namespace semconv
OPENTELEMETRY_END_NAMESPACE