Class GlobalTracingConfiguration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<GlobalTracingConfiguration>

org.infinispan.configuration.global.GlobalTracingConfiguration

All Implemented Interfaces:

Matchable<GlobalTracingConfiguration>, Updatable<GlobalTracingConfiguration>

public class GlobalTracingConfiguration
extends ConfigurationElement<GlobalTracingConfiguration>

Configuration for tracing. See GlobalTracingConfigurationBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<String>	COLLECTOR_ENDPOINT
static final AttributeDefinition<Boolean>	ENABLED
static final AttributeDefinition<TracingExporterProtocol>	EXPORTER_PROTOCOL
static final AttributeDefinition<Boolean>	SECURITY
static final AttributeDefinition<String>	SERVICE_NAME

Fields inherited from class ConfigurationElement

attributes, CHILDLESS, children, element, repeated

Method Summary

Modifier and Type	Method	Description
String	collectorEndpoint()	Enables tracing collection defining the collector that will receive the spans created by Infinispan.
boolean	enabled()	Tracing is enabled by default if "collector-endpoint" is defined.
TracingExporterProtocol	exporterProtocol()	By default, the tracing spans will be exported applying the OTLP (OpenTelemetry Protocol).
boolean	security()
String	serviceName()	The service name used by tracing to identify the server process.

Methods inherited from class ConfigurationElement

attributes, child, children, children, collectMutableAttributes, elementName, equals, extractAttributes, findAttribute, hashCode, isModified, list, matches, matches, matches, toString, update, update, update, validateUpdate, validateUpdate, validateUpdate, write

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COLLECTOR_ENDPOINT

public static final AttributeDefinition<String> COLLECTOR_ENDPOINT

ENABLED

public static final AttributeDefinition<Boolean> ENABLED

EXPORTER_PROTOCOL

public static final AttributeDefinition<TracingExporterProtocol> EXPORTER_PROTOCOL

SERVICE_NAME

public static final AttributeDefinition<String> SERVICE_NAME

SECURITY

public static final AttributeDefinition<Boolean> SECURITY

Method Details

collectorEndpoint

public String collectorEndpoint()

Enables tracing collection defining the collector that will receive the spans created by Infinispan. The value is supposed to be a valid parsable URL containing the protocol, the address and the port of the remote receiving process. E.g., http://otlp-collector-host:4317.

Returns:

The collector endpoint URL.

enabled

public boolean enabled()

Tracing is enabled by default if "collector-endpoint" is defined.

Returns:

Whether the tracing is enabled

exporterProtocol

public TracingExporterProtocol exporterProtocol()

By default, the tracing spans will be exported applying the OTLP (OpenTelemetry Protocol). This protocol can be changed, but an extra exporter dependency should be added in case.

Returns:

The protocol used to export the spans data.

serviceName

public String serviceName()

The service name used by tracing to identify the server process.

Returns:

The service name.

security

public boolean security()

Returns:

true whether the tracing of security events is enabled