You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Many of the upcoming conventions for logs will need to be shared with conventions for traces. The current structure complete isolates the signals into separate directories which makes such sharing of conventions difficult, requiring duplication which is hard to maintain.
We need to refactor the conventions to make sharing between signals easy. One possible approach was started here #1977
Copying the proposal from that PR below, however there may other ways to enable sharing too, this is open for discusison.
--
Proposed changes:
Centralize the location of all semantic conventions, rather than split them across many subsections of the spec.
Create one folder per topic (HTTP, faas, messaging, etc). All relevant tracing, metric, and resource conventions are combined into these topics.
Move all implementation-specific conventions (HBase, AWS lambda, etc) to an /implementation folder under each topic.
The new layout can viewed here, on the branch in GitHub.
Goals:
This new layout should make it easier to browse and comprehend all of the available semantic conventions. This should also make it easier to assign domain experts as codeowners for each convention. It also makes it easier to see how most implementations are underspecified. This will help the Semantic Conventions / Instrumentation SIG move forwards.
This PR only attempts to take separate and recombine the concepts currently described in the spec, while changing the wording as little as possible. It does not attempt to adjust any concepts or clarify existing any descriptions. Once the refactor is complete, approvers should be assigned to each convention so that we can begin processing improvements to the spec.
The text was updated successfully, but these errors were encountered:
Many of the upcoming conventions for logs will need to be shared with conventions for traces. The current structure complete isolates the signals into separate directories which makes such sharing of conventions difficult, requiring duplication which is hard to maintain.
We need to refactor the conventions to make sharing between signals easy. One possible approach was started here #1977
Copying the proposal from that PR below, however there may other ways to enable sharing too, this is open for discusison.
--
Proposed changes:
/implementation
folder under each topic.The new layout can viewed here, on the branch in GitHub.
Example layout:
Goals:
This new layout should make it easier to browse and comprehend all of the available semantic conventions. This should also make it easier to assign domain experts as codeowners for each convention. It also makes it easier to see how most implementations are underspecified. This will help the Semantic Conventions / Instrumentation SIG move forwards.
This PR only attempts to take separate and recombine the concepts currently described in the spec, while changing the wording as little as possible. It does not attempt to adjust any concepts or clarify existing any descriptions. Once the refactor is complete, approvers should be assigned to each convention so that we can begin processing improvements to the spec.
The text was updated successfully, but these errors were encountered: