org.apache.ignite.spi.metric.otlp

Class OpenTelemetryMetricExporterSpi

java.lang.Object

org.apache.ignite.spi.IgniteSpiAdapter

org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

org.apache.ignite.spi.metric.otlp.OpenTelemetryMetricExporterSpi

All Implemented Interfaces:

IgniteSpi, MetricExporterSpi

public class OpenTelemetryMetricExporterSpi
extends org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

SPI implementation that periodically exports Ignite metrics to an OpenTelemetry Protocol (OTLP) compatible backend (e.g. OpenTelemetry Collector, Grafana OTLP endpoint, Jaeger, etc.).

Overview

This exporter runs a background task that fires every PushMetricsExporterAdapter.getPeriod() milliseconds and pushes the current snapshot of all metric registries to the configured OTLP endpoint. Each Ignite node exports its own metrics and identifies itself via the OpenTelemetry service resource attributes:

• service.namespace — set via setServiceNamespace(String)
• service.name — set via setServiceName(String); defaults to the cluster tag (see IgniteCluster.tag()) if not specified
• service.instance.id — automatically set to the node's consistent ID

Transport

Two wire protocols are supported (see Protocol):

• Protocol.GRPC (default) — OTLP over gRPC
• Protocol.HTTP — OTLP over HTTP/protobuf

The target endpoint is configured via setEndpoint(String) and must follow the pattern http(s)://host:port. The default endpoint is "http://localhost:4317".

Compression

Payload compression is controlled by setCompression(Compression). Supported types are Compression.NONE (default) and Compression.GZIP.

SSL/TLS

Secure connections are enabled by setting setSslEnabled(boolean) to true. By default, the SPI will reuse the Factory<SSLContext> already configured in IgniteConfiguration.setSslContextFactory(Factory) (controlled by setUseIgniteSslContextFactory(boolean)).

A dedicated SSL context factory can be provided via setSslContextFactory(Factory). An instance of SslContextFactory is the recommended implementation because it supplies both the SSLContext and the TrustManager from a single object. When a different Factory<SSLContext> is used, a separate trust-manager factory must be configured.

Custom headers

Arbitrary HTTP/gRPC metadata headers (e.g. authentication tokens) can be injected into every export request via setConnectionHeaders(Map).

Configuration example

 OpenTelemetryMetricExporterSpi spi = new OpenTelemetryMetricExporterSpi();

 spi.setEndpoint("http://otel-collector:4317");
 spi.setProtocol(Protocol.GRPC);
 spi.setCompression(Compression.GZIP);
 spi.setPeriod(30_000L);                   // export every 30 seconds
 spi.setServiceNamespace("my-org");
 spi.setServiceName("ignite-cluster");

 IgniteConfiguration cfg = new IgniteConfiguration();
 cfg.setMetricExporterSpi(spi);
 

See Also:

Protocol, Compression, PushMetricsExporterAdapter, OTLP specification, Service semantic conventions

Field Summary

Fields

Modifier and Type	Field and Description
static Compression	DEFAULT_COMPRESSION Default compression type.
static String	DEFAULT_ENDPOINT Default endpoint URL.
static Protocol	DEFAULT_PROTOCOL Default protocol type that is used to export metrics.
static boolean	DFLT_USE_IGNITE_SSL_CTX_FACTORY By default OTLP exporter uses SSL context factory from Ignite configuration.

Fields inherited from class org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

DFLT_EXPORT_PERIOD, filter, mreg

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

ignite, igniteInstanceName, log

Constructor Summary

Constructors

Constructor and Description
OpenTelemetryMetricExporterSpi()

Method Summary

