Skip to content

Include attribute name pluralization guidelines (#1115) #1140

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

Merged
carlosalberto merged 4 commits into from
Nov 10, 2020
Merged

Include attribute name pluralization guidelines (#1115) #1140

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4210c3
Include attribute name pluralization guidelines (#1115)
pmm-sumo Oct 23, 2020
1bb4ec0
Apply suggestions from code review
pmm-sumo Oct 27, 2020
6741e0f
Use relative path for metric name guidelines reference
pmm-sumo Oct 27, 2020
2ded0e0
Include pluralization examples
pmm-sumo Nov 10, 2020
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
16 changes: 16 additions & 0 deletions specification/common/common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Table of Contents

- [Attributes](#attributes)
- [Attribute and Label Naming](#attribute-and-label-naming)
- [Name Pluralization Guidelines](#name-pluralization-guidelines)
- [Recommendations for OpenTelemetry Authors](#recommendations-for-opentelemetry-authors)
- [Recommendations for Application Developers](#recommendations-for-application-developers)

</details>

Expand Down Expand Up @@ -74,6 +77,19 @@ Names SHOULD follow these rules:
name prohibits existence of an equally named namespace in the future, and vice
versa: any existing namespace prohibits existence of an equally named
attribute or label key in the future.

### Name Pluralization guidelines

- When an attribute represents a single entity, the attribute name SHOULD be singular.
Examples: `host.name`, `db.user`, `container.id`.

- When attribute can represent multiple entities, the attribute name SHOULD be pluralized
and the value type SHOULD be an array. E.g. `process.command_args` might include multiple
values: the executable name and command arguments.

- When an attribute represents a measurement,
[Metric Name Pluralization Guidelines](../metrics/semantic_conventions/README.md#pluralization)
SHOULD be followed for the attribute name.

### Recommendations for OpenTelemetry Authors

Expand Down