-
Notifications
You must be signed in to change notification settings - Fork 187
/
Copy pathotel.md
45 lines (31 loc) · 3.9 KB
/
otel.md
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
<!--- Hugo front matter used to generate the website version of this page:
--->
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# OTel
- [Otel](#otel-attributes)
- [Otel Library Deprecated](#otel-library-deprecated-attributes)
- [Otel Scope](#otel-scope-attributes)
## OTel Attributes
Attributes reserved for OpenTelemetry
| Attribute | Type | Description | Examples | Stability |
| ------------------------- | ------ | -------------------------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------- |
| `otel.status_code` | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. | `OK`; `ERROR` |  |
| `otel.status_description` | string | Description of the Status if it has a value, otherwise not set. | `resource not found` |  |
`otel.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
| ------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `ERROR` | The operation contains an error. |  |
| `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. |  |
## OTel Library Deprecated Attributes
Describes deprecated otel.library attributes.
| Attribute | Type | Description | Examples | Stability |
| ---------------------- | ------ | ----------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `otel.library.name` | string | | `io.opentelemetry.contrib.mongodb` | <br>use the `otel.scope.name` attribute. |
| `otel.library.version` | string | | `1.0.0` | <br>use the `otel.scope.version` attribute. |
## OTel Scope Attributes
Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts.
| Attribute | Type | Description | Examples | Stability |
| -------------------- | ------ | ------------------------------------------------------------------------------------ | ---------------------------------- | ---------------------------------------------------------- |
| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` |  |
| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` |  |