Skip to content

Commit 21c9b85

Browse files
committed
Doc fix
1 parent 7f4627c commit 21c9b85

File tree

18 files changed

+49
-36
lines changed

18 files changed

+49
-36
lines changed

docs/database/database-metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
285285
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
286286

287287
**Past Attributes:**
288-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
288+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
289289
|---|---|---|---|---|---|
290290
| [`db.system`](/docs/registry/attributes/db.md) | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | `Rename` | Use [`db.system.name`](/docs/registry/attributes/db.md) instead. |
291291

@@ -581,7 +581,7 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
581581
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
582582

583583
**Past Attributes:**
584-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
584+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
585585
|---|---|---|---|---|---|
586586
| [`db.system`](/docs/registry/attributes/db.md) | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | `Rename` | Use [`db.system.name`](/docs/registry/attributes/db.md) instead. |
587587

docs/database/database-spans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
351351
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
352352

353353
**Past Attributes:**
354-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
354+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
355355
|---|---|---|---|---|---|
356356
| [`db.connection_string`](/docs/registry/attributes/db.md) | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | `Update` | Replaced by `server.address` and `server.port`.
357357
|

docs/exceptions/exceptions-spans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This event describes a single exception.
4242
**[2] `exception.type`:** Required if `exception.message` is not set, recommended otherwise.
4343

4444
**Past Attributes:**
45-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
45+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
4646
|---|---|---|---|---|---|
4747
| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | `Drop` | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span.
4848
|

