feat(o11y): introduce server.port attribute by diegomarquezp · Pull Request #4128 · googleapis/sdk-platform-java · GitHub

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the observability features by introducing a server.port attribute to tracing spans. This allows for more granular monitoring and debugging by providing the specific port used for server communication in addition to the server address. The changes involve updating core GAX components to extract, store, and propagate this new attribute, along with adapting the OpenTelemetry integration to handle integer-type attributes.

Highlights

Introduced server.port attribute: The server.port attribute is now extracted from the endpoint and included in observability traces, providing more detailed connection information.
Updated tracing context to support Integer attributes: ApiTracerContext and related tracing components now support Integer values for attributes, specifically for server.port, by changing attribute maps from Map<String, String> to Map<String, Object>.
Enhanced endpoint parsing: EndpointContext gained new logic to parse and resolve the server port from an endpoint string, handling various formats including those with schemes and IPv6 literals.

Changelog

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java
- Added setServerPort call to ApiTracerContext.newBuilder().
gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java
- Added abstract method resolvedServerPort() to EndpointContext.
- Added abstract method setResolvedServerPort() to EndpointContext.Builder.
- Implemented parseServerPort() method to extract the port from an endpoint string.
- Called setResolvedServerPort() in the build() method to populate the port.
gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracerContext.java
- Changed getAttemptAttributes() return type from Map<String, String> to Map<String, Object>.
- Added getServerPort() abstract method.
- Added setServerPort() abstract method to Builder.
- Included server.port in getAttemptAttributes() if available.
gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityAttributes.java
- Defined SERVER_PORT_ATTRIBUTE constant.
gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTraceManager.java
- Updated createSpan to accept Map<String, Object> for attributes.
- Modified attribute handling to correctly set String and Integer (converted to long) types for OpenTelemetry spans.
gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java
- Updated attemptAttributes and attemptStarted to use Map<String, Object> for attributes.
gax-java/gax/src/test/java/com/google/api/gax/rpc/EndpointContextTest.java
- Added assertions to verify resolvedServerPort() correctly extracts port numbers from various endpoint formats.
gax-java/gax/src/test/java/com/google/api/gax/tracing/OpenTelemetryTraceManagerTest.java
- Updated testCreateSpan_recordsSpan to use Map<String, Object> for attributes.
gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerFactoryTest.java
- Updated attributesCaptor to capture Map<String, Object>.
gax-java/gax/src/test/java/com/google/api/gax/tracing/SpanTracerTest.java
- Updated attributesCaptor to capture Map<String, Object>.
java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java
- Added SHOWCASE_SERVER_PORT constant.
- Enhanced integration tests to assert the presence and correctness of the server.port attribute in OpenTelemetry traces for both gRPC and HTTP/JSON.

Activity

No specific activity (comments, reviews, etc.) was provided in the context for this pull request.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

Code Review

This pull request introduces the server.port attribute for observability, which is a valuable addition for tracing. The changes are consistently applied across the codebase, from endpoint parsing in EndpointContext to the OpenTelemetryTraceManager. The necessary API changes, like updating attribute maps to Map<String, Object>, are handled correctly. The tests, including unit and integration tests, are updated to cover the new functionality. I have one suggestion to improve the robustness of attribute handling in OpenTelemetryTraceManager for future maintainability.

