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

Clarify the minimal implementation of a View's attribute_keys is an allow-list #3680

Merged
merged 4 commits into from
Sep 8, 2023
Merged

Clarify the minimal implementation of a View's attribute_keys is an allow-list #3680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46a4ab1
Clarify `attribute_keys` min impl is allow-list
MrAlias Aug 31, 2023
1591f08
Add a changelog entry
MrAlias Aug 31, 2023
03b5fc7
Merge branch 'main' into attribute_keys
MrAlias Sep 5, 2023
61c9f9e
Merge branch 'main' into attribute_keys
MrAlias Sep 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 @@ -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
View file
Open in desktop
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
Loading