docs/general/attribute-deprecation-action.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ Should follow the definition of the [Drop Action](#drop) for how to proceed.
6262

6363
## Rename
6464

65-
The implementation is able to rename the attribute currently being emitted without needing to support the existing attribute anymore.
65+
The implementation is able to rename the attribute currently being emitted without needing to support the existing attribute anymore.
6666

67-
This equivilant to adding a new attribute and performing the [Drop Action](#drop) on the old attribute.
67+
This equivalent to adding a new attribute and performing the [Drop Action](#drop) on the old attribute.
6868

6969
## Remove
7070

@@ -109,6 +109,5 @@ There is no ability for a user to configure that attribute to be emitted.
109109

110110
Under no circumstances should this attribute be added to an existing instrumentation.
111111

112-
113112
[DocumentStatus]:
114113
https://opentelemetry.io/docs/specs/otel/document-status

docs/http/http-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original
250250
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
251251

252252
**Past Attributes:**
253-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
253+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
254254
|---|---|---|---|---|---|
255255
| [`http.method`](/docs/registry/attributes/http.md) | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | `Rename` | Use [`http.request.method`](/docs/registry/attributes/http.md) instead. |
256256
| [`http.scheme`](/docs/registry/attributes/http.md) | string | Deprecated, use `url.scheme` instead. | `http`; `https` | `Rename` | Use [`url.scheme`](/docs/registry/attributes/url.md) instead. |

docs/http/http-spans.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
344344
| `test` | Synthetic test source. | ![Development](https://img.shields.io/badge/-development-blue) |
345345

346346
**Past Attributes:**
347-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
347+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
348348
|---|---|---|---|---|---|
349349
| [`http.method`](/docs/registry/attributes/http.md) | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | `Rename` | Use [`http.request.method`](/docs/registry/attributes/http.md) instead. |
350350

@@ -643,7 +643,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
643643
| `test` | Synthetic test source. | ![Development](https://img.shields.io/badge/-development-blue) |
644644

645645
**Past Attributes:**
646-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
646+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
647647
|---|---|---|---|---|---|
648648
| [`http.method`](/docs/registry/attributes/http.md) | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | `Rename` | Use [`http.request.method`](/docs/registry/attributes/http.md) instead. |
649649

docs/messaging/azure-messaging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
156156
| `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) |
157157

158158
**Past Attributes:**
159-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
159+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
160160
|---|---|---|---|---|---|
161161
| [`messaging.message.payload_compressed_size_bytes`](/docs/registry/attributes/messaging.md) | int | The compressed size of the message payload in bytes. [11] | `2048` | `Drop` | Obsoleted. |
162-
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [12] | `2738` | `Rename` | Use [`messaging.message.envelope.size`](/docs/registry/attributes/.md) instead. |
162+
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [12] | `2738` | `Drop` | Obsoleted. |
163163
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/messaging.md) instead. |
164164

165165
**[11] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
@@ -278,10 +278,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
278278
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
279279

280280
**Past Attributes:**
281-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
281+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
282282
|---|---|---|---|---|---|
283283
| [`messaging.message.payload_compressed_size_bytes`](/docs/registry/attributes/messaging.md) | int | The compressed size of the message payload in bytes. [10] | `2048` | `Drop` | Obsoleted. |
284-
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [11] | `2738` | `Rename` | Use [`messaging.message.envelope.size`](/docs/registry/attributes/.md) instead. |
284+
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [11] | `2738` | `Drop` | Obsoleted. |
285285
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/messaging.md) instead. |
286286

287287
**[10] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.

docs/messaging/gcp-pubsub.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
140140
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
141141

142142
**Past Attributes:**
143-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
143+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
144144
|---|---|---|---|---|---|
145145
| [`messaging.message.payload_compressed_size_bytes`](/docs/registry/attributes/messaging.md) | int | The compressed size of the message payload in bytes. [10] | `2048` | `Drop` | Obsoleted. |
146-
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [11] | `2738` | `Rename` | Use [`messaging.message.envelope.size`](/docs/registry/attributes/.md) instead. |
146+
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [11] | `2738` | `Drop` | Obsoleted. |
147147
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/messaging.md) instead. |
148148

149149
**[10] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.

docs/messaging/kafka.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
149149
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
150150

151151
**Past Attributes:**
152-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
152+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
153153
|---|---|---|---|---|---|
154154
| [`messaging.message.payload_compressed_size_bytes`](/docs/registry/attributes/messaging.md) | int | The compressed size of the message payload in bytes. [12] | `2048` | `Drop` | Obsoleted. |
155-
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [13] | `2738` | `Rename` | Use [`messaging.message.envelope.size`](/docs/registry/attributes/.md) instead. |
155+
| [`messaging.message.payload_size_bytes`](/docs/registry/attributes/messaging.md) | int | The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported. [13] | `2738` | `Drop` | Obsoleted. |
156156
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/messaging.md) instead. |
157157

158158
**[12] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.

docs/messaging/messaging-metrics.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
163163
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
164164

165165
**Past Attributes:**
166-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
166+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
167167
|---|---|---|---|---|---|
168168
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/messaging.md) instead. |
169169

@@ -262,9 +262,9 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
262262
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
263263

264264
**Past Attributes:**
265-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
265+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
266266
|---|---|---|---|---|---|
267-
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/.md) instead. |
267+
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.name`](/docs/registry/attributes/messaging.md) instead. |
268268

269269
<!-- markdownlint-restore -->
270270
<!-- prettier-ignore-end -->
@@ -368,9 +368,9 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
368368
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
369369

370370
**Past Attributes:**
371-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
371+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
372372
|---|---|---|---|---|---|
373-
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/.md) instead. |
373+
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.name`](/docs/registry/attributes/messaging.md) instead. |
374374

375375
<!-- markdownlint-restore -->
376376
<!-- prettier-ignore-end -->
@@ -477,9 +477,9 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
477477
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
478478

479479
**Past Attributes:**
480-
| Attribute | Type | Description | Examples | [Deprecation Action](https://opentelemetry.io/docs/specs/semconv/general/attribute-deprecation-action/) | Deprecation Explanation |
480+
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
481481
|---|---|---|---|---|---|
482-
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.type`](/docs/registry/attributes/.md) instead. |
482+
| [`messaging.operation`](/docs/registry/attributes/messaging.md) | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | `Migrate` | Use [`messaging.operation.name`](/docs/registry/attributes/messaging.md) instead. |
483483

484484
<!-- markdownlint-restore -->
485485
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)