Skip to content

docs: clarify View attribute filtering interaction with Exemplars #8419

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

Open
kyyril wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: clarify View attribute filtering interaction with Exemplars #8419

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
644dfd3
docs: document interaction between View attribute filtering and Exemp…
kyyril May 20, 2026
aa12105
docs: address reviewer comments on View and ViewBuilder
kyyril May 21, 2026
cd5f33e
docs: clarify custom ExemplarFilter is not supported in Java
kyyril May 21, 2026
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
12 changes: 12 additions & 0 deletions sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/ViewBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ public ViewBuilder setAggregation(Aggregation aggregation) {
/**
* Sets a filter which retains attribute keys included in {@code keysToRetain}.
*
* <p>Note: Attributes dropped by this filter may still appear on recorded exemplars. If you need
* to remove sensitive data from exemplars, you must disable exemplars entirely (e.g., using
* {@link SdkMeterProviderBuilder#setExemplarFilter(ExemplarFilter)} with {@link
* ExemplarFilter#alwaysOff()}), filter them using a delegating exporter, or filter them in the
* OpenTelemetry Collector.
*
* @since 1.30.0
*/
public ViewBuilder setAttributeFilter(Set<String> keysToRetain) {
Expand All @@ -89,6 +95,12 @@ public ViewBuilder setAttributeFilter(Set<String> keysToRetain) {
*
* <p>Only attribute keys that pass the supplied {@link Predicate} will be included in the output.
*
* <p>Note: Attributes dropped by this filter may still appear on recorded exemplars. If you need
* to remove sensitive data from exemplars, you must disable exemplars entirely (e.g., using
* {@link SdkMeterProviderBuilder#setExemplarFilter(ExemplarFilter)} with {@link
* ExemplarFilter#alwaysOff()}), filter them using a delegating exporter, or filter them in the
* OpenTelemetry Collector.
*
* @param keyFilter filter for attribute keys to include.
*/
public ViewBuilder setAttributeFilter(Predicate<String> keyFilter) {
Expand Down
Loading