org.glassfish.jersey.examples.opentracing

Class TracedResource

java.lang.Object

org.glassfish.jersey.examples.opentracing.TracedResource

@Path(value="/resource")
public class TracedResource
extends Object

OpenTracing example resource.

Jersey (with registered OpenTracingFeature will automatically create and start span for each request ("root" span or "request" span) and a child span to be used in the resource method ("resource" span). The root span is used for Jersey-level event logging (resource matching started, request filters applied, etc). The resource span serves for application-level event logging purposes (used-defined). Both are automatically created and also automatically finished.

Resource span is created right before the resource method invocation and finished right after resource method finishes. It can be resolved by calling OpenTracingUtils.getRequestSpan(ContainerRequestContext).

Application code can also create ad-hoc spans as child spans of the resource span. This can be achieved by calling one of the convenience methods OpenTracingUtils.getRequestChildSpan(ContainerRequestContext).

ContainerRequestContext can be obtained via injection.

All the ad-hoc created spans MUST be finished explicitly.

Author:

Adam Lindenthal

Constructor Summary

Constructors

Constructor and Description
TracedResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	appLevelLogging(javax.ws.rs.container.ContainerRequestContext context) Resource method with explicit logging into resource span.
javax.ws.rs.core.Response	childSpan(javax.ws.rs.container.ContainerRequestContext context) Resource method with explicit child span creation.
javax.ws.rs.core.Response	defaultTrace() Resource method with no explicit tracing.
String	failTrace(javax.ws.rs.container.ContainerRequestContext context)
javax.ws.rs.core.Response	tracePost(String entity, javax.ws.rs.container.ContainerRequestContext context) Similar as appLevelLogging(ContainerRequestContext), just with POST method.
void	traceWithAsync(javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.container.ContainerRequestContext context)
javax.ws.rs.core.Response	traceWithManagedClient(javax.ws.rs.container.ContainerRequestContext context, javax.ws.rs.client.WebTarget wt) Resource method with explicit span creation and propagation into injected managed client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TracedResource

public TracedResource()

Method Detail

defaultTrace

@GET
 @Path(value="defaultTrace")
public javax.ws.rs.core.Response defaultTrace()

Resource method with no explicit tracing.

One span (jersey-server) will be created and finished automatically.

Returns:

dummy response

appLevelLogging

@GET
 @Path(value="appLevelLogging")
public javax.ws.rs.core.Response appLevelLogging(@Context
                                                                                      javax.ws.rs.container.ContainerRequestContext context)
                                                                               throws InterruptedException

Resource method with explicit logging into resource span.

Parameters:

context - injected request context with resource-level span reference

Returns:

dummy response

Throws:

InterruptedException - if interrupted

tracePost

@POST
 @Path(value="appLevelPost")
public javax.ws.rs.core.Response tracePost(String entity,
                                                                              @Context
                                                                              javax.ws.rs.container.ContainerRequestContext context)

Similar as appLevelLogging(ContainerRequestContext), just with POST method.

Parameters:

entity - posted entity

context - injected context

Returns:

dummy response

childSpan

@GET
 @Path(value="childSpan")
public javax.ws.rs.core.Response childSpan(@Context
                                                                          javax.ws.rs.container.ContainerRequestContext context)
                                                                   throws InterruptedException

Resource method with explicit child span creation.

Parameters:

context - injected request context with resource-level (parent) span reference

Returns:

dummy response

Throws:

InterruptedException - if interrupted

traceWithManagedClient

@GET
 @Path(value="managedClient")
public javax.ws.rs.core.Response traceWithManagedClient(@Context
                                                                                           javax.ws.rs.container.ContainerRequestContext context,
                                                                                           @Uri(value="resource/appLevelPost")
                                                                                           javax.ws.rs.client.WebTarget wt)

Resource method with explicit span creation and propagation into injected managed client.

Shows how to propagate the server-side span into managed client (or any common Jersey client). This way, the client span will be child of the resource span.

Parameters:

context - injected context

wt - injected web target

Returns:

dummy response

traceWithAsync

@GET
 @Path(value="async")
 @ManagedAsync
public void traceWithAsync(@Suspended
                                                                     javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                     @Context
                                                                     javax.ws.rs.container.ContainerRequestContext context)

failTrace

@GET
 @Path(value="error")
public String failTrace(@Context
                                                   javax.ws.rs.container.ContainerRequestContext context)