io.opencensus.exporter.trace.zipkin

Class ZipkinTraceExporter

java.lang.Object

io.opencensus.exporter.trace.zipkin.ZipkinTraceExporter

public final class ZipkinTraceExporter
extends Object

An OpenCensus span exporter implementation which exports data to Zipkin.

Example of usage:

 public static void main(String[] args) {
   ZipkinTraceExporter.createAndRegister(
     ZipkinExporterConfiguration.builder()
       .setV2Url("http://127.0.0.1:9411/api/v2/spans")
       .setServiceName("myservicename")
       .build());
   ... // Do work.
 }
 

Since:

0.12

Method Summary

Modifier and Type	Method and Description
static void	createAndRegister(zipkin2.codec.SpanBytesEncoder encoder, zipkin2.reporter.Sender sender, String serviceName) Deprecated. in favor of createAndRegister(ZipkinExporterConfiguration).
static void	createAndRegister(String v2Url, String serviceName) Deprecated. in favor of createAndRegister(ZipkinExporterConfiguration).
static void	createAndRegister(ZipkinExporterConfiguration configuration) Creates and registers the Zipkin Trace exporter to the OpenCensus library.
static void	unregister() Unregisters the Zipkin Trace exporter from the OpenCensus library.

Methods inherited from class java.lang.Object

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

Method Detail

createAndRegister

public static void createAndRegister(ZipkinExporterConfiguration configuration)

Creates and registers the Zipkin Trace exporter to the OpenCensus library. Only one Zipkin exporter can be registered at any point.

Parameters:

configuration - configuration for this exporter.

Throws:

IllegalStateException - if a Zipkin exporter is already registered.

Since:

0.22

createAndRegister

@Deprecated
public static void createAndRegister(String v2Url,
                                                 String serviceName)

Deprecated. in favor of createAndRegister(ZipkinExporterConfiguration).

Creates and registers the Zipkin Trace exporter to the OpenCensus library. Only one Zipkin exporter can be registered at any point.

Parameters:

v2Url - Ex http://127.0.0.1:9411/api/v2/spans

serviceName - the local service name of the process.

Throws:

IllegalStateException - if a Zipkin exporter is already registered.

Since:

0.12

createAndRegister

@Deprecated
public static void createAndRegister(zipkin2.codec.SpanBytesEncoder encoder,
                                                 zipkin2.reporter.Sender sender,
                                                 String serviceName)

Deprecated. in favor of createAndRegister(ZipkinExporterConfiguration).

Creates and registers the Zipkin Trace exporter to the OpenCensus library. Only one Zipkin exporter can be registered at any point.

Parameters:

encoder - Usually SpanBytesEncoder.JSON_V2

sender - Often, but not necessarily an http sender. This could be Kafka or SQS.

serviceName - the local service name of the process.

Throws:

IllegalStateException - if a Zipkin exporter is already registered.

Since:

0.12

unregister

public static void unregister()

Unregisters the Zipkin Trace exporter from the OpenCensus library.

Throws:

IllegalStateException - if a Zipkin exporter is not registered.

Since:

0.12