smallrye opentracing?color=green

SmallRye OpenTracing (Deprecated)

OpenTracing is no longer under development and was replaced by OpenTelemetry Tracing. In the future, please refer to the OpenTelemetry Quarkus extension: https://quarkus.io/guides/opentelemetry

SmallRye OpenTracing is an implementation of eclipse/microprofile-opentracing meant to be reusable for different vendors.

How to use

The following components have to be added to deployment to pass microprofile-opentracing-tck:

Server side JAX-RS

Server side JAX-RS tracing integration is provided by JAX-RS SmallRyeTracingDynamicFeature and servlet filter SpanFinishingFilter which finishes the span started in JAX-RS filter.

The installation is JAX-RS and server implementation specific. For example in RestEasy DynamicFeature it can be enabled by specifying resteasy.providers in servlet context init parameters. The following code snippet demonstrates possible installation.

public class ServletContextTracingInstaller implements ServletContextListener {

  @Override
  public void contextInitialized(ServletContextEvent servletContextEvent) {
    ServletContext servletContext = servletContextEvent.getServletContext();
    servletContext.setInitParameter("resteasy.providers", SmallRyeTracingDynamicFeature.class.getName());

    Dynamic filterRegistration = servletContext.addFilter("tracingFilter", new SpanFinishingFilter());
    filterRegistration.setAsyncSupported(true);
    filterRegistration.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class), true, "*");
  }
}

Client side JAX-RS

Vendor has to implement ClientTracingRegistrarProvider and specify it in META-INF/services/org.eclipse.microprofile.opentracing.ClientTracingRegistrarProvider.

This project provides SmallRyeClientTracingFeature with tracing integration. The feature has to be registered to ClientBuilder in vendor specific implementation of ClientTracingRegistrarProvider. Client side tracing usually requires more components, for example OpenTracing-aware AsyncExecutor.

MicroProfile Rest Client

The Rest Client instrumentation is provided in SmallRyeRestClientListener which has to be registered in META-INF/services/org.eclipse.microprofile.rest.client.spi.RestClientListener.

CDI

The @Traced aspects of the specification is provided by the OpenTracingInterceptor, from the OpenTracing Contrib Java Interceptors project.

Tracer producer

Vendor has to provide CDI tracer producer. It is not provided by this library as the tracer resolution is not defined by MicroProfile specification.

Develop

mvn clean install

Debug

Debug of the deployment can be enabled in arquillian.xml configuration file.

Run the following to debug tests on port 8788.

mvn -Dmaven.surefire.debug="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8788 -Xnoagent -Djava.compiler=NONE" test

Project Name	Stars	Repos Using This	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Jaeger	17,335	15	139	16 hours ago	290	September 16, 2022	328	apache-2.0	Go
CNCF Jaeger, a Distributed Tracing Platform
Gf	9,005	7	232	3 days ago	509	August 22, 2022	68	mit	Go
GoFrame is a modular, powerful, high-performance and enterprise-class application development framework of Golang.
Opentracing Go	3,445	2,041	3,564	4 days ago	17	February 28, 2022	27	apache-2.0	Go
OpenTracing API for Go. 🛑 This library is DEPRECATED! https://github.com/opentracing/specification/issues/163
Stabilityguide	2,776			4 days ago				other
【稳定大于一切】打造国内稳定性领域知识库，让无法解决的问题少一点点，让世界的确定性多一点点。
Stagemonitor	1,695	11	8	a month ago	47	April 06, 2020	85	apache-2.0	Java
an open source solution to application performance monitoring for java server applications
Opentracing Tutorial	1,532		3	3 months ago	10	April 21, 2021	28	apache-2.0	Java
A collection of tutorials for the OpenTracing API
Opentracing Javascript	1,068	7,360	271	a year ago	40	January 06, 2022	34	apache-2.0	TypeScript
OpenTracing API for Javascript (both Node and browser)
Jaeger Ui	896		2	2 days ago	7	March 19, 2019	187	apache-2.0	JavaScript
Web UI for Jaeger
Molten	694			3 years ago			49	apache-2.0	C
php probe for zipkin and opentracing
Mortar	645		7	23 days ago	37	May 30, 2022		mit	Go
Mortar is a GO framework/library for building gRPC (and REST) web services.

Smallrye Opentracing