Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention that semantic conventions should be autogenerated #1515

Merged
merged 10 commits into from
Mar 22, 2021
Merged

Mention that semantic conventions should be autogenerated #1515

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c2aa228
Mention that semantic conventions should be autogenerated
rakyll Mar 8, 2021
3f36b3e
Add to CHANGELOG
rakyll Mar 8, 2021
1fdcf7f
Fix CHANGELOG
rakyll Mar 8, 2021
189abff
Fix the link
rakyll Mar 8, 2021
436952e
markdownlint
rakyll Mar 8, 2021
b45644a
Address feedback
rakyll Mar 10, 2021
61b5276
Address feedback
rakyll Mar 19, 2021
ecfe191
Fix typ
rakyll Mar 20, 2021
560313b
Update overview.md
SergeyKanzhelev Mar 22, 2021
d76f049
Merge branch 'main' into sem-conv
carlosalberto Mar 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Google products under `cloud.infrastructure_service` ([#1496](https://github.com
- `http.url` MUST NOT contain credentials ([#1502](https://github.com/open-telemetry/opentelemetry-specification/pull/1502))
- Add `aws.eks.cluster.arn` to EKS specific semantic conventions ([#1484](https://github.com/open-telemetry/opentelemetry-specification/pull/1484))
- Rename `zone` to `availability_zone` in `cloud` semantic conventions ([#1495](https://github.com/open-telemetry/opentelemetry-specification/pull/1495))
- Add section describing that libraries and the collector should autogenerate
the semantic convention keys. ([#1515](https://github.com/open-telemetry/opentelemetry-specification/pull/1515))

## v1.0.1 (2021-02-11)

Expand Down
9 changes: 9 additions & 0 deletions specification/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,15 @@ The **Semantic Conventions** define the keys and values which describe commonly
* [Span Conventions](trace/semantic_conventions/README.md)
* [Metrics Conventions](metrics/semantic_conventions/README.md)

Both the collector and the client libraries SHOULD autogenerate semantic
convention keys and enum values into constants (or language idomatic
equivalent). Generated values shouldn't be distributed in stable packages
until semantic conventions are stable.
The [YAML](../semantic_conventions) files MUST be used as the
source of truth for generation. Each language implementation SHOULD
provide language-specific support to the
[code generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator).
rakyll marked this conversation as resolved.
Show resolved Hide resolved
rakyll marked this conversation as resolved.
Show resolved Hide resolved

### Contrib Packages

The OpenTelemetry project maintains integrations with popular OSS projects which have been identified as important for observing modern web services.
Expand Down