Modifier and Type	Method and Description
void	export() Callback to do the export of metrics info.
Compression	getCompression() Returns the configured compression type.
Map<String,String>	getConnectionHeaders() Returns the configured connection headers.
String	getEndpoint() Returns the configured endpoint.
Protocol	getProtocol() Returns the configured protocol.
String	getServiceName() Returns a logical name of the service.
String	getServiceNamespace() Returns service namespace.
javax.cache.configuration.Factory<SSLContext>	getSslContextFactory() Returns the configured instance of Factory that will be used to create an instance of SSLContext.
javax.cache.configuration.Factory<TrustManager>	getTrustManagerFactory() Returns the configured factory to create an instance of TrustManager.
boolean	isSslEnabled() Returns true if Secure Socket Layer is enabled and false otherwise.
boolean	isUseIgniteSslContextFactory() Gets whether to use Ignite SSL context factory configured through IgniteConfiguration.getSslContextFactory() if getSslContextFactory() is not set.
protected void	onContextInitialized0(IgniteSpiContext spiCtx) Method to be called in the end of onContextInitialized method.
void	setCompression(Compression compression) Sets compression type.
void	setCompression(String compression) Sets compression type.
void	setConnectionHeaders(Map<String,String> headers) Sets connection headers.
void	setEndpoint(String endpoint) Sets the OTLP endpoint to connect to.
void	setProtocol(Protocol protocol) Sets the OTLP protocol to export metrics.
void	setProtocol(String protocol) Sets the OTLP protocol to export metrics.
void	setServiceName(String srvcName) Sets a logical name of the service.
void	setServiceNamespace(String srvcNamespace) Sets a logical name of a system or application under a common namespace.
void	setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslFactory) Sets the given instance of Factory that will be used to create an instance of SSLContext for Secure Socket Layer.
void	setSslEnabled(boolean sslEnabled) Sets whether Secure Socket Layer should be enabled.
void	setTrustManagerFactory(javax.cache.configuration.Factory<TrustManager> trustFactory) Sets the given instance of Factory that will be used to create an instance of TrustManager.
void	setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory) Sets whether to use Ignite SSL context factory.
void	spiStop() This method is called to stop SPI.

Methods inherited from class org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

getPeriod, setExportFilter, setMetricRegistry, setPeriod, spiStart

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

addTimeoutObject, assertParameter, checkConfigurationConsistency0, clientFailureDetectionTimeout, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getConsistentAttributeNames, getExceptionRegistry, getLocalNode, getName, getNodeAttributes, getSpiContext, ignite, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onBeforeStart, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, 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

getName, getNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized

Field Detail

DEFAULT_PROTOCOL

public static final Protocol DEFAULT_PROTOCOL

Default protocol type that is used to export metrics.

DEFAULT_COMPRESSION

public static final Compression DEFAULT_COMPRESSION

Default compression type.

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

Default endpoint URL.

See Also:

Constant Field Values

DFLT_USE_IGNITE_SSL_CTX_FACTORY

public static final boolean DFLT_USE_IGNITE_SSL_CTX_FACTORY

By default OTLP exporter uses SSL context factory from Ignite configuration.

See Also:

IgniteConfiguration.setSslContextFactory(Factory), Constant Field Values

Constructor Detail

OpenTelemetryMetricExporterSpi

public OpenTelemetryMetricExporterSpi()

Method Detail

export

public void export()

Callback to do the export of metrics info. Method will be called into some Ignite managed thread each PushMetricsExporterAdapter.getPeriod() millisecond.

Specified by:

export in class org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

spiStop

public void spiStop()
             throws IgniteSpiException

This 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:

spiStop in interface IgniteSpi

Overrides:

spiStop in class org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

Throws:

IgniteSpiException - Thrown in case of any error during SPI stop.

onContextInitialized0

protected void onContextInitialized0(IgniteSpiContext spiCtx)
                              throws IgniteSpiException

Method to be called in the end of onContextInitialized method.

Overrides:

onContextInitialized0 in class org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter

Parameters:

spiCtx - SPI context.

Throws:

IgniteSpiException - In case of errors.

setServiceNamespace

public void setServiceNamespace(String srvcNamespace)

Sets a logical name of a system or application under a common namespace. This is a namespace for the service name.

Parameters:

srvcNamespace - Service namespace.

See Also:

Service semantic conventions

getServiceNamespace

public String getServiceNamespace()

Returns service namespace.

Returns:

Service namespace.

See Also:

setServiceNamespace(String)

setServiceName

public void setServiceName(String srvcName)

Sets a logical name of the service.

If srvcName is null or empty then the cluster tag is used. The default value is null.

Parameters:

srvcName - Service name.

See Also:

Service semantic conventions, IgniteCluster.tag()

getServiceName

public String getServiceName()

Returns a logical name of the service.

Returns:

Logical name of the service.

See Also:

setServiceName(String)

setEndpoint

public void setEndpoint(String endpoint)

Sets the OTLP endpoint to connect to. The endpoint must start with either http:// or https:// and follow the pattern http(s)://host:port. The default value is DEFAULT_ENDPOINT.

Parameters:

endpoint - Endpoint to connect to.

getEndpoint

public String getEndpoint()

Returns the configured endpoint.

Returns:

Configured endpoint.

See Also:

setEndpoint(String)

setProtocol

public void setProtocol(String protocol)

Sets the OTLP protocol to export metrics. The default value is DEFAULT_PROTOCOL.

Parameters:

