Skip to content

Commit bff4835

Browse files
committed
Use summary details for past attributes
1 parent 21c9b85 commit bff4835

File tree

15 files changed

+107
-44
lines changed

15 files changed

+107
-44
lines changed

docs/database/database-metrics.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -284,8 +284,10 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
284284
|---|---|---|
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

287-
**Past Attributes:**
288-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
287+
<details>
288+
<summary><b>Past Attributes:</b></summary>
289+
290+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
289291
|---|---|---|---|---|---|
290292
| [`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. |
291293

@@ -344,6 +346,7 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
344346
| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) |
345347
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
346348
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
349+
</details>
347350

348351
<!-- markdownlint-restore -->
349352
<!-- prettier-ignore-end -->
@@ -580,8 +583,10 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
580583
|---|---|---|
581584
| `_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) |
582585

583-
**Past Attributes:**
584-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
586+
<details>
587+
<summary><b>Past Attributes:</b></summary>
588+
589+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
585590
|---|---|---|---|---|---|
586591
| [`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. |
587592

@@ -640,6 +645,7 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
640645
| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) |
641646
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
642647
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
648+
</details>
643649

644650
<!-- markdownlint-restore -->
645651
<!-- prettier-ignore-end -->

docs/database/database-spans.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,8 +350,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
350350
|---|---|---|
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

353-
**Past Attributes:**
354-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
353+
<details>
354+
<summary><b>Past Attributes:</b></summary>
355+
356+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
355357
|---|---|---|---|---|---|
356358
| [`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`.
357359
|
@@ -415,6 +417,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
415417
| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) |
416418
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
417419
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
420+
</details>
418421

419422
<!-- markdownlint-restore -->
420423
<!-- prettier-ignore-end -->

docs/exceptions/exceptions-spans.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,14 @@ This event describes a single exception.
4141

4242
**[2] `exception.type`:** Required if `exception.message` is not set, recommended otherwise.
4343

44-
**Past Attributes:**
45-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
44+
<details>
45+
<summary><b>Past Attributes:</b></summary>
46+
47+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
4648
|---|---|---|---|---|---|
4749
| [`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.
4850
|
51+
</details>
4952

5053
<!-- markdownlint-restore -->
5154
<!-- prettier-ignore-end -->

docs/http/http-metrics.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,13 +249,16 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original
249249
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
250250
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
251251

252-
**Past Attributes:**
253-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
252+
<details>
253+
<summary><b>Past Attributes:</b></summary>
254+
255+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
254256
|---|---|---|---|---|---|
255257
| [`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. |
256258
| [`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. |
257259
| [`net.host.name`](/docs/registry/attributes/network.md) | string | Deprecated, use `server.address`. | `example.com` | `Rename` | Use [`server.address`](/docs/registry/attributes/server.md) instead. |
258260
| [`net.host.port`](/docs/registry/attributes/network.md) | int | Deprecated, use `server.port`. | `8080` | `Rename` | Use [`server.port`](/docs/registry/attributes/server.md) instead. |
261+
</details>
259262

260263
<!-- markdownlint-restore -->
261264
<!-- prettier-ignore-end -->

docs/http/http-spans.md

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

346-
**Past Attributes:**
347-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
346+
<details>
347+
<summary><b>Past Attributes:</b></summary>
348+
349+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
348350
|---|---|---|---|---|---|
349351
| [`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. |
352+
</details>
350353

351354
<!-- markdownlint-restore -->
352355
<!-- prettier-ignore-end -->
@@ -642,10 +645,13 @@ and SHOULD be provided **at span creation time** (if provided at all):
642645
| `bot` | Bot source. | ![Development](https://img.shields.io/badge/-development-blue) |
643646
| `test` | Synthetic test source. | ![Development](https://img.shields.io/badge/-development-blue) |
644647

645-
**Past Attributes:**
646-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
648+
<details>
649+
<summary><b>Past Attributes:</b></summary>
650+
651+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
647652
|---|---|---|---|---|---|
648653
| [`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. |
654+
</details>
649655

650656
<!-- markdownlint-restore -->
651657
<!-- prettier-ignore-end -->

docs/messaging/azure-messaging.md

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

158-
**Past Attributes:**
159-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
158+
<details>
159+
<summary><b>Past Attributes:</b></summary>
160+
161+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
160162
|---|---|---|---|---|---|
161163
| [`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. |
162164
| [`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. |
@@ -165,6 +167,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
165167
**[11] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
166168

167169
**[12] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
170+
</details>
168171

169172
<!-- markdownlint-restore -->
170173
<!-- prettier-ignore-end -->
@@ -277,8 +280,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
277280
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
278281
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
279282

280-
**Past Attributes:**
281-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
283+
<details>
284+
<summary><b>Past Attributes:</b></summary>
285+
286+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
282287
|---|---|---|---|---|---|
283288
| [`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. |
284289
| [`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. |
@@ -287,6 +292,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
287292
**[10] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
288293

289294
**[11] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
295+
</details>
290296

291297
<!-- markdownlint-restore -->
292298
<!-- prettier-ignore-end -->

docs/messaging/gcp-pubsub.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
139139
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
140140
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
141141

142-
**Past Attributes:**
143-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
142+
<details>
143+
<summary><b>Past Attributes:</b></summary>
144+
145+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
144146
|---|---|---|---|---|---|
145147
| [`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. |
146148
| [`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. |
@@ -149,6 +151,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
149151
**[10] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
150152

151153
**[11] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
154+
</details>
152155

153156
<!-- markdownlint-restore -->
154157
<!-- prettier-ignore-end -->

docs/messaging/kafka.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
148148
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
149149
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
150150

151-
**Past Attributes:**
152-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
151+
<details>
152+
<summary><b>Past Attributes:</b></summary>
153+
154+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
153155
|---|---|---|---|---|---|
154156
| [`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. |
155157
| [`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. |
@@ -158,6 +160,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
158160
**[12] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
159161

160162
**[13] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
163+
</details>
161164

162165
<!-- markdownlint-restore -->
163166
<!-- prettier-ignore-end -->

docs/messaging/messaging-metrics.md

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

165-
**Past Attributes:**
166-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
165+
<details>
166+
<summary><b>Past Attributes:</b></summary>
167+
168+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
167169
|---|---|---|---|---|---|
168170
| [`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. |
171+
</details>
169172

170173
<!-- markdownlint-restore -->
171174
<!-- prettier-ignore-end -->
@@ -261,10 +264,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
261264
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
262265
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
263266

264-
**Past Attributes:**
265-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
267+
<details>
268+
<summary><b>Past Attributes:</b></summary>
269+
270+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
266271
|---|---|---|---|---|---|
267272
| [`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. |
273+
</details>
268274

269275
<!-- markdownlint-restore -->
270276
<!-- prettier-ignore-end -->
@@ -367,10 +373,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
367373
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
368374
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
369375

370-
**Past Attributes:**
371-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
376+
<details>
377+
<summary><b>Past Attributes:</b></summary>
378+
379+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
372380
|---|---|---|---|---|---|
373381
| [`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. |
382+
</details>
374383

375384
<!-- markdownlint-restore -->
376385
<!-- prettier-ignore-end -->
@@ -476,10 +485,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
476485
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
477486
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
478487

479-
**Past Attributes:**
480-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
488+
<details>
489+
<summary><b>Past Attributes:</b></summary>
490+
491+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
481492
|---|---|---|---|---|---|
482493
| [`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. |
494+
</details>
483495

484496
<!-- markdownlint-restore -->
485497
<!-- prettier-ignore-end -->

docs/messaging/messaging-spans.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -508,8 +508,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
508508
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
509509
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
510510

511-
**Past Attributes:**
512-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
511+
<details>
512+
<summary><b>Past Attributes:</b></summary>
513+
514+
| Attribute Key | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
513515
|---|---|---|---|---|---|
514516
| [`messaging.message.payload_compressed_size_bytes`](/docs/registry/attributes/messaging.md) | int | The compressed size of the message payload in bytes. [19] | `2048` | `Drop` | Obsoleted. |
515517
| [`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. [20] | `2738` | `Drop` | Obsoleted. |
@@ -518,6 +520,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
518520
**[19] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
519521

520522
**[20] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
523+
</details>
521524

522525
<!-- markdownlint-restore -->
523526
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)