open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Provide a normative definition of Attribute (singular) rather than Attributes (plural) (#2123) 

* Provide a normative definition of Attribute (singular)

- Providing a normative definition of **attribute** (singular)
- Other copyedits

/cc @austinlparker @tedsuo

* Move anchor to make markdown checker happy
This commit is contained in:
Patrice Chalin 2021-11-16 10:05:01 -05:00 committed by Josh Suereth
parent 19e4040e36
commit 6c59f11a4a
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
specification/common/common.md
View File

@ -7,21 +7,23 @@
Table of Contents Table of Contents
</summary> </summary>
- [Attributes](#attributes) - [Attribute](#attribute)
- [Attribute Limits](#attribute-limits) - [Attribute Limits](#attribute-limits)
- [Exempt Entities](#exempt-entities) - [Exempt Entities](#exempt-entities)
</details> </details>
## Attributes ## Attribute
Attributes are a list of zero or more key-value pairs. An `Attribute` MUST have the following properties: <a id="attributes"></a>
- The attribute key, which MUST be a non-`null` and non-empty string. An `Attribute` is a key-value pair, which MUST have the following properties:
- The attribute value, which is either:
- The attribute key MUST be a non-`null` and non-empty string.
- The attribute value is either:
- A primitive type: string, boolean, double precision floating point (IEEE 754-1985) or signed 64 bit integer. - A primitive type: string, boolean, double precision floating point (IEEE 754-1985) or signed 64 bit integer.
- An array of primitive type values. The array MUST be homogeneous, - An array of primitive type values. The array MUST be homogeneous,
i.e. it MUST NOT contain values of different types. For protocols that do i.e., it MUST NOT contain values of different types. For protocols that do
not natively support array values such values SHOULD be represented as JSON strings. not natively support array values such values SHOULD be represented as JSON strings.
Attribute values expressing a numerical value of zero, an empty string, or an Attribute values expressing a numerical value of zero, an empty string, or an
@ -64,7 +66,7 @@ If an SDK provides a way to:
values separately, values separately,
- otherwise a value MUST NOT be truncated; - otherwise a value MUST NOT be truncated;
- set a limit of unique attribute keys such that: - set a limit of unique attribute keys such that:
- for each unique attributes key, addition of which would result in exceeding - for each unique attribute key, addition of which would result in exceeding
the limit, SDK MUST discard that key/value pair. the limit, SDK MUST discard that key/value pair.
There MAY be a log emitted to indicate to the user that an attribute was There MAY be a log emitted to indicate to the user that an attribute was