Skip to content

Commit 67f2f00

Browse files
committed
doc fixes
1 parent d3c1207 commit 67f2f00

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

docs/general/attribute-requirement-level.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@
1111
- [Conditionally Required](#conditionally-required)
1212
- [Recommended](#recommended)
1313
- [Opt-In](#opt-in)
14+
- [Migrate](#migrate)
15+
- [Stable Instrumentation](#stable-instrumentation)
16+
- [Long-term Unstable Instrumentation](#long-term-unstable-instrumentation)
17+
- [Unstable Instrumentation](#unstable-instrumentation)
18+
- [Remove](#remove)
19+
- [Stable Instrumentation](#stable-instrumentation-1)
20+
- [Long-term Unstable Instrumentation](#long-term-unstable-instrumentation-1)
21+
- [Unstable Instrumentation](#unstable-instrumentation-1)
1422
- [Performance suggestions](#performance-suggestions)
1523

1624
<!-- tocstop -->
@@ -115,36 +123,38 @@ decision.
115123
## Migrate
116124

117125
The migrate requirement level is reserved for deprecated attributes and is
118-
designed to help support a allowing for a phased rollout of the stable semantic conventions.
126+
designed to help support a allowing for a phased rollout of the stable semantic conventions.
119127
Under no circumstances should this attribute be added to an existing instrumentation.
120128

121129
The type of instrumentation helps to determine how the attribute should be handled, see below.
122130

123131
### Stable Instrumentation
124132

125133
Should continue emitting the attribute unless:
134+
126135
* User has set the domain ie `database` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
127136
* User has excluded the attribute via explicit configuration
128137
* The instrumentation bumps it's major version but will continue providing security patches for
129138
the previous major version for at least 6 months.
130139

131-
Removal can occur when the major version is bumped provided previous major version will/has recieved 6 months of security patches from the time the replacement attribute is introduced.
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.
132141

133142
### Long-term Unstable Instrumentation
134143

135144
> [!NOTE]
136-
> Example's of long term unstable instrumentation, would be the OpenTelemetry Contrib packages as
145+
> Example's of long term unstable instrumentation, would be the OpenTelemetry Contrib packages as
137146
> their stability is following that of the signal they are implementing.
138147
139148
Should stop emitting the attribute unless:
149+
140150
* User has set the domain ie `database/dup` via the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
141151
* User has included the attribute via explicit configuration
142152

143153
Removal can occur when the deployment level of the package changes. For instance a beta package moves to release candidate.
144154

145155
### Unstable Instrumentation
146156

147-
Removal can occur once the new attribute is implemented,
157+
Removal can occur once the new attribute is implemented,
148158
provided that the instrumentation does not fall into any of the other categories.
149159
Should that be the case the guidance for that category should be followed.
150160

@@ -158,15 +168,17 @@ The type of instrumentation helps to determine how the attribute should be handl
158168
### Stable Instrumentation
159169

160170
Should continue emitting the attribute unless:
171+
161172
* User has excluded the attribute via explicit configuration
162173
* The instrumentation bumps it's major version but will continue providing security patches for
163174
the previous major version for at least 6 months.
164175

165-
Removal can occur when the major version is bumped provided previous major version will/has recieved 6 months of security patches from the time the replacement attribute is introduced.
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.
166177

167178
### Long-term Unstable Instrumentation
168179

169180
Should stop emitting the attribute unless:
181+
170182
* User has included the attribute via explicit configuration
171183

172184
Removal can occur when the deployment level of the package changes. For instance a beta package moves to release candidate.

0 commit comments

Comments
 (0)