Skip to content

Commit f1e2782

Browse files
committed
Lint document
1 parent 70cc1ea commit f1e2782

Some content is hidden

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

81 files changed

+727
-624
lines changed

docs/registry/attributes/android.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
The Android platform on which the Android application is running.
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="android-app-state" href="#android-app-state">`android.app.state`</a> | string | This attribute represents the state of the application. [1] | `created` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -24,6 +25,7 @@ The Android platform on which the Android application is running.
2425
| `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) |
2526
| `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) |
2627
| `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) |
28+
2729
<details>
2830
<summary><b>Past Attributes:</b></summary>
2931

docs/registry/attributes/app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
Describes attributes related to client-side applications (e.g. web apps or mobile apps).
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="app-build-id" href="#app-build-id">`app.build_id`</a> | 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` | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/attributes/artifact.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
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

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="artifact-attestation-filename" href="#artifact-attestation-filename">`artifact.attestation.filename`</a> | 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` | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/attributes/aspnetcore.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
ASP.NET Core attributes
99

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

docs/registry/attributes/aws.md

Lines changed: 57 additions & 44 deletions
Large diffs are not rendered by default.

docs/registry/attributes/azure.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,16 @@
33

44
# Azure
55

6-
- [Deprecated Azure Attributes](#deprecated-azure-attributes)
76
- [Azure Client Library Attributes](#azure-client-library-attributes)
87
- [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes)
9-
10-
## Deprecated Azure Attributes
11-
12-
This section describes deprecated Azure attributes.
13-
14-
**Current Attributes:**
15-
<details>
16-
<summary><b>Past Attributes:</b></summary>
17-
18-
| Key | Type | Summary | Example Values | Deprecation Explanation |
19-
|---|---|---|---|---|
20-
| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. |
21-
| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. |
22-
23-
</details>
8+
- [Deprecated Azure Attributes](#deprecated-azure-attributes)
249

2510
## Azure Client Library Attributes
2611

2712
This section defines generic attributes used by Azure Client Libraries.
2813

2914
**Current Attributes:**
15+
3016
| Key | Type | Summary | Example Values | Stability |
3117
|---|---|---|---|---|
3218
| <a id="azure-client-id" href="#azure-client-id">`azure.client.id`</a> | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -38,6 +24,7 @@ This section defines generic attributes used by Azure Client Libraries.
3824
This section defines attributes for Azure Cosmos DB.
3925

4026
**Current Attributes:**
27+
4128
| Key | Type | Summary | Example Values | Stability |
4229
|---|---|---|---|---|
4330
| <a id="azure-cosmosdb-connection-mode" href="#azure-cosmosdb-connection-mode">`azure.cosmosdb.connection.mode`</a> | string | Cosmos client connection mode. | `gateway`; `direct` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -69,3 +56,17 @@ This section defines attributes for Azure Cosmos DB.
6956
| `Eventual` | Eventual | ![Development](https://img.shields.io/badge/-development-blue) |
7057
| `Session` | Session | ![Development](https://img.shields.io/badge/-development-blue) |
7158
| `Strong` | Strong | ![Development](https://img.shields.io/badge/-development-blue) |
59+
60+
## Deprecated Azure Attributes
61+
62+
This section describes deprecated Azure attributes.
63+
64+
<details>
65+
<summary><b>Past Attributes:</b></summary>
66+
67+
| Key | Type | Summary | Example Values | Deprecation Explanation |
68+
|---|---|---|---|---|
69+
| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. |
70+
| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. |
71+
72+
</details>

docs/registry/attributes/browser.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
The web browser attributes
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="browser-brands" href="#browser-brands">`browser.brands`</a> | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/attributes/cassandra.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
This section defines attributes for Cassandra.
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="cassandra-consistency-level" href="#cassandra-consistency-level">`cassandra.consistency.level`</a> | string | The consistency level of the query. Based on consistency values from [CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html). | `all`; `each_quorum`; `quorum` | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/attributes/cicd.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
This group describes attributes specific to pipelines within a Continuous Integration and Continuous Deployment (CI/CD) system. A [pipeline](https://wikipedia.org/wiki/Pipeline_(computing)) in this case is a series of steps that are performed in order to deliver a new version of software. This aligns with the [Britannica](https://www.britannica.com/dictionary/pipeline) definition of a pipeline where a **pipeline** is the system for developing and producing something. In the context of CI/CD, a pipeline produces or delivers software.
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="cicd-pipeline-action-name" href="#cicd-pipeline-action-name">`cicd.pipeline.action.name`</a> | string | The kind of action a pipeline run is performing. | `BUILD`; `RUN`; `SYNC` | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/attributes/client.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
99

1010
**Current Attributes:**
11+
1112
| Key | Type | Summary | Example Values | Stability |
1213
|---|---|---|---|---|
1314
| <a id="client-address" href="#client-address">`client.address`</a> | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

0 commit comments

Comments
 (0)