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
Copy file name to clipboardExpand all lines: docs/general/attribute-requirement-level.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ decision.
123
123
## Migrate
124
124
125
125
The migrate requirement level is reserved for deprecated attributes and is
126
-
designed to help support a allowing for a phased rollout of the stable semantic conventions.
126
+
designed to help support achieving a phased rollout of the stable semantic conventions.
127
127
Under no circumstances should this attribute be added to an existing instrumentation.
128
128
129
129
The type of instrumentation helps to determine how the attribute should be handled, see below.
@@ -132,22 +132,22 @@ The type of instrumentation helps to determine how the attribute should be handl
132
132
133
133
Should continue emitting the attribute unless:
134
134
135
-
* User has set the domain ie`database` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
135
+
* User has set the domain e.g.`database` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
136
136
* User has excluded the attribute via explicit configuration
137
-
* The instrumentation bumps it's major version but will continue providing security patches for
137
+
* The instrumentation bumps its major version but will continue providing security patches for
138
138
the previous major version for at least 6 months.
139
139
140
140
Removal can occur when the major version is bumped provided previous major version will/has received 6 months of security patches from the time the replacement attribute is introduced.
141
141
142
142
### Long-term Unstable Instrumentation
143
143
144
144
> [!NOTE]
145
-
> Example's of long term unstable instrumentation, would be the OpenTelemetry Contrib packages as
145
+
> Examples of long term unstable instrumentation, would be the OpenTelemetry Contrib packages as
146
146
> their stability is following that of the signal they are implementing.
147
147
148
148
Should stop emitting the attribute unless:
149
149
150
-
* User has set the domain ie`database/dup` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
150
+
* User has set the domain e.g.`database/dup` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
151
151
* User has included the attribute via explicit configuration
152
152
153
153
Removal can occur when the deployment level of the package changes. For instance a beta package moves to release candidate.
@@ -170,10 +170,11 @@ The type of instrumentation helps to determine how the attribute should be handl
170
170
Should continue emitting the attribute unless:
171
171
172
172
* User has excluded the attribute via explicit configuration
173
-
* The instrumentation bumps it's major version but will continue providing security patches for
173
+
* The instrumentation bumps its major version but will continue providing security patches for
174
174
the previous major version for at least 6 months.
175
175
176
-
Removal can occur when the major version is bumped provided previous major version will/has received 6 months of security patches from the time the replacement attribute is introduced.
176
+
Removal can occur when the major version is bumped provided that previous major version will/has
177
+
received 6 months of security patches from the time that the default behaviour was changed to not emit.
0 commit comments