Include attribute name pluralization guidelines (#1115) (#1140)

This commit is contained in:
Przemek Maciolek 2020-11-10 21:19:52 +01:00 committed by Josh Suereth
parent 550a2b904b
commit 01e5a6d827
1 changed files with 16 additions and 0 deletions

View File

@ -7,6 +7,9 @@ Table of Contents
- [Attributes](#attributes) - [Attributes](#attributes)
- [Attribute and Label Naming](#attribute-and-label-naming) - [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> </details>
@ -73,6 +76,19 @@ Names SHOULD follow these rules:
versa: any existing namespace prohibits existence of an equally named versa: any existing namespace prohibits existence of an equally named
attribute or label key in the future. 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 ### Recommendations for OpenTelemetry Authors
- All names that are part of OpenTelemetry semantic conventions SHOULD be part - All names that are part of OpenTelemetry semantic conventions SHOULD be part