Commit Graph

40 Commits

Author SHA1 Message Date
Josh Suereth 9976b2abba
Add pull request checks back for links/markdown. (#5) 2023-05-11 12:57:26 -04:00
Josh Suereth ba20753993
Remove no-changes allowed header from new repository. (#6) 2023-05-11 11:46:04 -04:00
Josh Suereth 554a97dde2 Put hiatus on semantic conventions until they are in the new repository. (#3489)
As per OTEP:
https://github.com/open-telemetry/oteps/blob/main/text/0227-separate-semantic-conventions.md
2023-05-11 05:59:41 -06:00
Mike Dame 56c77bacd6 Add detail for GCP Cloud Run Job execution (#3378) 2023-05-08 21:18:54 -07:00
Cijo Thomas a2e3100848 Add Rust to the telemetry.sdk.language resource convention (#3448) 2023-04-26 12:42:23 -07:00
jack-berg 31485588b2 Move configuration documents to configuration folder (#3434) 2023-04-25 14:51:27 -07:00
Robert Pająk 2ef975b7b2 Refactor Telemetry SDK resource detector description (#3392) 2023-04-25 08:00:38 -06:00
Josh Suereth dcd39bf86e Mark `service` and `telemetry.sdk` resource attributes as stable. (#3202)
## Changes

This PR marks the set of resource semantic conventions, which a relied
upon in stable API / SDK specification, as stable themselves.

- Add a caveat that changing `service.*` and `telemetry.*` names need
MORE than just schema file changes.
- Mark core Resource attribute semconv document as MIXED stability
- Update key sections for Resource attribute semconv as stable
- Mark `telemetry.sdk` and `service` attribute groups as stable.
- Move `telemetry.auto` and `service.*` "contentious" attributes into
`{section}_experimental.yaml` file. This retains the reserved name, but
does not mark the convention as stable, allowing us to ensure stable
portions of our specification refer to stable semconv.
- Update examples for `service.instance.id` to include an example of the
preferred style instance id before the fallback.

Related issues #3177

## Usage in the Specification

One reason we should mark these attributes as stable is because they are
referenced from numerous stable portions of our specification, and they
are also leveraged from newly stabilizing portions of our specification.

- [Resource
SDK](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#sdk-provided-resource-attributes)
- stable
- [Environment
Variables](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration)
- stable
- [Jaeger
Exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/jaeger.md#resource)
- stable
- [Zipkin
Exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/zipkin.md#service-name)
- Stable
- [Log
DataModel](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#rfc5424-syslog)
- Stable
- [Prometheus
compatibility](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/prometheus_and_openmetrics.md#resource-attributes)
- still experimental
- [Performance Benchmark
Guidelines](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/performance-benchmark.md)

## A note on ECS compatibility

Here's [ECS service
definition](https://www.elastic.co/guide/en/ecs/current/ecs-service.html).

They include more attributes than we do. The only possible conflict
between us is `service.instance.id` vs. `service.node.name`. In this
case, our `service.instance.id` has a fallback of generating UUID which
is inconsistent w/ `service.node.name` which requires a user-generated
name if another name cannot be provided.

There's an opportunity for us to unify here. However, I don't think
there's appetite in OTEL to require user-specified names in lieu of some
algorithm or generative specification.
2023-04-03 19:40:12 -07:00
Antoine Toulme 12481fef89 add semantic conventions for heroku (#3075)
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
2023-02-27 10:23:29 +01:00
Patrice Chalin 1971550982 [editorial] Fix Tencent Cloud link (#3231) 2023-02-20 10:29:04 +01:00
Liudmila Molkova 3f7b7d02f9 Adopt attribute requirement levels in semantic conventions (#2594) 2022-06-14 08:02:55 -07:00
Martin Kuba 6a613c54e4 Add Resource browser attributes (#2353) 2022-05-19 10:57:41 -07:00
Armin Ruech 741ac62a15 Bump semantic conventions tool to v0.11.0 and refine enum wording (#2399) 2022-03-04 17:51:37 +01:00
Ignacio Bonafonte 14973d30e6 Add swift to the list of `telemetry.sdk.language` (#2097) 2021-11-04 18:38:41 +00:00
Yuri Shkuro d9fbb6f32c Add Makefile target to auto-generate TOC via markdown-toc (#2020) 2021-10-15 15:04:22 +00:00
meteorlxy 3e51df22d7 [semantic conventions] add tencent cloud as a cloud provider (#2006)
* feat: add tencent cloud as a cloud provider

* chore: tweaks

* chore: tweaks

* chore: lint

* chore: changelog

* chore: tweaks

* chore: tweaks

Co-authored-by: Sergey Kanzhelev <S.Kanzhelev@live.com>
2021-10-12 19:02:27 +00:00
legendecas 227b4ff1b1 [semantic conventions] add alibaba cloud as a cloud provider (#1831)
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
2021-08-03 11:22:31 +00:00
Nikita Salnikov-Tarnovski 56e0491893 Add `OTEL_SERVICE_NAME` environment variable (#1677)
* Add OTEL_SERVICE_NAME environment variable

Closes #709
2021-05-24 15:54:33 +02:00
James Sherlock 83a291c491 Add Device (Mobile) and OS Version Resource Semantic Attributes (#1596)
* Add Device (Mobile) and OS Version Resource Semantic Attributes

* Added OS Name (iOS) and OS Version (14.4) to `os`.
* Added Device Identifier and Model Identifier to a newly created `device` group.
2021-05-20 14:21:47 +02:00
ivomagi 4aa113a9f1 Adding webengine definition under resources semantic conventions (#1293) 2021-04-01 16:29:36 +02:00
Ted Young eeff36dfd4 Add lifecycle statuses to all documents (#1385) 2021-02-04 15:06:46 +01:00
Jay Camp 78875d0fa7 Fix typo of service.id -> service.instance.id (#1383)
Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
2021-01-27 17:28:03 -05:00
Christian Neumüller b139dc2a34 Clarify/relax required resource attributes. (#1294) 2021-01-21 15:50:05 +01:00
Sergey Kanzhelev 4f13d9c80b regenerated tables after https://github.com/open-telemetry/build-tools/pull/24 (#1342) 2021-01-14 00:04:10 -08:00
Carlos Alberto Cortez 4df1e98ddc Define the fallback case for service.name (#1269) 2020-12-14 16:59:35 +01:00
William Armiros 3df4ec410c Add semantic conventions for cloud provider-specific resource attributes (#1099) 2020-11-25 03:17:42 +01:00
Giovanni Liva 9315f21f9d Add telemetry and service yaml (#1026) 2020-09-30 17:16:04 -07:00
Tigran Najaryan 22acfb9aa6 Fix reference to service.instance.id (#957)
Was previously incorrectly referenced as service.id.
2020-09-16 16:01:56 +02:00
Carlos Alberto Cortez 91e93292b8 Use Deployment Environment in Resources' README instead of Environment. (#851) 2020-09-08 20:09:48 +02:00
Anuraag Agrawal 9b449af77e Remove version convention / semver prefix from versions. (#873)
* Remove version convention / semver prefix from versions.

* Moar

* api.md

* Examples of version strings.

* Apply suggestions from code review

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

* spaec

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
2020-08-25 18:49:52 -07:00
Emmanuel Courreges a69a84b879 Add "Deployment / environment" subsection in "Environment" (#606)
Merge "Deployment Service / Kubernetes" section into "Environment" section for consistency
Create deployment_environment.md for new deployment.environment attribute

Signed-off-by: CI-Bot for Emmanuel Courreges <emmanuel.courreges@orange.com>
2020-08-21 16:01:15 +02:00
Nikita Salnikov-Tarnovski 36eb583e87 Add semantic convention for telemetry.auto.version (#799) 2020-08-17 09:41:58 -07:00
Bogdan Drutu 41869b89aa Split resource semantic conventions in smaller files (#727)
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
2020-07-23 09:49:11 -04:00
Armin Ruech f89b9c568c Add resource semantic conventions for operating systems (#693) 2020-07-15 16:22:13 +02:00
Tyler Yahn 99707b5a5c Update resource `process.*` descriptions (#695)
Not all Unix based OSs have `procfs` (Darwin) or have it enabled by
default (FreeBSD). Update the description to be specific to Linux
systems.
2020-07-09 23:15:10 -07:00
Lei Wang 2296634e18 Add semantic conventions for container id (#673)
* Add semantic conventions for container id

* Update specification/resource/semantic_conventions/README.md

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

* Update specification/resource/semantic_conventions/README.md

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
2020-06-30 08:25:40 -07:00
James Bebbington cdbda6cddb Added semantic conventions for the "process" resource (#635) 2020-06-29 18:00:03 -07:00
Armin Ruech 4d1da099a0 Fix markdown-link-check and dead links (#555) 2020-04-09 16:36:01 +02:00
Giovanni Liva e85fca0fc1 Add Semantic Conventions for Function as a Service (#471) 2020-04-07 17:12:45 +02:00
Bogdan Drutu 0dceae42ab Move specifications into sub-directories per signal (#546)
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
2020-04-06 17:25:53 -04:00