Chapter 10. Enabling and configuring Data Grid OpenTelemetry tracing
Data Grid generates tracing spans compatible with the OpenTelemetry standard, allowing you to export, visualize, and analyze tracing data related to the most important cache operations.
10.1. Enabling Data Grid tracing
Configure OpenTelemetry tracing, to enable monitoring and tracing of cache operations.
Procedure
Pass the system properties to Data Grid Server at startup.
Use
-D<property-name>=<property-value>arguments like in the following example:bin/server.sh -Dinfinispan.tracing.enabled=true -Dotel.traces.exporter=otlp -Dotel.service.name=my-infinispan-server -Dotel.exporter.otlp.endpoint=http://otlp-collector-host:4318
Next steps
To apply any configuration changes, stop the server and repeat the procedure.
Tracing configuration
Data Grid applies the tracing configuration globally to all caches.
tracing.properties
infinispan.tracing.enabled = true 1 otel.traces.exporter = otlp 2 otel.service.name = <my-infinispan-server> 3 otel.exporter.otlp.endpoint = http://otlp-collector-host:4318 4
- 1
- Enables tracing for all cache operations.
- 2
- Sets the exporter format. The OTLP (OpenTelemetry protocol) exporter is the recommended format to export tracing data.
- 3
- Specifies the service name associated with the generated tracing spans. The default name is
Infinispan Server. - 4
- Specifies the endpoint URL of the OpenTelemetry collector where the tracing data is sent.
4318is typically thehttp/protobufOTLP standard port.
Additional resources
Tracing data format
The Data Grid Server, by default, exports tracing data using the OTLP http/protobuf protocol.
tracing.properties
otel.exporter.otlp.protocol = http/protobuf
To use a different protocol, you must copy JAR files or dependencies to the $ISPN_HOME/server/lib directory of your Data Grid Server installation.