The current implementation for setting attributes on the span only handles String and Integer types. While this is sufficient for the current changes, it makes the code brittle. If other attribute types (like Long, Double, or Boolean) are added in the future, they will be silently ignored. To improve future maintainability, it would be more robust to handle all primitive types supported by OpenTelemetry attributes.

          (k, v) -> {
            if (v instanceof String) {
              spanBuilder.setAttribute(k, (String) v);
            } else if (v instanceof Integer) {
              spanBuilder.setAttribute(k, (long) (Integer) v);
            } else if (v instanceof Long) {
              spanBuilder.setAttribute(k, (Long) v);
            } else if (v instanceof Double) {
              spanBuilder.setAttribute(k, (Double) v);
            } else if (v instanceof Boolean) {
              spanBuilder.setAttribute(k, (Boolean) v);
            }

/gemini I think it's worth to restrict it to only types we are introducing for now. New types are not expected and expanding this list will also imply additional testing (maintenance) for adding only one more type.

Does the type matter? Would it cause any differences in the UI? If not, can we just use String?

Offline discussion: let's conform to SemConv and keep port as an Integer.

…-attr/server.port

The logic in this method is pretty much identical to the last method parseServerAddress, can we merge these two?

Done

Does the type matter? Would it cause any differences in the UI? If not, can we just use String?

I might missed this in the first PR, it's better to split these test cases to one case per test.

Done

Let's try to check both null and empty, this applies to all attributes too. We can use Strings.isNullOrEmpty.

Added the check for the other if-statements, but serverPort() is an Integer.

…-attr/server.port

…xtTest

/gemini review

Code Review

This pull request introduces the server.port attribute to observability traces, which is a valuable addition. The changes involve parsing the port from the endpoint in EndpointContext and propagating it through to the TraceManager. The related tracing classes have been updated to handle Map<String, Object> for attributes to support the integer-based port number.

I've identified a critical regression in the endpoint parsing logic that affects bare IPv6 addresses. Additionally, there's an opportunity to make the attribute handling in OpenTelemetryTraceManager more robust. Please see my detailed comments.

Quality Gate passed for 'gapic-generator-java-root'

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
87.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Quality Gate failed for 'java_showcase_integration_tests'

Failed conditions
73.5% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

🤖 I have created a release *beep* *boop* --- <details><summary>2.68.0</summary> ## [2.68.0](v2.67.0...v2.68.0) (2026-03-17) ### Features * Add client request duration metric. ([#4132](#4132)) ([6a76397](6a76397)) * Add more attributes to golden signals metrics. ([#4135](#4135)) ([59d0624](59d0624)) * **gax-httpjson:** add HttpJsonErrorParser utility ([#4137](#4137)) ([a1b7565](a1b7565)) * **generator:** add extra allowed modules that will not be removed from the monorepo if they are present ([#4124](#4124)) ([774fe6e](774fe6e)) * **o11y:** introduce `gcp.client.repo` and `gcp.client.artifact` attributes ([#4120](#4120)) ([105f644](105f644)) * **o11y:** Introduce `rpc.system.name` and `rpc.method` in gRPC ([#4121](#4121)) ([7ab6d2e](7ab6d2e)) * **o11y:** introduce server.port attribute ([#4128](#4128)) ([56aa343](56aa343)) ### Bug Fixes * add null checks for ApiTracerFactory in ClientContext ([#4122](#4122)) ([4b3dbe2](4b3dbe2)) * Decrease log level for directpath warnings outside GCE ([#4139](#4139)) ([c9651e7](c9651e7)) * **gax-grpc:** add pick_first fallback to direct path service config ([#4143](#4143)) ([b150fe9](b150fe9)) * Populate method level attributes in metrics recording ([#4149](#4149)) ([7b7e6c9](7b7e6c9)) * suppress warnings in generated projects for non-idiomatic durations ([#4119](#4119)) ([4206e6e](4206e6e)) * Use ServiceName + MethodName as the regex for Otel ([#2543](#2543)) ([b9ae73f](b9ae73f)) ### Documentation * **hermetic_build:** fix config field name in readme ([#4130](#4130)) ([a0c8f67](a0c8f67)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

🤖 I have created a release *beep* *boop* --- <details><summary>2.68.0</summary> ## [2.68.0](googleapis/sdk-platform-java@v2.67.0...v2.68.0) (2026-03-17) ### Features * Add client request duration metric. ([#4132](googleapis/sdk-platform-java#4132)) ([487650e](googleapis/sdk-platform-java@487650e)) * Add more attributes to golden signals metrics. ([#4135](googleapis/sdk-platform-java#4135)) ([bc82dcb](googleapis/sdk-platform-java@bc82dcb)) * **gax-httpjson:** add HttpJsonErrorParser utility ([#4137](googleapis/sdk-platform-java#4137)) ([6fe2446](googleapis/sdk-platform-java@6fe2446)) * **generator:** add extra allowed modules that will not be removed from the monorepo if they are present ([#4124](googleapis/sdk-platform-java#4124)) ([6a440da](googleapis/sdk-platform-java@6a440da)) * **o11y:** introduce `gcp.client.repo` and `gcp.client.artifact` attributes ([#4120](googleapis/sdk-platform-java#4120)) ([4954de5](googleapis/sdk-platform-java@4954de5)) * **o11y:** Introduce `rpc.system.name` and `rpc.method` in gRPC ([#4121](googleapis/sdk-platform-java#4121)) ([3593c30](googleapis/sdk-platform-java@3593c30)) * **o11y:** introduce server.port attribute ([#4128](googleapis/sdk-platform-java#4128)) ([1b10e02](googleapis/sdk-platform-java@1b10e02)) ### Bug Fixes * add null checks for ApiTracerFactory in ClientContext ([#4122](googleapis/sdk-platform-java#4122)) ([ded1922](googleapis/sdk-platform-java@ded1922)) * Decrease log level for directpath warnings outside GCE ([#4139](googleapis/sdk-platform-java#4139)) ([5151f34](googleapis/sdk-platform-java@5151f34)) * **gax-grpc:** add pick_first fallback to direct path service config ([#4143](googleapis/sdk-platform-java#4143)) ([4934ad8](googleapis/sdk-platform-java@4934ad8)) * Populate method level attributes in metrics recording ([#4149](googleapis/sdk-platform-java#4149)) ([69aabf8](googleapis/sdk-platform-java@69aabf8)) * suppress warnings in generated projects for non-idiomatic durations ([#4119](googleapis/sdk-platform-java#4119)) ([8a0c565](googleapis/sdk-platform-java@8a0c565)) * Use ServiceName + MethodName as the regex for Otel ([#2543](googleapis/sdk-platform-java#2543)) ([8196b8f](googleapis/sdk-platform-java@8196b8f)) ### Documentation * **hermetic_build:** fix config field name in readme ([#4130](googleapis/sdk-platform-java#4130)) ([0d98c37](googleapis/sdk-platform-java@0d98c37)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

feat(o11y): introduce server.port attribute

9e08c8f

product-auto-label Bot added the size: m Pull request size is medium. label Mar 2, 2026

gemini-code-assist Bot reviewed Mar 2, 2026

View reviewed changes

Merge remote-tracking branch 'origin/main' into observability/tracing…

0bccfec

…-attr/server.port

diegomarquezp marked this pull request as ready for review March 2, 2026 22:46

blakeli0 reviewed Mar 3, 2026

View reviewed changes

diegomarquezp added 4 commits March 4, 2026 11:41

Merge remote-tracking branch 'origin/main' into observability/tracing…

820bc4b

…-attr/server.port

fix: deduplicate logic in EndpointContext.getServer[Port|Host]

235fa2b

fix: use isNullOrEmpty in ApiTracerContext

24a2af1

test: separation of concerns for port and host tests in EndpointConte…

816d263

…xtTest

fix: restore original logic of host parsing in EndpointContext

dda8251

gemini-code-assist Bot reviewed Mar 4, 2026

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java

Comment thread gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTraceManager.java

test: cover integer logic in OtelSpanManager

14d3b87

blakeli0 reviewed Mar 4, 2026

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java Outdated

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java Outdated

fix: use resolvedEndpoint()

50667c3

blakeli0 approved these changes Mar 5, 2026

View reviewed changes

Merge branch 'main' into observability/tracing-attr/server.port

c307c5a

diegomarquezp merged commit 56aa343 into main Mar 5, 2026
55 of 57 checks passed

diegomarquezp deleted the observability/tracing-attr/server.port branch March 5, 2026 20:04

release-please Bot mentioned this pull request Mar 4, 2026

chore(main): release 2.68.0 #4123

Merged

diegomarquezp mentioned this pull request Mar 13, 2026

chore(observability/tracing-attr/gcp.client.version-2): release 2.68.0 #4141

Closed

                           .setTransportChannelProviderEndpoint(null)
                           .build();
                   Truth.assertThat(endpointContext.resolvedServerAddress()).isEqualTo("localhost");
+                  Truth.assertThat(endpointContext.resolvedServerPort()).isEqualTo(7469);

+                    }
+                    try {
+                      HostAndPort parsedHostPort = HostAndPort.fromString(hostPort);
+                      if (parsedHostPort.hasPort()) {

                   if (serverAddress() != null) {
                     attributes.put(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE, serverAddress());
                   }
+                  if (serverPort() != null) {

feat(o11y): introduce server.port attribute by diegomarquezp · Pull Request #4128 · googleapis/sdk-platform-java · GitHub

Uh oh!

feat(o11y): introduce server.port attribute - #4128

feat(o11y): introduce server.port attribute#4128diegomarquezp merged 10 commits intomaingoogleapis/sdk-platform-java:mainfrom observability/tracing-attr/server.portgoogleapis/sdk-platform-java:observability/tracing-attr/server.portCopy head branch name to clipboard

Conversation

diegomarquezp commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot commented Mar 2, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diegomarquezp commented Mar 4, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Mar 5, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud Bot commented Mar 5, 2026

Quality Gate failed for 'java_showcase_integration_tests'

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat(o11y): introduce server.port attribute#4128
diegomarquezp merged 10 commits into
mainfrom
observability/tracing-attr/server.port

diegomarquezp commented Mar 2, 2026 •
edited
Loading