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.

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

metrics: Define name syntax #3643

Closed
wants to merge 2 commits into from
Closed

metrics: Define name syntax #3643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5162949
Define name syntax
pellared Aug 7, 2023
42419af
Update changelog
pellared Aug 7, 2023
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ release.
([#3546](https://github.com/open-telemetry/opentelemetry-specification/pull/3546))
- Revise the exemplar default reservoirs.
([#3627](https://github.com/open-telemetry/opentelemetry-specification/pull/3627))
- Have the same name syntax for meter name and instrument name.
([#3643](https://github.com/open-telemetry/opentelemetry-specification/pull/3643))

### Logs

Expand Down
54 changes: 28 additions & 26 deletions specification/metrics/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ linkTitle: API
* [Meter operations](#meter-operations)
- [Instrument](#instrument)
* [General characteristics](#general-characteristics)
+ [Instrument name syntax](#instrument-name-syntax)
+ [Instrument unit](#instrument-unit)
+ [Instrument description](#instrument-description)
+ [Instrument advice](#instrument-advice)
Expand Down Expand Up @@ -49,6 +48,7 @@ linkTitle: API
+ [Asynchronous UpDownCounter operations](#asynchronous-updowncounter-operations)
- [Measurement](#measurement)
* [Multiple-instrument callbacks](#multiple-instrument-callbacks)
- [Name syntax](#name-syntax)
- [Compatibility requirements](#compatibility-requirements)
- [Concurrency requirements](#concurrency-requirements)

Expand Down Expand Up @@ -124,6 +124,10 @@ This API MUST accept the following parameters:
library](../glossary.md#instrumentation-library) can refer to the same
library. In that scenario, the `name` denotes a module name or component name
within that library or application.

The API SHOULD be documented in a way to communicate to users that the `name`
parameter needs to conform to the [name syntax](#name-syntax). The API SHOULD
NOT validate the `name`; that is left to implementations of the API.
* `version`: Specifies the version of the instrumentation scope if the scope
has a version (e.g. a library version). Example value: `1.0.0`.

Expand Down Expand Up @@ -196,25 +200,6 @@ identifying fields are equal.

### General characteristics

#### Instrument name syntax

The instrument name syntax is defined below using the [Augmented Backus-Naur
Form](https://tools.ietf.org/html/rfc5234):

```abnf
instrument-name = ALPHA 0*62 ("_" / "." / "-" / ALPHA / DIGIT)

ALPHA = %x41-5A / %x61-7A; A-Z / a-z
DIGIT = %x30-39 ; 0-9
```

* They are not null or empty strings.
* They are case-insensitive, ASCII strings.
* The first character must be an alphabetic character.
* Subsequent characters must belong to the alphanumeric characters, '_', '.',
and '-'.
* They can have a maximum length of 63 characters.

#### Instrument unit

The `unit` is an optional string provided by the author of the Instrument. The
Expand Down Expand Up @@ -294,9 +279,8 @@ The API to construct synchronous instruments MUST accept the following parameter
in a way to communicate to users that this parameter is needed.

The API SHOULD be documented in a way to communicate to users that the `name`
parameter needs to conform to the [instrument name
syntax](#instrument-name-syntax). The API SHOULD NOT validate the `name`;
that is left to implementations of the API.
parameter needs to conform to the [name syntax](#name-syntax). The API SHOULD
NOT validate the `name`; that is left to implementations of the API.
* A `unit` of measure.

Users can provide a `unit`, but it is up to their discretion. Therefore, this
Expand Down Expand Up @@ -347,9 +331,8 @@ The API to construct asynchronous instruments MUST accept the following paramete
in a way to communicate to users that this parameter is needed.

The API SHOULD be documented in a way to communicate to users that the `name`
parameter needs to conform to the [instrument name
syntax](#instrument-name-syntax). The API SHOULD NOT validate the `name`,
that is left to implementations of the API.
parameter needs to conform to the [name syntax](#name-syntax). The API SHOULD
NOT validate the `name`; that is left to implementations of the API.
* A `unit` of measure.

Users can provide a `unit`, but it is up to their discretion. Therefore, this
Expand Down Expand Up @@ -1189,6 +1172,25 @@ class Device:
result.observe(self.pressure, pressure, {'property', self.property})
```

## Name syntax

The meter and instrument name syntax is defined below using the
[Augmented Backus-Naur Form](https://tools.ietf.org/html/rfc5234):

```abnf
name = ALPHA 0*62 ("_" / "." / "-" / ALPHA / DIGIT)

ALPHA = %x41-5A / %x61-7A; A-Z / a-z
DIGIT = %x30-39 ; 0-9
```

* They are not null or empty strings.
* They are case-insensitive, ASCII strings.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will introduce a similar issue to this. I would recommend the meter name syntax not be case-insensitive.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I understand correctly that in order to address this comment I would need to introduce a dedicated section for meter name instead of unifying the name syntax (as we should not make the existing instrument name case-sensitive)?

* The first character must be an alphabetic character.
* Subsequent characters must belong to the alphanumeric characters, '_', '.',
and '-'.
* They can have a maximum length of 63 characters.

## Compatibility requirements

All the metrics components SHOULD allow new APIs to be added to
Expand Down
13 changes: 8 additions & 5 deletions specification/metrics/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,13 @@ The input provided by the user MUST be used to create
an [`InstrumentationScope`](../glossary.md#instrumentation-scope) instance which
is stored on the created `Meter`.

In the case where an invalid `name` (null or empty string) is specified, a
working Meter MUST be returned as a fallback rather than returning null or
throwing an exception, its `name` SHOULD keep the original invalid value, and a
message reporting that the specified value is invalid SHOULD be logged.
When a MeterProvider creates a Meter, it SHOULD validate the meter name
conforms to the [name syntax](./api.md#name-syntax).

If the instrument name does not conform to this syntax, a working Meter MUST be
returned as a fallback rather than returning null or throwing an exception,
its `name` SHOULD keep the original invalid value, and a message reporting that
the specified value is invalid SHOULD be logged.

When a Schema URL is passed as an argument when creating a `Meter` the emitted
telemetry for that `Meter` MUST be associated with the Schema URL, provided
Expand Down Expand Up @@ -804,7 +807,7 @@ information for the user on how to resolve the conflict, if possible.
### Instrument name

When a Meter creates an instrument, it SHOULD validate the instrument name
conforms to the [instrument name syntax](./api.md#instrument-name-syntax)
conforms to the [name syntax](./api.md#name-syntax).

If the instrument name does not conform to this syntax, the Meter SHOULD emit
an error notifying the user about the invalid name. It is left unspecified if a
Expand Down