Skip to content

Commit 3552e18

Browse files
thompson-tomothompson-tomo
authored
[chore] Automatic linting of resource docs (#3160)
1 parent 35f93da commit 3552e18

File tree

25 files changed

+2
-156
lines changed

25 files changed

+2
-156
lines changed

‎docs/resource/README.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,6 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
7171
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
7272
<!-- see templates/registry/markdown/snippet.md.j2 -->
7373
<!-- prettier-ignore-start -->
74-
<!-- markdownlint-capture -->
75-
<!-- markdownlint-disable -->
7674

7775
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
7876

@@ -119,7 +117,6 @@ for that telemetry. This is typically the case for scraping receivers, as they k
119117
port.
120118

121119
**[3] `service.namespace`:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
122-
<!-- markdownlint-restore -->
123120
<!-- prettier-ignore-end -->
124121
<!-- END AUTOGENERATED TEXT -->
125122
<!-- endsemconv -->
@@ -144,8 +141,6 @@ service.name = Shop.shoppingcart
144141
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
145142
<!-- see templates/registry/markdown/snippet.md.j2 -->
146143
<!-- prettier-ignore-start -->
147-
<!-- markdownlint-capture -->
148-
<!-- markdownlint-disable -->
149144

150145
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
151146

@@ -186,7 +181,6 @@ All custom identifiers SHOULD be stable across different versions of an implemen
186181
| `rust` | rust | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
187182
| `swift` | swift | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
188183
| `webjs` | webjs | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
189-
<!-- markdownlint-restore -->
190184
<!-- prettier-ignore-end -->
191185
<!-- END AUTOGENERATED TEXT -->
192186
<!-- endsemconv -->
@@ -197,8 +191,6 @@ All custom identifiers SHOULD be stable across different versions of an implemen
197191
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
198192
<!-- see templates/registry/markdown/snippet.md.j2 -->
199193
<!-- prettier-ignore-start -->
200-
<!-- markdownlint-capture -->
201-
<!-- markdownlint-disable -->
202194

203195
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
204196

@@ -219,7 +211,6 @@ All custom identifiers SHOULD be stable across different versions of an implemen
219211

220212
**[1] `telemetry.distro.name`:** Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to
221213
a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`.
222-
<!-- markdownlint-restore -->
223214
<!-- prettier-ignore-end -->
224215
<!-- END AUTOGENERATED TEXT -->
225216
<!-- endsemconv -->

‎docs/resource/android.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
55
<!-- see templates/registry/markdown/snippet.md.j2 -->
66
<!-- prettier-ignore-start -->
7-
<!-- markdownlint-capture -->
8-
<!-- markdownlint-disable -->
97

108
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
119

@@ -22,7 +20,6 @@
2220
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
2321
| --- | --- | --- | --- | --- | --- | --- |
2422
| Other | [`android.os.api_level`](/docs/registry/attributes/android.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` |
25-
<!-- markdownlint-restore -->
2623
<!-- prettier-ignore-end -->
2724
<!-- END AUTOGENERATED TEXT -->
2825
<!-- endsemconv -->

‎docs/resource/browser.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
55
<!-- see templates/registry/markdown/snippet.md.j2 -->
66
<!-- prettier-ignore-start -->
7-
<!-- markdownlint-capture -->
8-
<!-- markdownlint-disable -->
97

108
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
119

@@ -37,7 +35,6 @@
3735
The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides.
3836

3937
**[5] `user_agent.original`:** The user-agent value SHOULD be provided only from browsers that do not have a mechanism to retrieve brands and platform individually from the User-Agent Client Hints API. To retrieve the value, the legacy `navigator.userAgent` API can be used.
40-
<!-- markdownlint-restore -->
4138
<!-- prettier-ignore-end -->
4239
<!-- END AUTOGENERATED TEXT -->
4340
<!-- endsemconv -->

‎docs/resource/cicd.md‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ See also:
2828
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2929
<!-- see templates/registry/markdown/snippet.md.j2 -->
3030
<!-- prettier-ignore-start -->
31-
<!-- markdownlint-capture -->
32-
<!-- markdownlint-disable -->
3331

3432
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
3533

@@ -46,7 +44,6 @@ See also:
4644
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
4745
| --- | --- | --- | --- | --- | --- | --- |
4846
| Other | [`cicd.pipeline.name`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The human readable name of the pipeline within a CI/CD system. | `Build and Test`; `Lint`; `Deploy Go Project`; `deploy_to_environment` |
49-
<!-- markdownlint-restore -->
5047
<!-- prettier-ignore-end -->
5148
<!-- END AUTOGENERATED TEXT -->
5249
<!-- endsemconv -->
@@ -63,8 +60,6 @@ Using the CICD pipeline run resource with metrics inherently causes high cardina
6360
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
6461
<!-- see templates/registry/markdown/snippet.md.j2 -->
6562
<!-- prettier-ignore-start -->
66-
<!-- markdownlint-capture -->
67-
<!-- markdownlint-disable -->
6863

6964
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
7065

@@ -82,7 +77,6 @@ Using the CICD pipeline run resource with metrics inherently causes high cardina
8277
| --- | --- | --- | --- | --- | --- | --- |
8378
| Other | [`cicd.pipeline.run.id`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The unique identifier of a pipeline run within a CI/CD system. | `120912` |
8479
| Other | [`cicd.pipeline.run.url.full`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline run, providing the complete address in order to locate and identify the pipeline run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075` |
85-
<!-- markdownlint-restore -->
8680
<!-- prettier-ignore-end -->
8781
<!-- END AUTOGENERATED TEXT -->
8882
<!-- endsemconv -->
@@ -93,8 +87,6 @@ Using the CICD pipeline run resource with metrics inherently causes high cardina
9387
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
9488
<!-- see templates/registry/markdown/snippet.md.j2 -->
9589
<!-- prettier-ignore-start -->
96-
<!-- markdownlint-capture -->
97-
<!-- markdownlint-disable -->
9890

9991
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
10092

@@ -115,7 +107,6 @@ For example, when a pipeline run involves several workers, its task run spans ma
115107
| Other | [`cicd.worker.id`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The unique identifier of a worker within a CICD system. | `abc123`; `10.0.1.2`; `controller` |
116108
| Other | [`cicd.worker.name`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of a worker within a CICD system. | `agent-abc`; `controller`; `Ubuntu LTS` |
117109
| Other | [`cicd.worker.url.full`](/docs/registry/attributes/cicd.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If available | string | The [URL](https://wikipedia.org/wiki/URL) of the worker, providing the complete address in order to locate and identify the worker. | `https://cicd.example.org/worker/abc123` |
118-
<!-- markdownlint-restore -->
119110
<!-- prettier-ignore-end -->
120111
<!-- END AUTOGENERATED TEXT -->
121112
<!-- endsemconv -->
@@ -128,8 +119,6 @@ For example, when a pipeline run involves several workers, its task run spans ma
128119
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
129120
<!-- see templates/registry/markdown/snippet.md.j2 -->
130121
<!-- prettier-ignore-start -->
131-
<!-- markdownlint-capture -->
132-
<!-- markdownlint-disable -->
133122

134123
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
135124

@@ -154,7 +143,6 @@ the same backends.
154143

155144
**[2] `vcs.repository.url.full`:** In Git Version Control Systems, the canonical URL SHOULD NOT include
156145
the `.git` extension.
157-
<!-- markdownlint-restore -->
158146
<!-- prettier-ignore-end -->
159147
<!-- END AUTOGENERATED TEXT -->
160148
<!-- endsemconv -->
@@ -165,8 +153,6 @@ the `.git` extension.
165153
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
166154
<!-- see templates/registry/markdown/snippet.md.j2 -->
167155
<!-- prettier-ignore-start -->
168-
<!-- markdownlint-capture -->
169-
<!-- markdownlint-disable -->
170156

171157
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
172158

@@ -209,7 +195,6 @@ revision based on the VCS system and situational context.
209195
| --- | --- | --- |
210196
| `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Development](https://img.shields.io/badge/-development-blue) |
211197
| `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Development](https://img.shields.io/badge/-development-blue) |
212-
<!-- markdownlint-restore -->
213198
<!-- prettier-ignore-end -->
214199
<!-- END AUTOGENERATED TEXT -->
215200
<!-- endsemconv -->

‎docs/resource/cloud-provider/aws/ecs.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ linkTitle: ECS
99
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
1010
<!-- see templates/registry/markdown/snippet.md.j2 -->
1111
<!-- prettier-ignore-start -->
12-
<!-- markdownlint-capture -->
13-
<!-- markdownlint-disable -->
1412

1513
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
1614

@@ -44,7 +42,6 @@ linkTitle: ECS
4442
| --- | --- | --- |
4543
| `ec2` | Amazon EC2 | ![Development](https://img.shields.io/badge/-development-blue) |
4644
| `fargate` | Amazon Fargate | ![Development](https://img.shields.io/badge/-development-blue) |
47-
<!-- markdownlint-restore -->
4845
<!-- prettier-ignore-end -->
4946
<!-- END AUTOGENERATED TEXT -->
5047
<!-- endsemconv -->

‎docs/resource/cloud-provider/aws/eks.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ linkTitle: EKS
88
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
99
<!-- see templates/registry/markdown/snippet.md.j2 -->
1010
<!-- prettier-ignore-start -->
11-
<!-- markdownlint-capture -->
12-
<!-- markdownlint-disable -->
1311

1412
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
1513

@@ -26,7 +24,6 @@ linkTitle: EKS
2624
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
2725
| --- | --- | --- | --- | --- | --- | --- |
2826
| Other | [`aws.eks.cluster.arn`](/docs/registry/attributes/aws.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` |
29-
<!-- markdownlint-restore -->
3027
<!-- prettier-ignore-end -->
3128
<!-- END AUTOGENERATED TEXT -->
3229
<!-- endsemconv -->

‎docs/resource/cloud-provider/aws/logs.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ linkTitle: Logs
88
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
99
<!-- see templates/registry/markdown/snippet.md.j2 -->
1010
<!-- prettier-ignore-start -->
11-
<!-- markdownlint-capture -->
12-
<!-- markdownlint-disable -->
1311

1412
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
1513

@@ -35,7 +33,6 @@ linkTitle: Logs
3533
**[2] `aws.log.group.names`:** Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group.
3634

3735
**[3] `aws.log.stream.arns`:** See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.
38-
<!-- markdownlint-restore -->
3936
<!-- prettier-ignore-end -->
4037
<!-- END AUTOGENERATED TEXT -->
4138
<!-- endsemconv -->

‎docs/resource/cloud-provider/gcp/apphub.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
2121
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2222
<!-- see templates/registry/markdown/snippet.md.j2 -->
2323
<!-- prettier-ignore-start -->
24-
<!-- markdownlint-capture -->
25-
<!-- markdownlint-disable -->
2624

2725
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
2826

@@ -41,7 +39,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
4139
| Other | [`gcp.apphub.application.container`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` |
4240
| Other | [`gcp.apphub.application.id`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The name of the application as configured in AppHub. | `my-application` |
4341
| Other | [`gcp.apphub.application.location`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The GCP zone or region where the application is defined. | `us-central1` |
44-
<!-- markdownlint-restore -->
4542
<!-- prettier-ignore-end -->
4643
<!-- END AUTOGENERATED TEXT -->
4744
<!-- endsemconv -->
@@ -52,8 +49,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
5249
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
5350
<!-- see templates/registry/markdown/snippet.md.j2 -->
5451
<!-- prettier-ignore-start -->
55-
<!-- markdownlint-capture -->
56-
<!-- markdownlint-disable -->
5752

5853
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
5954

@@ -98,7 +93,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
9893
| `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) |
9994
| `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) |
10095
| `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) |
101-
<!-- markdownlint-restore -->
10296
<!-- prettier-ignore-end -->
10397
<!-- END AUTOGENERATED TEXT -->
10498
<!-- endsemconv -->
@@ -109,8 +103,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
109103
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
110104
<!-- see templates/registry/markdown/snippet.md.j2 -->
111105
<!-- prettier-ignore-start -->
112-
<!-- markdownlint-capture -->
113-
<!-- markdownlint-disable -->
114106

115107
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
116108

@@ -155,7 +147,6 @@ See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resour
155147
| `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) |
156148
| `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) |
157149
| `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) |
158-
<!-- markdownlint-restore -->
159150
<!-- prettier-ignore-end -->
160151
<!-- END AUTOGENERATED TEXT -->
161152
<!-- endsemconv -->

‎docs/resource/cloud-provider/gcp/cloud-run.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ These conventions are recommended for resources running on Cloud Run.
88
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
99
<!-- see templates/registry/markdown/snippet.md.j2 -->
1010
<!-- prettier-ignore-start -->
11-
<!-- markdownlint-capture -->
12-
<!-- markdownlint-disable -->
1311

1412
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
1513

@@ -27,7 +25,6 @@ These conventions are recommended for resources running on Cloud Run.
2725
| --- | --- | --- | --- | --- | --- | --- |
2826
| Other | [`gcp.cloud_run.job.execution`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `job-name-xxxx`; `sample-job-mdw84` |
2927
| Other | [`gcp.cloud_run.job.task_index`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `0`; `1` |
30-
<!-- markdownlint-restore -->
3128
<!-- prettier-ignore-end -->
3229
<!-- END AUTOGENERATED TEXT -->
3330
<!-- endsemconv -->

‎docs/resource/cloud-provider/gcp/gce.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
55
<!-- see templates/registry/markdown/snippet.md.j2 -->
66
<!-- prettier-ignore-start -->
7-
<!-- markdownlint-capture -->
8-
<!-- markdownlint-disable -->
97

108
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
119

@@ -23,7 +21,6 @@
2321
| --- | --- | --- | --- | --- | --- | --- |
2422
| Other | [`gcp.gce.instance.hostname`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` |
2523
| Other | [`gcp.gce.instance.name`](/docs/registry/attributes/gcp.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). | `instance-1`; `my-vm-name` |
26-
<!-- markdownlint-restore -->
2724
<!-- prettier-ignore-end -->
2825
<!-- END AUTOGENERATED TEXT -->
2926
<!-- endsemconv -->

0 commit comments

Comments
 (0)