Skip to content

Commit

Permalink
Clarify the minimal implementation of a View's attribute_keys is …
Browse files Browse the repository at this point in the history
…an allow-list (open-telemetry#3680)
  • Loading branch information
MrAlias authored Sep 8, 2023
1 parent e940f33 commit 16bb7c8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ release.
([#3670](https://github.com/open-telemetry/opentelemetry-specification/pull/3670))
- Rename "advice" to "advisory parameters".
([#3662](https://github.com/open-telemetry/opentelemetry-specification/pull/3662))
- Clarify the minimal implementation of a `View`'s `attribute_keys` is an allow-list.
([#3680](https://github.com/open-telemetry/opentelemetry-specification/pull/3680))

### Logs

Expand Down
10 changes: 7 additions & 3 deletions specification/metrics/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,9 +314,13 @@ The SDK MUST accept the following stream configuration parameters:
accept a `description`, but MUST NOT obligate a user to provide one. If the
user does not provide a `description` value, the description from the
Instrument a View matches MUST be used by default.
* `attribute_keys`: A list of attribute keys that MUST be kept, if provided by
the user during the measurement, for the metric stream. All attributes with
keys other than those in the list MUST be ignored.
* `attribute_keys`: This is, at a minimum, an allow-list of attribute keys for
measurements captured in the metric stream. The allow-list contains attribute
keys that identify the attributes that MUST be kept, and all other attributes
MUST be ignored.

Implementations MAY accept additional attribute filtering functionality for
this parameter.

Users can provide `attribute_keys`, but it is up to their discretion.
Therefore, the stream configuration parameter needs to be structured to
Expand Down

0 comments on commit 16bb7c8

Please sign in to comment.