You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The [URL](https://wikipedia.org/wiki/URL) of the pipeline task run, providing the complete address in order to locate and identify the pipeline task run.
@@ -65,11 +75,35 @@
65
75
The name of a component of the CICD system.
66
76
"""
67
77
78
+
CICD_WORKER_ID: Final="cicd.worker.id"
79
+
"""
80
+
The unique identifier of a worker within a CICD system.
The [URL](https://wikipedia.org/wiki/URL) of the worker, providing the complete address in order to locate and identify the worker.
96
+
"""
97
+
98
+
99
+
classCicdPipelineActionNameValues(Enum):
100
+
BUILD="BUILD"
101
+
"""The pipeline run is executing a build."""
102
+
RUN="RUN"
103
+
"""The pipeline run is executing."""
104
+
SYNC="SYNC"
105
+
"""The pipeline run is executing a sync."""
106
+
73
107
74
108
classCicdPipelineResultValues(Enum):
75
109
SUCCESS="success"
@@ -95,6 +129,21 @@ class CicdPipelineRunStateValues(Enum):
95
129
"""The finalizing state spans from when the run has finished executing (eg. cleanup of run resources)."""
96
130
97
131
132
+
classCicdPipelineTaskRunResultValues(Enum):
133
+
SUCCESS="success"
134
+
"""The task run finished successfully."""
135
+
FAILURE="failure"
136
+
"""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."""
137
+
ERROR="error"
138
+
"""The task run failed due to an error in the CICD system, eg. due to the worker being killed."""
139
+
TIMEOUT="timeout"
140
+
"""A timeout caused the task run to be interrupted."""
141
+
CANCELLATION="cancellation"
142
+
"""The task run was cancelled, eg. by a user manually cancelling the task run."""
143
+
SKIP="skip"
144
+
"""The task run was skipped, eg. due to a precondition not being met."""
Copy file name to clipboardExpand all lines: opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/code_attributes.py
+5-20Lines changed: 5 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -21,12 +21,12 @@
21
21
22
22
CODE_COLUMN_NUMBER: Final="code.column.number"
23
23
"""
24
-
The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`.
24
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.code_attributes.CODE_COLUMN_NUMBER`.
25
25
"""
26
26
27
27
CODE_FILE_PATH: Final="code.file.path"
28
28
"""
29
-
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
29
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.code_attributes.CODE_FILE_PATH`.
30
30
"""
31
31
32
32
CODE_FILEPATH: Final="code.filepath"
@@ -41,27 +41,12 @@
41
41
42
42
CODE_FUNCTION_NAME: Final="code.function.name"
43
43
"""
44
-
The method or function fully-qualified name without arguments. The value should fit the natural representation of the language runtime, which is also likely the same used within `code.stacktrace` attribute value.
45
-
Note: Values and format depends on each language runtime, thus it is impossible to provide an exhaustive list of examples.
46
-
The values are usually the same (or prefixes of) the ones found in native stack trace representation stored in
47
-
`code.stacktrace` without information on arguments.
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.code_attributes.CODE_FUNCTION_NAME`.
60
45
"""
61
46
62
47
CODE_LINE_NUMBER: Final="code.line.number"
63
48
"""
64
-
The line number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`.
49
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.code_attributes.CODE_LINE_NUMBER`.
65
50
"""
66
51
67
52
CODE_LINENO: Final="code.lineno"
@@ -76,5 +61,5 @@
76
61
77
62
CODE_STACKTRACE: Final="code.stacktrace"
78
63
"""
79
-
A stacktrace as a string in the natural representation for the language runtime. The representation is identical to [`exception.stacktrace`](/docs/exceptions/exceptions-spans.md#stacktrace-representation).
64
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.code_attributes.CODE_STACKTRACE`.
Copy file name to clipboardExpand all lines: opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/container_attributes.py
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,7 @@
82
82
CONTAINER_LABEL_TEMPLATE: Final="container.label"
83
83
"""
84
84
Container labels, `<key>` being the label name, the value being the label value.
85
+
Note: For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`.
The name of the database, fully qualified within the server address and port.
190
-
Note: If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid.
191
-
Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system.
192
-
It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
181
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_NAMESPACE`.
A database operation parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value.
227
-
Note: If a parameter has no name and instead is referenced only by index, then `<key>` SHOULD be the 0-based index.
228
-
If `db.query.text` is also captured, then `db.operation.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`.
229
-
`db.operation.parameter.<key>` SHOULD NOT be captured on batch operations.
202
+
Note: For example, a client-side maximum number of rows to read from the database
203
+
MAY be recorded as the `db.operation.parameter.max_rows` attribute.
204
+
205
+
`db.query.text` parameters SHOULD be captured using `db.query.parameter.<key>`
A database query parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value.
212
+
Note: If a query parameter has no name and instead is referenced only by index,
213
+
then `<key>` SHOULD be the 0-based index.
214
+
215
+
`db.query.parameter.<key>` SHOULD match
216
+
up with the parameterized placeholders present in `db.query.text`.
217
+
218
+
`db.query.parameter.<key>` SHOULD NOT be captured on batch operations.
219
+
220
+
Examples:
221
+
222
+
- For a query `SELECT * FROM users where username = %s` with the parameter `"jdoe"`,
223
+
the attribute `db.query.parameter.0` SHOULD be set to `"jdoe"`.
224
+
225
+
- For a query `"SELECT * FROM users WHERE username = %(username)s;` with parameter
226
+
`username = "jdoe"`, the attribute `db.query.parameter.username` SHOULD be set to `"jdoe"`.
235
227
"""
236
228
237
229
DB_QUERY_SUMMARY: Final="db.query.summary"
238
230
"""
239
-
Low cardinality representation of a database query text.
240
-
Note: `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
241
-
Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
231
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_QUERY_SUMMARY`.
242
232
"""
243
233
244
234
DB_QUERY_TEXT: Final="db.query.text"
245
235
"""
246
-
The database query being executed.
247
-
Note: For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
248
-
For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
249
-
Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
236
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_QUERY_TEXT`.
Note: The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
266
-
Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system.
251
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_RESPONSE_STATUS_CODE`.
The name of a stored procedure within the database.
282
-
Note: It is RECOMMENDED to capture the value as provided by the application
283
-
without attempting to do any case normalization.
284
-
285
-
For batch operations, if the individual operations are known to have the same
286
-
stored procedure name then that stored procedure name SHOULD be used.
266
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_STORED_PROCEDURE_NAME`.
287
267
"""
288
268
289
269
DB_SYSTEM: Final="db.system"
@@ -293,8 +273,7 @@
293
273
294
274
DB_SYSTEM_NAME: Final="db.system.name"
295
275
"""
296
-
The database management system (DBMS) product as identified by the client instrumentation.
297
-
Note: The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system.name` is set to `postgresql` based on the instrumentation's best knowledge.
276
+
Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DB_SYSTEM_NAME`.
298
277
"""
299
278
300
279
DB_USER: Final="db.user"
@@ -477,19 +456,19 @@ class DbSystemValues(Enum):
477
456
INTERBASE="interbase"
478
457
"""InterBase."""
479
458
MARIADB="mariadb"
480
-
"""MariaDB (This value has stability level RELEASE CANDIDATE)."""
459
+
"""MariaDB."""
481
460
MAXDB="maxdb"
482
461
"""SAP MaxDB."""
483
462
MEMCACHED="memcached"
484
463
"""Memcached."""
485
464
MONGODB="mongodb"
486
465
"""MongoDB."""
487
466
MSSQL="mssql"
488
-
"""Microsoft SQL Server (This value has stability level RELEASE CANDIDATE)."""
467
+
"""Microsoft SQL Server."""
489
468
MSSQLCOMPACT="mssqlcompact"
490
469
"""Deprecated: Removed, use `other_sql` instead."""
491
470
MYSQL="mysql"
492
-
"""MySQL (This value has stability level RELEASE CANDIDATE)."""
471
+
"""MySQL."""
493
472
NEO4J="neo4j"
494
473
"""Neo4j."""
495
474
NETEZZA="netezza"
@@ -503,7 +482,7 @@ class DbSystemValues(Enum):
503
482
POINTBASE="pointbase"
504
483
"""PointBase."""
505
484
POSTGRESQL="postgresql"
506
-
"""PostgreSQL (This value has stability level RELEASE CANDIDATE)."""
485
+
"""PostgreSQL."""
507
486
PROGRESS="progress"
508
487
"""Progress Database."""
509
488
REDIS="redis"
@@ -524,6 +503,9 @@ class DbSystemValues(Enum):
524
503
"""Vertica."""
525
504
526
505
506
+
@deprecated(
507
+
reason="Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DbSystemNameValues`."
508
+
) # type: ignore
527
509
classDbSystemNameValues(Enum):
528
510
OTHER_SQL="other_sql"
529
511
"""Some other SQL database. Fallback only."""
@@ -578,23 +560,23 @@ class DbSystemNameValues(Enum):
578
560
INSTANTDB="instantdb"
579
561
"""[Instant](https://www.instantdb.com/)."""
580
562
MARIADB="mariadb"
581
-
"""[MariaDB](https://mariadb.org/)."""
563
+
"""Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.db_attributes.DbSystemNameValues.MARIADB`."""
0 commit comments