Skip to content

Conversation

@ehsavoie
Copy link
Collaborator

Adding support for OpenTelemetry

Fixes #388 🦕

@ehsavoie ehsavoie requested review from fjuma and kabir November 18, 2025 15:54
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ehsavoie, 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 integrates OpenTelemetry into the A2A Java SDK, providing robust distributed tracing capabilities. The changes enable automatic span creation for both client-initiated and server-processed A2A requests, offering deeper visibility into the flow of operations. This enhancement is crucial for monitoring, troubleshooting, and understanding the performance characteristics of applications built with the SDK.

Highlights

  • OpenTelemetry Module: Introduced a new Maven module, extras/opentelemetry, to encapsulate all OpenTelemetry integration logic for the A2A Java SDK.
  • Client-Side Tracing: Implemented dynamic wrapping of ClientTransport instances with OpenTelemetryClientTransport within the ClientBuilder. This allows for automatic tracing of client-side A2A interactions when an OpenTelemetry Tracer is provided in the ClientTransportConfig.
  • Server-Side Tracing Interceptors: Added a new @Trace annotation and SpanInterceptor mechanism to enable automatic distributed tracing for server-side request handler methods across gRPC, JSON-RPC, and REST protocols. Custom AttributeExtractor implementations are used to enrich spans with relevant request details.
  • Enhanced ClientTransportConfig: The ClientTransportConfig now includes a generic parameters map, facilitating the injection of arbitrary configuration, such as the OpenTelemetry Tracer instance, into transport implementations.
  • Example Application Updates: The helloworld example client and server applications have been updated to demonstrate the setup and usage of OpenTelemetry, including dependency additions and configuration for tracing.
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.

Footnotes

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds support for OpenTelemetry, which is a great addition for observability. The implementation introduces a new opentelemetry extras module and integrates tracing on both the client and server sides. On the client side, it uses reflection for optional wrapping, and on the server side, it uses CDI interceptors with a new @Trace annotation. My review focuses on improving the robustness and maintainability of this new feature. I've found a few critical issues, such as a ClassCastException in an attribute extractor and silent exception swallowing that could make debugging difficult. I've also identified several opportunities for code cleanup, such as fixing typos, removing duplicated code, and improving the design of the CDI interceptor to better support dependency injection. Addressing these points will make the OpenTelemetry integration more solid and easier to maintain.

Copy link

@brunobat brunobat left a comment

Choose a reason for hiding this comment

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

I think you need to decide if you are creating your own instrumentation annotations and API or if you just reuse the ones provided by OTel.

Also, the attribute names, should follow these semantic conventions, as much as possible: https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-agent-spans/

@ehsavoie ehsavoie force-pushed the issue_388 branch 4 times, most recently from 7661dd6 to 893ce8b Compare November 20, 2025 13:57
@ehsavoie ehsavoie changed the title Issue 388 feat: Add telemetry support. Nov 20, 2025
@ehsavoie ehsavoie force-pushed the issue_388 branch 2 times, most recently from 22a2af4 to d35543a Compare November 20, 2025 14:46
@ehsavoie ehsavoie requested a review from brunobat November 20, 2025 20:41
Copy link
Collaborator

@kabir kabir left a comment

Choose a reason for hiding this comment

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

A few things which may or may not be needed :-)

kabir
kabir previously requested changes Nov 21, 2025
Copy link
Collaborator

@kabir kabir left a comment

Choose a reason for hiding this comment

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

Actually, @ehsavoie it looks like you are adding Otel tracing to the example. But I don't know how to enable this etc.
Can you update the README with instructions?

Maybe we could also make this example testable in the CI, like we do for the cloud-deployment one?

Also, it would be good to have some tests in the extras module

@ehsavoie ehsavoie force-pushed the issue_388 branch 3 times, most recently from 0eee5a4 to 49b8dd0 Compare January 9, 2026 17:11
Copy link
Collaborator

@kabir kabir left a comment

Choose a reason for hiding this comment

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

@ehsavoie 2 small things.

If the JBang validator is tricky, open an issue and link it here

@ehsavoie ehsavoie added the hold label Jan 16, 2026
@ehsavoie ehsavoie force-pushed the issue_388 branch 2 times, most recently from 0a41c0e to badca86 Compare January 21, 2026 15:15
@ehsavoie ehsavoie requested review from brunobat, jmesnil and kabir and removed request for brunobat and fjuma January 21, 2026 15:25
@kabir
Copy link
Collaborator

kabir commented Jan 27, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces comprehensive OpenTelemetry support across the client and server components, including gRPC, JSON-RPC, and REST transports. The implementation leverages a flexible wrapper pattern for clients and CDI interceptors for servers, allowing for extensible tracing. Attribute extraction is thoughtfully tailored to each transport and method, providing rich and detailed tracing information. The accompanying documentation and tests have been updated to reflect these new capabilities, ensuring clarity and correctness. Overall, the changes are well-implemented and significantly enhance the observability of the A2A SDK.

@ehsavoie ehsavoie requested review from brunobat and kabir February 4, 2026 12:16
@ehsavoie
Copy link
Collaborator Author

ehsavoie commented Feb 4, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces comprehensive OpenTelemetry support for both client and server components. The implementation is well-designed, using a ServiceLoader-based ClientTransportWrapper for the client and CDI interceptors for the server, which allows for clean, decoupled observability. The example applications have been updated to demonstrate how to enable and use this new telemetry feature. The changes are extensive and well-executed. I've found a couple of minor issues: a potential resource leak in the client example due to an incorrectly placed finally block, and a small typo in the README documentation. Overall, this is a great addition to the SDK.

@ehsavoie ehsavoie force-pushed the issue_388 branch 4 times, most recently from 40beee9 to 91fd1be Compare February 6, 2026 18:05
@ehsavoie ehsavoie requested a review from brunobat February 10, 2026 14:13
@ehsavoie ehsavoie force-pushed the issue_388 branch 6 times, most recently from dac0a8d to 7a9afb4 Compare February 11, 2026 11:35
Adds OpenTelemetry integration for distributed tracing:

- Client: OpenTelemetryClientTransport decorator wrapping all client operations
  with span creation and context propagation via ClientTransportWrapper SPI
- Server: OpenTelemetryRequestHandlerDecorator CDI decorator for request handlers
- Common: A2AObservabilityNames for standard observability attributes
- Integration tests with comprehensive coverage for client and server tracing
- Updated HelloWorld examples with OTEL configuration and documentation

Fixes a2aproject#388

Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
* ));
* }</pre>
*/
public class OpenTelemetryClientPropagatorTransportWapper implements ClientTransportWrapper {
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/Wapper/Wrapper

.serena/
.bob/
claudedocs
.bob/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Already on line 59


# NetBeans
nb-configuration.xml
nbactions.xml
Copy link
Collaborator

Choose a reason for hiding this comment

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

There is another NetBeans section further down, which also has this file

}

@Override
public String toString() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Concern:

  • Records auto-generate toString() - explicitly overriding changes public API behavior
  • Used for span attributes when extractRequest/extractResponse flags enabled
  • Consider if this is the right approach for observability data extraction

Recommendation: Document this as intentional API change, or use separate utility method for telemetry formatting

}

@Override
public String toString() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as for Message

import io.opentelemetry.api.trace.Tracer;

/**
* OpenTelemetry client transport wrapper that adds opentelemtry propagation to A2A client calls.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"adds opentelemetry"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feat] Add telemetry support

4 participants