Class OpenCensusTracingSpi
- java.lang.Object
- 
- org.apache.ignite.spi.IgniteSpiAdapter
- 
- org.apache.ignite.spi.tracing.opencensus.OpenCensusTracingSpi
 
 
- 
- All Implemented Interfaces:
- IgniteSpi,- TracingSpi<OpenCensusSpanAdapter>
 
 @IgniteSpiMultipleInstancesSupport(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.IgniteSpiAdapterignite, igniteInstanceName, log
 
- 
 - 
Constructor SummaryConstructors Constructor 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 SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenCensusSpanAdaptercreate(@NotNull String name, @org.jetbrains.annotations.Nullable byte[] parentSerializedSpan)Creates Span given name and explicit parent.@NotNull OpenCensusSpanAdaptercreate(@NotNull String name, @Nullable OpenCensusSpanAdapter parentSpan)Creates Span given name and explicit parent.StringgetName()Gets SPI name.byte[]serialize(@NotNull OpenCensusSpanAdapter span)Serializes span to byte array to send context over network.voidspiStart(String igniteInstanceName)This method is called to start SPI.voidspiStop()This method is called to stop SPI.bytetype()- 
Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapteraddTimeoutObject, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.apache.ignite.spi.IgniteSpigetNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized
 
- 
 
- 
- 
- 
Constructor Detail- 
OpenCensusTracingSpipublic 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()
 
 - 
OpenCensusTracingSpipublic 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- 
createpublic OpenCensusSpanAdapter create(@NotNull @NotNull String name, @Nullable @org.jetbrains.annotations.Nullable byte[] parentSerializedSpan) throws Exception Creates Span given name and explicit parent.- Specified by:
- createin interface- TracingSpi<OpenCensusSpanAdapter>
- Parameters:
- name- Name of span to create.
- parentSerializedSpan- Parent span as serialized bytes.
- Returns:
- Created span.
- Throws:
- Exception- If failed to deserialize patent span.
 
 - 
create@NotNull public @NotNull OpenCensusSpanAdapter create(@NotNull @NotNull String name, @Nullable @Nullable OpenCensusSpanAdapter parentSpan) Creates Span given name and explicit parent.- Specified by:
- createin interface- TracingSpi<OpenCensusSpanAdapter>
- Parameters:
- name- Name of span to create.
- parentSpan- Parent span.
- Returns:
- Span instance.
 
 - 
serializepublic byte[] serialize(@NotNull @NotNull OpenCensusSpanAdapter span)Serializes span to byte array to send context over network.- Specified by:
- serializein interface- TracingSpi<OpenCensusSpanAdapter>
- Parameters:
- span- Span.
- Returns:
- Span instance.
 
 - 
getNamepublic String getName() Gets SPI name.- Specified by:
- getNamein interface- IgniteSpi
- Overrides:
- getNamein class- IgniteSpiAdapter
- Returns:
- SPI name.
 
 - 
spiStartpublic void spiStart(String igniteInstanceName) throws IgniteSpiException This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.- Specified by:
- spiStartin interface- IgniteSpi
- Parameters:
- igniteInstanceName- Name of Ignite instance this SPI is being started for (- nullfor default Ignite instance).
- Throws:
- IgniteSpiException- Throws in case of any error during SPI start.
 
 - 
spiStoppublic void spiStop() throws IgniteSpiExceptionThis method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called. - Specified by:
- spiStopin interface- IgniteSpi
- Throws:
- IgniteSpiException- Thrown in case of any error during SPI stop.
 
 - 
typepublic byte type() - Specified by:
- typein interface- TracingSpi<OpenCensusSpanAdapter>
- Returns:
- type of tracing spi as byte.
 
 
- 
 
-