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.

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

Use Deployment Environment in Resources' README instead of Environment. #851

Merged
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ the release.
New:

- Add resource semantic conventions for operating systems ([#693](https://github.com/open-telemetry/opentelemetry-specification/pull/693))
- Add resource semantic convention for deployment environment [#606](https://github.com/open-telemetry/opentelemetry-specification/pull/606/)
- Clarification of the behavior of the Trace API, re: context propagation, in the absence of an installed SDK
- Add Span API and semantic conventions for recording exceptions
([#697](https://github.com/open-telemetry/opentelemetry-specification/pull/697))
Expand Down
2 changes: 1 addition & 1 deletion specification/resource/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce
- [Operating System](./os.md)
- [Cloud](./cloud.md)
- Deployment:
- [Environment](./deployment_environment.md)
- [Deployment Environment](./deployment_environment.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should then the semantic be:
deployment_environment.name?

Copy link
Member

@Oberon00 Oberon00 Aug 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the semantic convention is probably fine as it is. But maybe the heading structure should actually be:

  • Cloud
  • Deployment
  • Kubernetes

without putting Kubernetes under Deployment.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is also an option :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Oberon00 Heading structure of this document (README.md) or the convention itself?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping @Oberon00

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was talking about the TOC but the actual structure should most likely match that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm lost at this moment at what you guys expect ;) Please elaborate on what you want to see here regarding:

  1. The TOC.
  2. The actual semantic convention.

I don't have a special preference, and personally think the way it stands now (with this PR) is just fine, but I'm open to suggestions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also lost 😄

I think the current PR is fine and we can clean this up with #559

- [Kubernetes](./k8s.md)

## Version Attributes
Expand Down