quarkusio/quarkus

OpenTelemetry: Respect provided TracingPolicy in VertxTracer implementations

Open

#25417 opened on May 6, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (12,967 stars) (2,464 forks)batch import
area/tracinggood first issuekind/enhancement

Description

Description

When using the quarkus-opentelemetry extension, there currently seems to be no direct way to switch off certain kinds of instrumentation. For example, the Vert.x event bus instrumentation might produce traces that are not needed in certain applications and just produce noise there.

Reading the Vert.x OpenTelemetry documentation, the assumption would be, that the solution here is to just set the TracingPolicy.IGNORE policy on the Vert.x event bus DeliveryOptions.

But this doesn't work with the Quarkus VertxTracer implementations. There, the TracingPolicy parameter is getting ignored (in contrast to the Vert.x OpenTelemetryTracer implementation).

Another example would be HTTP server/client instrumention, where also the TracingPolicy can be set in the client/server options. Being able to use TracingPolicy.IGNORE there would for example make it easier to migrate applications already having a (manual) HTTP request instrumentation. (Letting the HttpInstrumenterVertxTracer traces be discarded by means of a custom Sampler implementation looks like an inferior workaround.)

Implementation ideas

Skip request processing in the Quarkus VertxTracer implementations for requests with TracingPolicy.IGNORE (as done in the Vert.x OpenTelemetryTracer).

Contributor guide

Tech stack
java
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java programmingQuarkus extension modelOpenTelemetry conceptsVert.x tracing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the Quarkus VertxTracer implementations (e.g., in the quarkus opentelemetry extension) to identify where TracingPolicy is ignored. Review the Vert.x OpenTelemetryTracer reference implementation at https://github.com/eclipse vertx/vertx tracing/blob/e79d0886927abe6f82ec0039e6f06b2c723d3159/vertx opentelemetry/src/main/java/io/vertx/tracing/opentelemetry/OpenTelemetryTracer.java to understand how policy should be respected. Implement the skip logic for requests with TracingPolicy.IGNORE. Check the issue comments for any additional context or maintainer guidance.