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

Refactor and update naming guidance #1694

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .chloggen/1694.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
change_type: enhancement
component: docs
note: Update attribute, events, and metrics naming guidance to include new best practices.
subtext: |
- Use namespaces (with `.` delimiter) whenever possible.
- Use precise, descriptive, unambiguous names that leave room for expansion.

issues: [1694]
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ exists in some form in ECS, consider the following guidelines:
data, user issue reports, feature requests, examples of prior work on a
different standard or comparable evidence about the alternatives.
- When no suitable alternatives are provided, altering an ECS name solely
for the purpose of complying with [Name Pluralization guidelines](docs/general/attribute-naming.md#name-pluralization-guidelines)
for the purpose of complying with [Name Pluralization guidelines](docs/general/naming.md#attribute-name-pluralization-guidelines)
MAY BE avoided.
- Do not use an existing ECS name as a namespace. If the name must differ, use a
different namespace name to avoid clashes or avoid using the namespace
Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ Currently, the following namespaces exist:
- [VCS](vcs.md)
- [Webengine](webengine.md)

[developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers
[developers recommendations]: ../general/naming.md#recommendations-for-application-developers
9 changes: 0 additions & 9 deletions docs/general/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,3 @@ The following general Semantic Conventions are defined:
* [Logs](logs.md): General Semantic Conventions for logs.
* [Metrics](metrics.md): General Semantic Conventions for metrics.
* [Spans](trace.md): General Semantic Conventions for traces / spans.

## Event Name Reuse Prohibition

A new event MUST NOT be added with the same name as an event that existed in
the past but was renamed (with a corresponding schema file).

When introducing a new event name check all existing schema files to make sure
the name does not appear as a key of any "rename_events" section (keys denote
old event names in rename operations).
177 changes: 0 additions & 177 deletions docs/general/attribute-naming.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/general/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ structure and semantics will also be defined.
## General event semantics

* An event MUST have an [Event name property](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.40.0/specification/logs/data-model.md#field-eventname)
that uniquely identifies the event. Event names are subject to the same rules as [attribute names](/docs/general/attribute-naming.md).
that uniquely identifies the event. Event names are subject to the [Naming guidelines](/docs/general/naming.md).
* Event MAY have [standard](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.39.0/specification/common#attribute)
attributes that provide additional context about the event.
* It MAY contain a _payload_ (body) that describes the specific details of the
Expand Down
Loading
Loading