Skip to content

Commit 31aa4cc

Browse files
thompson-tomothompson-tomo
committed
Use summary details for past attributes
1 parent 90d2789 commit 31aa4cc

File tree

15 files changed

+127
-43
lines changed

15 files changed

+127
-43
lines changed

‎docs/database/database-metrics.md‎

Lines changed: 12 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+
| Key | Type | Summary | Example Values | 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

@@ -345,6 +347,8 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
345347
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
346348
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
347349

350+
</details>
351+
348352
<!-- markdownlint-restore -->
349353
<!-- prettier-ignore-end -->
350354
<!-- END AUTOGENERATED TEXT -->
@@ -580,8 +584,10 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
580584
|---|---|---|
581585
| `_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) |
582586

583-
**Past Attributes:**
584-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
587+
<details>
588+
<summary><b>Past Attributes:</b></summary>
589+
590+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
585591
|---|---|---|---|---|---|
586592
| [`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. |
587593

@@ -641,6 +647,8 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer
641647
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
642648
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
643649

650+
</details>
651+
644652
<!-- markdownlint-restore -->
645653
<!-- prettier-ignore-end -->
646654
<!-- END AUTOGENERATED TEXT -->

‎docs/database/database-spans.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,8 +355,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
355355
|---|---|---|
356356
| `_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) |
357357

358-
**Past Attributes:**
359-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
358+
<details>
359+
<summary><b>Past Attributes:</b></summary>
360+
361+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
360362
|---|---|---|---|---|---|
361363
| [`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`.
362364
|
@@ -421,6 +423,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
421423
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
422424
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
423425

426+
</details>
427+
424428
<!-- markdownlint-restore -->
425429
<!-- prettier-ignore-end -->
426430
<!-- END AUTOGENERATED TEXT -->

‎docs/exceptions/exceptions-spans.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,16 @@ 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+
| Key | Type | Summary | Example Values | 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
|
4951

52+
</details>
53+
5054
<!-- markdownlint-restore -->
5155
<!-- prettier-ignore-end -->
5256
<!-- END AUTOGENERATED TEXT -->

‎docs/http/http-metrics.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,14 +261,18 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original
261261
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
262262
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
263263

264-
**Past Attributes:**
265-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
264+
<details>
265+
<summary><b>Past Attributes:</b></summary>
266+
267+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
266268
|---|---|---|---|---|---|
267269
| [`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. |
268270
| [`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. |
269271
| [`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. |
270272
| [`net.host.port`](/docs/registry/attributes/network.md) | int | Deprecated, use `server.port`. | `8080` | `Rename` | Use [`server.port`](/docs/registry/attributes/server.md) instead. |
271273

274+
</details>
275+
272276
<!-- markdownlint-restore -->
273277
<!-- prettier-ignore-end -->
274278
<!-- END AUTOGENERATED TEXT -->

‎docs/http/http-spans.md‎

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

348-
**Past Attributes:**
349-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
348+
<details>
349+
<summary><b>Past Attributes:</b></summary>
350+
351+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
350352
|---|---|---|---|---|---|
351353
| [`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. |
352354

355+
</details>
356+
353357
<!-- markdownlint-restore -->
354358
<!-- prettier-ignore-end -->
355359
<!-- END AUTOGENERATED TEXT -->
@@ -654,11 +658,15 @@ and SHOULD be provided **at span creation time** (if provided at all):
654658
| `bot` | Bot source. | ![Development](https://img.shields.io/badge/-development-blue) |
655659
| `test` | Synthetic test source. | ![Development](https://img.shields.io/badge/-development-blue) |
656660

657-
**Past Attributes:**
658-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
661+
<details>
662+
<summary><b>Past Attributes:</b></summary>
663+
664+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
659665
|---|---|---|---|---|---|
660666
| [`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. |
661667

668+
</details>
669+
662670
<!-- markdownlint-restore -->
663671
<!-- prettier-ignore-end -->
664672
<!-- END AUTOGENERATED TEXT -->

‎docs/messaging/azure-messaging.md‎

Lines changed: 12 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+
| Key | Type | Summary | Example Values | 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. |
@@ -166,6 +168,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
166168

167169
**[12] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
168170

171+
</details>
172+
169173
<!-- markdownlint-restore -->
170174
<!-- prettier-ignore-end -->
171175
<!-- END AUTOGENERATED TEXT -->
@@ -277,8 +281,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
277281
| `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) |
278282
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |
279283

280-
**Past Attributes:**
281-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
284+
<details>
285+
<summary><b>Past Attributes:</b></summary>
286+
287+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
282288
|---|---|---|---|---|---|
283289
| [`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. |
284290
| [`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. |
@@ -288,6 +294,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
288294

289295
**[11] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
290296

297+
</details>
298+
291299
<!-- markdownlint-restore -->
292300
<!-- prettier-ignore-end -->
293301
<!-- END AUTOGENERATED TEXT -->

‎docs/messaging/gcp-pubsub.md‎

Lines changed: 6 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+
| Key | Type | Summary | Example Values | 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. |
@@ -150,6 +152,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
150152

151153
**[11] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
152154

155+
</details>
156+
153157
<!-- markdownlint-restore -->
154158
<!-- prettier-ignore-end -->
155159
<!-- END AUTOGENERATED TEXT -->

‎docs/messaging/kafka.md‎

Lines changed: 6 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+
| Key | Type | Summary | Example Values | 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. |
@@ -159,6 +161,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
159161

160162
**[13] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
161163

164+
</details>
165+
162166
<!-- markdownlint-restore -->
163167
<!-- prettier-ignore-end -->
164168
<!-- END AUTOGENERATED TEXT -->

‎docs/messaging/messaging-metrics.md‎

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

166-
**Past Attributes:**
167-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
166+
<details>
167+
<summary><b>Past Attributes:</b></summary>
168+
169+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
168170
|---|---|---|---|---|---|
169171
| [`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. |
170172

173+
</details>
174+
171175
<!-- markdownlint-restore -->
172176
<!-- prettier-ignore-end -->
173177
<!-- END AUTOGENERATED TEXT -->
@@ -263,11 +267,15 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
263267
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
264268
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
265269

266-
**Past Attributes:**
267-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
270+
<details>
271+
<summary><b>Past Attributes:</b></summary>
272+
273+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
268274
|---|---|---|---|---|---|
269275
| [`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. |
270276

277+
</details>
278+
271279
<!-- markdownlint-restore -->
272280
<!-- prettier-ignore-end -->
273281
<!-- END AUTOGENERATED TEXT -->
@@ -370,11 +378,15 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
370378
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
371379
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
372380

373-
**Past Attributes:**
374-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
381+
<details>
382+
<summary><b>Past Attributes:</b></summary>
383+
384+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
375385
|---|---|---|---|---|---|
376386
| [`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. |
377387

388+
</details>
389+
378390
<!-- markdownlint-restore -->
379391
<!-- prettier-ignore-end -->
380392
<!-- END AUTOGENERATED TEXT -->
@@ -480,11 +492,15 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
480492
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
481493
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
482494

483-
**Past Attributes:**
484-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
495+
<details>
496+
<summary><b>Past Attributes:</b></summary>
497+
498+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
485499
|---|---|---|---|---|---|
486500
| [`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. |
487501

502+
</details>
503+
488504
<!-- markdownlint-restore -->
489505
<!-- prettier-ignore-end -->
490506
<!-- END AUTOGENERATED TEXT -->

‎docs/messaging/messaging-spans.md‎

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

512-
**Past Attributes:**
513-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
512+
<details>
513+
<summary><b>Past Attributes:</b></summary>
514+
515+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
514516
|---|---|---|---|---|---|
515517
| [`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. |
516518
| [`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. |
@@ -520,6 +522,8 @@ and SHOULD be provided **at span creation time** (if provided at all):
520522

521523
**[20] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
522524

525+
</details>
526+
523527
<!-- markdownlint-restore -->
524528
<!-- prettier-ignore-end -->
525529
<!-- END AUTOGENERATED TEXT -->

0 commit comments

Comments
 (0)