Visitar URL original
opentelemetry: Add target attribute filter for metrics by becomeStar · Pull Request #12587 · grpc/grpc-java · GitHub
Skip to content

opentelemetry: Add target attribute filter for metrics - #12587

Merged
kannanjgithub merged 11 commits into
grpc:masterfrom
becomeStar:otel-target-filter
Jan 9, 2026
Merged

opentelemetry: Add target attribute filter for metrics#12587
kannanjgithub merged 11 commits into
grpc:masterfrom
becomeStar:otel-target-filter

Conversation

@becomeStar

@becomeStar becomeStar commented Dec 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Introduce an optional Predicate targetAttributeFilter to control how grpc.target is recorded in OpenTelemetry client metrics.

When a filter is provided, targets rejected by the predicate are normalized to "other" to reduce grpc.target metric cardinality, while accepted targets are recorded as-is. If no filter is set, existing behavior is preserved.

This change adds a new Builder API on GrpcOpenTelemetry to allow applications to configure the filter. Tests verify both the Builder wiring and the target normalization behavior.

This is an optional API; annotation (e.g., experimental) can be added per maintainer guidance.

Refs #12322
Related: gRFC A109 – Target Attribute Filter for OpenTelemetry Metrics
grpc/proposal#528

@becomeStar
opentelemetry: Add optional targetAttributeFilter to module
6b7763c 
Introduce an optional Predicate<String> targetAttributeFilter in the
OpenTelemetryMetricsModule to control how grpc.target is recorded in
metrics. Also add support in GrpcOpenTelemetry.Builder to allow users
to configure this filter when building the module.
@becomeStar
opentelemetry: Add Javadoc for target attribute filter
1a0453f
@becomeStar
opentelemetry: Simplify ClientCall initialization in tests
c9d1942
@becomeStar
opentelemetry: Rerun flaky test
f14d91d
@becomeStar
opentelemetry: Rerun flaky test
0aae4d5
@becomeStar

becomeStar commented Dec 31, 2025

Copy link
Copy Markdown
Contributor Author

Thanks for looping me in. I'll keep an eye on the Android desugaring discussion.

In the meantime, I've updated the PR and gRFC A109 with a null-safety check for the filtering logic to make it more robust.

If it turns out that using Java 8's Predicate causes compatibility concerns, I'm happy to adjust the interface accordingly (e.g., using a small custom functional interface), based on what the maintainers think is best.

ejona86
ejona86 reviewed Jan 2, 2026
View reviewed changes
Comment thread opentelemetry/src/main/java/io/grpc/opentelemetry/GrpcOpenTelemetry.java Resolved
Comment thread opentelemetry/src/main/java/io/grpc/opentelemetry/GrpcOpenTelemetry.java Resolved
@becomeStar becomeStar mentioned this pull request Jan 3, 2026
Open
@becomeStar
opentelemetry: Use internal interface for target filter
92038a0 
Replace Predicate with a package-private TargetFilter interface in
fields to ensure compatibility with Android API levels < 24. This
prevents potential runtime issues for Android users who do not use
the filtering feature.

Mark the API as experimental and link the tracking issue.
@becomeStar
opentelemetry: Avoid method reference for better Android compatibility
8a7a7ff
@becomeStar
opentelemetry: Add @IgnoreJRERequirement for Android CI compatibility
f8f68d4
@becomeStar
opentelemetry: Rerun ci test
d227ef9
@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Jan 5, 2026
@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Jan 5, 2026
@ejona86

ejona86 commented Jan 5, 2026

Copy link
Copy Markdown
Member

/gcbrun

@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Jan 6, 2026
ejona86
ejona86 approved these changes Jan 6, 2026
View reviewed changes

@ejona86 ejona86 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, I meant to approve when sending my last comment.

@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Jan 6, 2026
@ejona86

ejona86 commented Jan 6, 2026

Copy link
Copy Markdown
Member

/gcbrun

@kannanjgithub
kannanjgithub merged commit c5f5ee0 into grpc:master Jan 9, 2026
17 checks passed
jdcormie pushed a commit to jdcormie/grpc-java that referenced this pull request Feb 11, 2026
@becomeStar @jdcormie
opentelemetry: Add target attribute filter for metrics (grpc#12587)
114768e 
Introduce an optional Predicate<String> targetAttributeFilter to control how grpc.target is recorded in OpenTelemetry client metrics.

When a filter is provided, targets rejected by the predicate are normalized to "other" to reduce grpc.target metric cardinality, while accepted targets are recorded as-is. If no filter is set, existing behavior is preserved.

This change adds a new Builder API on GrpcOpenTelemetry to allow applications to configure the filter. Tests verify both the Builder
wiring and the target normalization behavior.

This is an optional API; annotation (e.g., experimental) can be added
per maintainer guidance.

Refs grpc#12322
Related: gRFC A109 – Target Attribute Filter for OpenTelemetry Metrics
grpc/proposal#528
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Apr 10, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@ejona86 ejona86 ejona86 approved these changes
@shivaspeaks shivaspeaks Awaiting requested review from shivaspeaks

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@becomeStar @ejona86 @grpc-kokoro @kannanjgithub