protocol - Protocol to export metrics.

Throws:

IllegalArgumentException - when the given protocol is not supported.

See Also:

Protocol

setProtocol

public void setProtocol(Protocol protocol)

Sets the OTLP protocol to export metrics.

Parameters:

protocol - Protocol to export metrics.

See Also:

Protocol, setProtocol(Protocol)

getProtocol

public Protocol getProtocol()

Returns the configured protocol.

Returns:

Configured protocol.

See Also:

setProtocol(Protocol), Protocol

setCompression

public void setCompression(String compression)

Sets compression type. The default value is DEFAULT_COMPRESSION.

Parameters:

compression - Compression type.

Throws:

IllegalArgumentException - when the given compression is not supported.

See Also:

Compression

setCompression

public void setCompression(Compression compression)

Sets compression type. The default value is DEFAULT_COMPRESSION.

Parameters:

compression - Compression type.

See Also:

Compression

getCompression

public Compression getCompression()

Returns the configured compression type.

Returns:

Configured compression type.

See Also:

setCompression(Compression), Compression

setConnectionHeaders

public void setConnectionHeaders(Map<String,String> headers)

Sets connection headers.

Parameters:

headers - Connection headers.

getConnectionHeaders

public Map<String,String> getConnectionHeaders()

Returns the configured connection headers.

Returns:

Configured connection headers.

See Also:

setConnectionHeaders(Map)

setSslEnabled

public void setSslEnabled(boolean sslEnabled)

Sets whether Secure Socket Layer should be enabled.

Note that if this flag is set to true, then a valid instance of Factory<SSLContext> should be provided. The default value is false.

Parameters:

sslEnabled - true if SSL should be enabled and false otherwise.

See Also:

setSslContextFactory(Factory), setUseIgniteSslContextFactory(boolean), IgniteConfiguration.setSslContextFactory(Factory)

isSslEnabled

public boolean isSslEnabled()

Returns true if Secure Socket Layer is enabled and false otherwise.

Returns:

Returns true if Secure Socket Layer is enabled and false otherwise.

See Also:

setSslEnabled(boolean)

setUseIgniteSslContextFactory

public void setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory)

Sets whether to use Ignite SSL context factory.

Parameters:

useIgniteSslCtxFactory - Whether to use Ignite SSL context factory.

See Also:

IgniteConfiguration.setSslContextFactory(Factory)

isUseIgniteSslContextFactory

public boolean isUseIgniteSslContextFactory()

Gets whether to use Ignite SSL context factory configured through IgniteConfiguration.getSslContextFactory() if getSslContextFactory() is not set.

Returns:

true if Ignite SSL context factory should be used.

See Also:

setUseIgniteSslContextFactory(boolean)

setSslContextFactory

public void setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslFactory)

Sets the given instance of Factory that will be used to create an instance of SSLContext for Secure Socket Layer. This factory will only be used if setSslEnabled(boolean) is set to true.

An instance of SslContextFactory class can be used in order to provide SSLContext and TrustManager at the same time.

 
   // Create and setup the factory.
   SslContextFactory factory = new SslContextFactory();

   factory.setKeyStoreFilePath(keyStorePath);
   factory.setKeyStorePassword(keyPass);
   factory.setTrustStoreFilePath(trustStorePath);
   factory.setTrustStorePassword(trustPass);
   ...

   OpenTelemetryMetricExporterSpi spi = new OpenTelemetryMetricExporterSpi();
   // This call overrides {@link #setTrustManagerFactory(Factory)}
   // TrustManager is obtained from the {@code factory}.
   spi.setSslContextFactory(factory);
 
 

Parameters:

sslFactory - Instance of Factory.

See Also:

SslContextFactory

getSslContextFactory

public javax.cache.configuration.Factory<SSLContext> getSslContextFactory()

Returns the configured instance of Factory that will be used to create an instance of SSLContext.

Returns:

Factory to create SSLContext.

See Also:

setSslContextFactory(Factory)

setTrustManagerFactory

public void setTrustManagerFactory(javax.cache.configuration.Factory<TrustManager> trustFactory)

Sets the given instance of Factory that will be used to create an instance of TrustManager. This factory will only be used if setSslEnabled(boolean) is set to true.

Parameters:

trustFactory - Instance of Factory.

See Also:

SslContextFactory

getTrustManagerFactory

public javax.cache.configuration.Factory<TrustManager> getTrustManagerFactory()

Returns the configured factory to create an instance of TrustManager.

Returns:

Factory to create TrustManager.

See Also:

setTrustManagerFactory(Factory)