Skip to content

Commit 17e7051

Browse files
thompson-tomothompson-tomo
committed
Use summary details for past attributes
1 parent c3ec68b commit 17e7051

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+
| 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

@@ -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+
| Key | Type | Summary | Example Values | 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
@@ -352,8 +352,10 @@ and SHOULD be provided **at span creation time** (if provided at all):
352352
|---|---|---|
353353
| `_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) |
354354

355-
**Past Attributes:**
356-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
355+
<details>
356+
<summary><b>Past Attributes:</b></summary>
357+
358+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
357359
|---|---|---|---|---|---|
358360
| [`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`.
359361
|
@@ -417,6 +419,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
417419
| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) |
418420
| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) |
419421
| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
422+
</details>
420423

421424
<!-- markdownlint-restore -->
422425
<!-- 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+
| 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
|
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+
| Key | Type | Summary | Example Values | 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+
| Key | Type | Summary | Example Values | 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+
| Key | Type | Summary | Example Values | 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+
| 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. |
@@ -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+
| Key | Type | Summary | Example Values | 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+
| 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. |
@@ -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+
| 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. |
@@ -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
@@ -163,10 +163,13 @@ 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. |
172+
</details>
170173

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

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

271277
<!-- markdownlint-restore -->
272278
<!-- prettier-ignore-end -->
@@ -370,10 +376,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
370376
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
371377
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
372378

373-
**Past Attributes:**
374-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
379+
<details>
380+
<summary><b>Past Attributes:</b></summary>
381+
382+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
375383
|---|---|---|---|---|---|
376384
| [`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. |
385+
</details>
377386

378387
<!-- markdownlint-restore -->
379388
<!-- prettier-ignore-end -->
@@ -480,10 +489,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
480489
| `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) |
481490
| `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) |
482491

483-
**Past Attributes:**
484-
| Attribute | Type | Description | Examples | Deprecation Action | Deprecation Explanation |
492+
<details>
493+
<summary><b>Past Attributes:</b></summary>
494+
495+
| Key | Type | Summary | Example Values | Deprecation Action | Deprecation Explanation |
485496
|---|---|---|---|---|---|
486497
| [`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. |
498+
</details>
487499

488500
<!-- markdownlint-restore -->
489501
<!-- prettier-ignore-end -->

‎docs/messaging/messaging-spans.md‎

Lines changed: 5 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. |
@@ -519,6 +521,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
519521
**[19] `messaging.message.payload_compressed_size_bytes`:** Only if span represents operation on a single message.
520522

521523
**[20] `messaging.message.payload_size_bytes`:** Only if span represents operation on a single message.
524+
</details>
522525

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

0 commit comments

Comments
 (0)