Skip to content

Commit a240fa4

Browse files
committed
Review feedback
1 parent c1e6f46 commit a240fa4

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/general/attribute-requirement-level.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ decision.
123123
## Migrate
124124

125125
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.
127127
Under no circumstances should this attribute be added to an existing instrumentation.
128128

129129
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
132132

133133
Should continue emitting the attribute unless:
134134

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.
136136
* 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
138138
the previous major version for at least 6 months.
139139

140140
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.
141141

142142
### Long-term Unstable Instrumentation
143143

144144
> [!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
146146
> their stability is following that of the signal they are implementing.
147147
148148
Should stop emitting the attribute unless:
149149

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.
151151
* User has included the attribute via explicit configuration
152152

153153
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
170170
Should continue emitting the attribute unless:
171171

172172
* 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
174174
the previous major version for at least 6 months.
175175

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.
177178

178179
### Long-term Unstable Instrumentation
179180

0 commit comments

Comments
 (0)