Skip to content

Commit 9dc00f2

Browse files
committed
Automatically split attribute tables based on status
1 parent c53755c commit 9dc00f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+916
-930
lines changed

docs/exceptions/exceptions-spans.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,20 @@ This event describes a single exception.
3737
|---|---|---|---|---|---|
3838
| [`exception.message`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [1] | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` |
3939
| [`exception.type`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [2] | string | The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. | `java.net.ConnectException`; `OSError` |
40-
| [`exception.escaped`](/docs/registry/attributes/exception.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | `Recommended` | boolean | Indicates that the exception is escaping the scope of the span. | |
4140
| [`exception.stacktrace`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)` |
4241

4342
**[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise.
4443

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

46+
<details>
47+
<summary><b>Past Attributes:</b></summary>
48+
49+
| Key | Type | Summary | Example Values | Deprecation Explanation |
50+
|---|---|---|---|---|
51+
| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. |
52+
53+
</details>
4754
<!-- markdownlint-restore -->
4855
<!-- prettier-ignore-end -->
4956
<!-- END AUTOGENERATED TEXT -->

docs/registry/attributes/android.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,11 @@
33

44
# Android
55

6-
- [Android Attributes](#android-attributes)
7-
- [Deprecated Android Attributes](#deprecated-android-attributes)
8-
96
## Android Attributes
107

118
The Android platform on which the Android application is running.
129

13-
**Attributes:**
14-
10+
**Current Attributes:**
1511
| Key | Stability | Value Type | Description | Example Values |
1612
|---|---|---|---|---|
1713
| <a id="android-app-state" href="#android-app-state">`android.app.state`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | This attribute represents the state of the application. [1] | `created` |
@@ -28,16 +24,14 @@ The Android platform on which the Android application is running.
2824
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Development](https://img.shields.io/badge/-development-blue) |
2925
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) |
3026
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Development](https://img.shields.io/badge/-development-blue) |
27+
<details>
28+
<summary><b>Past Attributes:</b></summary>
3129

32-
## Deprecated Android Attributes
33-
34-
This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform.
35-
36-
**Attributes:**
37-
38-
| Key | Stability | Value Type | Description | Example Values |
30+
| Key | Type | Summary | Example Values | Deprecation Explanation |
3931
|---|---|---|---|---|
40-
| <a id="android-state" href="#android-state">`android.state`</a> | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `android.app.state`. | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` |
32+
| <a id="android-state" href="#android-state">`android.state`</a> | string | This attribute represents the state of the application. [1] | `created`; `background`; `foreground` | Use `android.app.state` instead. |
33+
34+
**[1] `android.state`:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
4135

4236
---
4337

@@ -48,3 +42,5 @@ This document defines attributes that represents an occurrence of a lifecycle tr
4842
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Development](https://img.shields.io/badge/-development-blue) |
4943
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) |
5044
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Development](https://img.shields.io/badge/-development-blue) |
45+
46+
</details>

docs/registry/attributes/app.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
Describes attributes related to client-side applications (e.g. web apps or mobile apps).
99

10-
**Attributes:**
11-
10+
**Current Attributes:**
1211
| Key | Stability | Value Type | Description | Example Values |
1312
|---|---|---|---|---|
1413
| <a id="app-build-id" href="#app-build-id">`app.build_id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for a particular build or compilation of the application. | `6cff0a7e-cefc-4668-96f5-1273d8b334d0`; `9f2b833506aa6973a92fde9733e6271f`; `my-app-1.0.0-code-123` |

docs/registry/attributes/artifact.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
This group describes attributes specific to artifacts. Artifacts are files or other immutable objects that are intended for distribution. This definition aligns directly with the [SLSA](https://slsa.dev/spec/v1.0/terminology#package-model) package model.
99

10-
**Attributes:**
11-
10+
**Current Attributes:**
1211
| Key | Stability | Value Type | Description | Example Values |
1312
|---|---|---|---|---|
1413
| <a id="artifact-attestation-filename" href="#artifact-attestation-filename">`artifact.attestation.filename`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the [SLSA Relationship](https://slsa.dev/spec/v1.0/distributing-provenance#relationship-between-artifacts-and-attestations) specification for more information. | `golang-binary-amd64-v0.1.0.attestation`; `docker-image-amd64-v0.1.0.intoto.json1`; `release-1.tar.gz.attestation`; `file-name-package.tar.gz.intoto.json1` |

docs/registry/attributes/aspnetcore.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
ASP.NET Core attributes
99

10-
**Attributes:**
11-
10+
**Current Attributes:**
1211
| Key | Stability | Value Type | Description | Example Values |
1312
|---|---|---|---|---|
1413
| <a id="aspnetcore-authentication-result" href="#aspnetcore-authentication-result">`aspnetcore.authentication.result`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The result of the authentication operation. | `success`; `failure` |

0 commit comments

Comments
 (0)