org.apache.ignite.spi.tracing.opencensus

Class OpenCensusTracingSpi

java.lang.Object

org.apache.ignite.spi.IgniteSpiAdapter

org.apache.ignite.spi.tracing.opencensus.OpenCensusTracingSpi

All Implemented Interfaces:

IgniteSpi, TracingSpi<OpenCensusSpanAdapter>

@IgniteSpiMultipleInstancesSupport(value=true)
 @IgniteSpiConsistencyChecked(optional=true)
public class OpenCensusTracingSpi
extends IgniteSpiAdapter
implements TracingSpi<OpenCensusSpanAdapter>

Tracing SPI implementation based on OpenCensus library. If you have OpenCensus Tracing in your environment use the following code for configuration: IgniteConfiguration cfg; cfg.setTracingSpi(new OpenCensusTracingSpi()); If you don't have OpenCensus Tracing: IgniteConfiguration cfg; cfg.setTracingSpi(new OpenCensusTracingSpi(new ZipkinExporterHandler(...))); See constructors description for detailed explanation.

Field Summary

Fields inherited from class org.apache.ignite.spi.IgniteSpiAdapter

ignite, igniteInstanceName, log

Constructor Summary

Constructors

Constructor and Description
OpenCensusTracingSpi() This constructor is used if environment (JVM) already has OpenCensus tracing.
OpenCensusTracingSpi(io.opencensus.trace.export.SpanExporter.Handler... exporters) This constructor is used if environment (JVM) hasn't OpenCensus tracing.

Method Summary

Modifier and Type	Method and Description
OpenCensusSpanAdapter	create(@NotNull String name, @Nullable byte[] parentSerializedSpan)
@NotNull OpenCensusSpanAdapter	create(@NotNull String name, @Nullable OpenCensusSpanAdapter parentSpan)
String	getName()
byte[]	serialize(@NotNull OpenCensusSpanAdapter span)
void	spiStart(String igniteInstanceName)
void	spiStop()
byte	type()

Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapter

addTimeoutObject, assertParameter, checkConfigurationConsistency0, clientFailureDetectionTimeout, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getConsistentAttributeNames, getExceptionRegistry, getLocalNode, getNodeAttributes, getSpiContext, ignite, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onBeforeStart, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, removeTimeoutObject, setName, started, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.spi.IgniteSpi

getNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized

Constructor Detail

OpenCensusTracingSpi

public OpenCensusTracingSpi()

This constructor is used if environment (JVM) already has OpenCensus tracing. In this case traces from the node will go trough externally registered exporters by an user himself.

See Also:

Tracing.getExportComponent()

OpenCensusTracingSpi

public OpenCensusTracingSpi(io.opencensus.trace.export.SpanExporter.Handler... exporters)

This constructor is used if environment (JVM) hasn't OpenCensus tracing. In this case provided exporters will start and traces from the node will go through it.

Parameters:

exporters - Exporters.

Method Detail

create

public OpenCensusSpanAdapter create(@NotNull
                                    @NotNull String name,
                                    @Nullable
                                    @Nullable byte[] parentSerializedSpan)
                             throws Exception

Specified by:

create in interface TracingSpi<OpenCensusSpanAdapter>

Throws:

Exception

create

@NotNull
public @NotNull OpenCensusSpanAdapter create(@NotNull
                                                      @NotNull String name,
                                                      @Nullable
                                                      @Nullable OpenCensusSpanAdapter parentSpan)

Specified by:

create in interface TracingSpi<OpenCensusSpanAdapter>

serialize

public byte[] serialize(@NotNull
                        @NotNull OpenCensusSpanAdapter span)

Specified by:

serialize in interface TracingSpi<OpenCensusSpanAdapter>

getName

public String getName()

Specified by:

getName in interface IgniteSpi

Overrides:

getName in class IgniteSpiAdapter

spiStart

public void spiStart(String igniteInstanceName)
              throws IgniteSpiException

Specified by:

spiStart in interface IgniteSpi

Throws:

IgniteSpiException

spiStop

public void spiStop()
             throws IgniteSpiException

Specified by:

spiStop in interface IgniteSpi

Throws:

IgniteSpiException

type

public byte type()

Specified by:

type in interface TracingSpi<OpenCensusSpanAdapter>