Contents
Overview
|
Warning
|
This feature is marked as @Deprecated in Helidon. Please use the Telemetry feature instead.
The OpenTracing Specification that MP OpenTracing is based on is no longer maintained.
The MP OpenTracing specification is no longer required by MicroProfile.
The specification is superseded by the MicroProfile Telemetry specification.
|
Distributed tracing is a critical feature of micro-service based applications, since it traces workflow both within a service and across multiple services. This provides insight to sequence and timing data for specific blocks of work, which helps you identify performance and operational issues. Helidon MP includes support for distributed tracing through the OpenTracing API. Tracing is integrated with WebServer and Security.
Maven Coordinates
To enable MicroProfile Tracing,
either add a dependency on the helidon-microprofile bundle or
add the following dependency to your project’s pom.xml (see
Managing Dependencies).
<dependency>
<groupId>io.helidon.microprofile.tracing</groupId>
<artifactId>helidon-microprofile-tracing</artifactId>
</dependency>
Usage
This section explains a few concepts that you need to understand before you get started with tracing.
-
In the context of this document, a service is synonymous with an application.
-
A span is the basic unit of work done within a single service, on a single host. Every span has a name, starting timestamp, and duration. For example, the work done by a REST endpoint is a span. A span is associated to a single service, but its descendants can belong to different services and hosts.
-
A trace contains a collection of spans from one or more services, running on one or more hosts. For example, if you trace a service endpoint that calls another service, then the trace would contain spans from both services. Within a trace, spans are organized as a directed acyclic graph (DAG) and can belong to multiple services, running on multiple hosts. The OpenTracing Data Model describes the details at The OpenTracing Semantic Specification. Spans are automatically created by Helidon as needed during execution of the REST request. Additional spans can be added through MP annotation
@Tracedor through OpenTracing APIs.
Traced spans
The following table lists all spans traced by Helidon components:
| component | span name | description |
|---|---|---|
|
|
The overall span of the Web Server from request initiation until response
Note that in |
|
|
Span for reading the request entity |
|
|
Span for writing the response entity |
|
|
Processing of request security |
|
|
Span for request authentication |
|
|
Span for request authorization |
|
|
Processing of response security |
|
|
Processing of outbound security |
|
A generated name |
Span for the resource method invocation, name is generated from class and method name |
|
|
Span for outbound client call |
Some of these spans log to the span. These log events can be (in most cases) configured:
| span name | log name | configurable | enabled by default | description |
|---|---|---|---|---|
|
|
YES |
YES |
Each handler has its class and event logged |
|
|
YES |
YES |
Logs either "status: PROCEED" or "status: DENY" |
|
|
YES |
NO |
The username of the user if logged in |
|
|
YES |
NO |
The name of the service if logged in |
|
|
YES |
YES |
Logs the status of security response (such as |
|
|
YES |
YES |
Logs the status of security response (such as |
|
|
YES |
YES |
Logs the status of security response (such as |
There are also tags that are set by Helidon components. These are not configurable.
| span name | tag name | description |
|---|---|---|
|
|
name of the component - |
|
|
HTTP method of the request, such as |
|
|
HTTP status code of the response |
|
|
The path of the request (for SE without protocol, host and port) |
|
|
If the request ends in error, this tag is set to |
|
|
ID of the security context created for this request (if security is used) |
|
|
HTTP method of the client request |
|
|
HTTP status code of client response |
|
|
Full URL of the request (such as |
Configuration
Enabling and Disabling Tracing
You can configure a custom service name using the tracing.service configuration property. If this
property is undefined, name is created from JAX-RS Application name, or Helidon MP is used if no application
is defined.
Jaeger tracer configuration.
This is a standalone configuration type, prefix from configuration root: tracing
Configuration options
| key | type | default value | description |
|---|---|---|---|
|
|
Certificate of client in PEM format. |
|
|
Duration |
|
Timeout of exporter requests. |
|
int |
|
Maximum Export Batch Size of exporter requests. |
|
int |
|
Maximum Queue Size of exporter requests. |
|
|
Private key in PEM format. |
|
|
PropagationFormat[] (B3, B3_SINGLE, JAEGER, W3C) |
|
Add propagation format to use. Allowed values:
|
|
Number |
|
The sampler parameter (number). |
|
SamplerType (CONSTANT, RATIO) |
|
Sampler type. See Sampler types. Allowed values:
|
|
Duration |
|
Schedule Delay of exporter requests. |
|
SpanProcessorType (SIMPLE, BATCH) |
|
Span Processor type used. Allowed values:
|
|
|
Trusted certificates in PEM format. |
To disable Helidon tracing for web server and security:
tracing.components.web-server.enabled=false
tracing.components.security.enabled=false
To disables MP Tracing as by specification:
mp.opentracing.server.skip-pattern=.*
Tracing configuration can be defined in application.yaml file.
tracing:
paths:
- path: "/favicon.ico"
enabled: false
- path: "/metrics"
enabled: false
- path: "/health"
enabled: false
components:
web-server:
spans:
- name: "HTTP Request"
logs:
- name: "content-write"
enabled: false
Controlling Tracing Output
For Web Server we have a path based support for configuring tracing, in addition to the configuration described above.
Configuration of path can use any path string supported by the Web Server. The configuration itself has the same possibilities as traced configuration described above. The path specific configuration will be merged with global configuration (path is the "newer" configuration, global is the "older")
Renaming top level span using request properties
To have a nicer overview in search pane of a tracer, you can customize the top-level span name using configuration.
Example:
tracing.components.web-server.spans.0.name="HTTP Request"
tracing.components.web-server.spans.0.new-name: "HTTP %1$s %2$s"
This is supported ONLY for the span named "HTTP Request" on component "web-server".
Parameters provided:
-
Method - HTTP method
-
Path - path of the request (such as '/greet')
-
Query - query of the request (may be null)
Examples
The examples in this guide demonstrate how to integrate tracing with Helidon, how to view traces, how to trace across multiple services, and how to integrate tracing with Kubernetes. All examples use Jaeger and traces will be viewed using both the Jaeger UI.
Set up Jaeger
First, you need to run the Jaeger tracer. Helidon will communicate with this tracer at runtime.
docker run -d --name jaeger \ (1)
-e COLLECTOR_OTLP_ENABLED=true \
-p 6831:6831/udp \
-p 6832:6832/udp \
-p 5778:5778 \
-p 16686:16686 \
-p 4317:4317 \
-p 4318:4318 \
-p 14250:14250 \
-p 14268:14268 \
-p 14269:14269 \
-p 9411:9411 \
jaegertracing/all-in-one:1.50
-
Run the Jaeger docker image.
http://localhost:16686/search
Trace Across Services
Helidon automatically traces across services as long as the services use the same tracer, for example, the same instance of Jaeger.
This means a single trace can include spans from multiple services and hosts. OpenTracing uses a SpanContext to propagate tracing information across process boundaries. When you make client API calls, Helidon will internally call OpenTracing APIs to propagate the SpanContext. There is nothing you need to do in your application to make this work.
To demonstrate distributed tracing, you will need to create a second project, where the server listens on port 8081. Create a new root directory to hold this new project, then do the following steps, similar to what you did at the start of this guide:
Create a second service
mvn -U archetype:generate -DinteractiveMode=false \
-DarchetypeGroupId=io.helidon.archetypes \
-DarchetypeArtifactId=helidon-quickstart-mp \
-DarchetypeVersion=4.3.0-SNAPSHOT \
-DgroupId=io.helidon.examples \
-DartifactId=helidon-quickstart-mp-2 \
-Dpackage=io.helidon.examples.quickstart.mp
helidon-quickstart-mp directory:cd helidon-quickstart-mp-2
pom.xml:<dependency>
<groupId>io.helidon.tracing.providers</groupId>
<artifactId>helidon-tracing-providers-jaeger</artifactId>
</dependency>
META-INF/microprofile-config.properties with the following:app.greeting=Hello From MP-2
tracing.service=helidon-mp-2
# Microprofile server properties
server.port=8081
mvn package -DskipTests=true
java -jar target/helidon-quickstart-mp-2.jar
curl http://localhost:8081/greet
{
"message": "Hello From MP-2 World!"
}
Modify the first service
Once you have validated that the second service is running correctly, you need to modify the original application to call it.
GreetResource class with the following code:@Path("/greet")
@RequestScoped
public class GreetResource {
@Uri("http://localhost:8081/greet")
private WebTarget target; // (1)
private static final JsonBuilderFactory JSON = Json.createBuilderFactory(Map.of());
private final GreetingProvider greetingProvider;
@Inject
public GreetResource(GreetingProvider greetingConfig) {
this.greetingProvider = greetingConfig;
}
@GET
@Produces(MediaType.APPLICATION_JSON)
public JsonObject getDefaultMessage() {
return createResponse("World");
}
@GET
@Path("/outbound") // (2)
public JsonObject outbound() {
return target.request().accept(MediaType.APPLICATION_JSON_TYPE).get(JsonObject.class);
}
private JsonObject createResponse(String who) {
String msg = String.format("%s %s!", greetingProvider.getMessage(), who);
return JSON.createObjectBuilder().add("message", msg).build();
}
}
-
This is the
WebTargetneeded to send a request to the second service at port8081. -
This is the new endpoint that will call the second service.
curl -i http://localhost:8080/greet/outbound # (1)
-
The request went to the service on
8080, which then invoked the service at8081to get the greeting.
{
"message": "Hello From MP-2 World!" // (1)
}
-
Notice the greeting came from the second service.
Refresh the Jaeger UI trace listing page and notice that there is a trace across two services.
In the image above, you can see that the trace includes spans from two services. You will notice there is a gap before the sixth span, which is a get operation. This is a one-time client initialization delay. Run the /outbound curl command again and look at the new trace to
see that the delay no longer exists.
You can now stop your second service, it is no longer used in this guide.
Integration with Kubernetes
The following example demonstrates how to use Jaeger from a Helidon application running in Kubernetes.
application.yaml:tracing:
host: "jaeger"
docker build -t helidon-tracing-mp .
Deploy Jaeger into Kubernetes
jaeger.yaml, with the following contents:apiVersion: v1
kind: Service
metadata:
name: jaeger
spec:
ports:
- port: 16686
protocol: TCP
selector:
app: jaeger
---
kind: Pod
apiVersion: v1
metadata:
name: jaeger
labels:
app: jaeger
spec:
containers:
- name: jaeger
image: jaegertracing/all-in-one
imagePullPolicy: IfNotPresent
ports:
- containerPort: 16686
kubectl apply -f ./jaeger.yaml
kubectl expose pod jaeger --name=jaeger-external --port=16687 --target-port=16686 --type=LoadBalancer # (1)
-
Create a service so that you can access the Jaeger UI.
Navigate to http://localhost:16687/search to validate that you can access Jaeger running in Kubernetes. It may take a few seconds before it is ready.
Deploy Your Helidon Application into Kubernetes
tracing.yaml, with the following contents:kind: Service
apiVersion: v1
metadata:
name: helidon-tracing # (1)
labels:
app: helidon-tracing
spec:
type: NodePort
selector:
app: helidon-tracing
ports:
- port: 8080
targetPort: 8080
name: http
---
kind: Deployment
apiVersion: apps/v1
metadata:
name: helidon-tracing
spec:
replicas: 1 # (2)
selector:
matchLabels:
app: helidon-tracing
template:
metadata:
labels:
app: helidon-tracing
version: v1
spec:
containers:
- name: helidon-tracing
image: helidon-tracing-mp
imagePullPolicy: IfNotPresent
ports:
- containerPort: 8080
-
A service of type
NodePortthat serves the default routes on port8080. -
A deployment with one replica of a pod.
kubectl apply -f ./tracing.yaml
Access Your Application and the Jaeger Trace
kubectl get service/helidon-tracing
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
helidon-tracing NodePort 10.99.159.2 <none> 8080:31143/TCP 8s # (1)
-
A service of type
NodePortthat serves the default routes on port31143.
31143, your port will likely be different:curl http://localhost:31143/greet
{
"message": "Hello World!"
}
Access the Jaeger UI at http://localhost:16687/search and click on the refresh icon to see the trace that was just created.
Cleanup
You can now delete the Kubernetes resources that were just created during this example.
kubectl delete -f ./jaeger.yaml
kubectl delete -f ./tracing.yaml
kubectl delete service jaeger-external
docker rm -f jaeger
Creating custom spans
Helidon MP fully supports MicroProfile OpenTracing.
You can add custom spans using @Traced annotation on methods of CDI beans.
Note for invoking methods on same class:
If you invoke a method on the same class, @Traced annotation would be ignored, as it is not
invoked through a CDI proxy and as such cannot be intercepted.
To make sure @Traced is honored, use it on JAX-RS resource methods and on CDI bean methods used from other beans.
Trace propagation across services
Automated trace propagation is supported currently only with Jersey client.
Tracing propagation works automatically as long as you run within the scope of Helidon MP and use Helidon components to invoke external services.
Manual handling of traces in Jersey Client
There is an option to provide SpanContext programmatically (such as when writing a command line
application that starts the span manually).
You can either configure the span context as the active span, or explicitly define it as client property.
Response response = client.target(serviceEndpoint)
.request()
// tracer should be provided unless available as GlobalTracer
.property(TRACER_PROPERTY_NAME, tracer)
.property(CURRENT_SPAN_CONTEXT_PROPERTY_NAME, spanContext)
.get();
Additional Information
Jaeger Tracing
<dependency>
<groupId>io.helidon.tracing</groupId>
<artifactId>helidon-tracing-providers-jaeger</artifactId>
</dependency>
Configuring Jaeger
Jaeger tracer configuration.
This is a standalone configuration type, prefix from configuration root: tracing
Configuration options
| key | type | default value | description |
|---|---|---|---|
|
|
Certificate of client in PEM format. |
|
|
Duration |
|
Timeout of exporter requests. |
|
int |
|
Maximum Export Batch Size of exporter requests. |
|
int |
|
Maximum Queue Size of exporter requests. |
|
|
Private key in PEM format. |
|
|
PropagationFormat[] (B3, B3_SINGLE, JAEGER, W3C) |
|
Add propagation format to use. Allowed values:
|
|
Number |
|
The sampler parameter (number). |
|
SamplerType (CONSTANT, RATIO) |
|
Sampler type. See Sampler types. Allowed values:
|
|
Duration |
|
Schedule Delay of exporter requests. |
|
SpanProcessorType (SIMPLE, BATCH) |
|
Span Processor type used. Allowed values:
|
|
|
Trusted certificates in PEM format. |
The following is an example of a Jaeger configuration, specified in the YAML format.
tracing:
service: "helidon-full-http"
protocol: "https"
host: "jaeger"
port: 14240
Jaeger Tracing Metrics
As the Jaeger Tracing section describes, you can use Jaeger tracing in your Helidon application.
Zipkin Tracing
<dependency>
<groupId>io.helidon.tracing.providers</groupId>
<artifactId>helidon-tracing-providers-zipkin</artifactId>
</dependency>
Configuring Zipkin
Zipkin tracer configuration
Type: io.opentracing.Tracer
This is a standalone configuration type, prefix from configuration root: tracing
Configuration options
| key | type | default value | description |
|---|---|---|---|
|
Version (V1, V2) |
|
Version of Zipkin API to use. Defaults to Version.V2. Allowed values:
|
The following is an example of a Zipkin configuration, specified in the YAML format.
tracing:
zipkin:
service: "helidon-service"
protocol: "https"
host: "zipkin"
port: 9987
api-version: 1
# this is the default path for API version 2
path: "/api/v2/spans"
tags:
tag1: "tag1-value"
tag2: "tag2-value"
boolean-tags:
tag3: true
tag4: false
int-tags:
tag5: 145
tag6: 741
Example of Zipkin trace:
Responding to Span Lifecycle Events
Applications and libraries can register listeners to be notified at several moments during the lifecycle of every Helidon span:
-
Before a new span starts
-
After a new span has started
-
After a span ends
-
After a span is activated (creating a new scope)
-
After a scope is closed
The next sections explain how you can write and add a listener and what it can do. See the SpanListener Javadoc for more information.
Understanding What Listeners Do
A listener cannot affect the lifecycle of a span or scope it is notified about, but it can add tags and events and update the baggage associated with a span. Often a listener does additional work that does not change the span or scope such as logging a message.
When Helidon invokes the listener’s methods it passes proxies for the Span.Builder, Span, and Scope arguments. These proxies limit the access the listener has to the span builder, span, or scope, as summarized in the following table. If a listener method tries to invoke a forbidden operation, the proxy throws a SpanListener.ForbiddenOperationException and Helidon then logs a WARNING message describing the invalid operation invocation.
| Tracing type | Changes allowed |
|---|---|
Add tags |
|
Retrieve and update baggage, add events, add tags |
|
none |
The following tables list specifically what operations the proxies permit.
| Method | Purpose | OK? |
|---|---|---|
|
Starts the span. |
- |
|
Ends the span. |
- |
|
Starts the span. |
- |
|
Sets the "kind" of span (server, client, internal, etc.) |
- |
|
Sets the parent of the span to be created from the builder. |
- |
|
Starts the span. |
- |
|
Starts the span. |
- |
|
Add a tag to the builder before the span is built. |
✓ |
|
Cast the builder to the specified implementation type. † |
✓ |
† Helidon returns the unwrapped object, not a proxy for it.
| Method | Purpose | OK? |
|---|---|---|
|
Makes the span "current", returning a |
- |
|
Associate a string (and optionally other info) with a span. |
✓ |
|
Returns the |
✓ |
|
Returns the |
✓ |
|
Sets the status of the span. |
- |
any |
Add a tag to the span. |
✓ |
|
Cast the span to the specified implementation type. † |
✓ |
† Helidon returns the unwrapped object, not a proxy to it.
| Method | Purpose | OK? |
|---|---|---|
|
Close the scope. |
- |
|
Reports whether the scope is closed. |
✓ |
| Method | Purpose | OK? |
|---|---|---|
|
Sets this context as the parent of a new span builder. |
✓ |
|
Returns |
✓ |
|
Returns the span ID. |
✓ |
|
Returns the trace ID. |
✓ |
Adding a Listener
Explicitly Registering a Listener on a Tracer
Create a SpanListener instance and invoke the Tracer#register(SpanListener) method to make the listener known to that tracer.
Automatically Registering a Listener on all Tracer Instances
Helidon also uses Java service loading to locate listeners and register them automatically on all Tracer objects.
Follow these steps to add a listener service provider.
-
Implement the
SpanListenerinterface. -
Declare your implementation as a service provider:
-
Create the file
META-INF/services/io.helidon.tracing.SpanListenercontaining a line with the fully-qualified name of your class which implementsSpanListener. -
If your service has a
module-info.javafile add the following line to it:provides io.helidon.tracing.SpanListener with <your-implementation-class>;
-
The SpanListener interface declares default no-op implementations for all the methods, so your listener can implement only the methods it needs to.
Helidon invokes each listener’s methods in the following order:
| Method | When invoked |
|---|---|
|
Just before a span is started from its builder. |
|
Just after a span has started. |
|
After a span has been activated, creating a new scope. A given span might never be activated; it depends on the code. |
|
After a scope has been closed. |
|
After a span has ended successfully. |
|
After a span has ended unsuccessfully. |