Tracing with OpenTelemetry Java Agent

Tracing with OpenTelemetry Java Agent

OpenL Docker images come with the OpenTelemetry Java agent. By default, OpenTelemetry is disabled. To enable OpenTelemetry, set the OTEL_JAVAAGENT_ENABLED=true environment variable or define the OTEL_EXPORTER_******_ENDPOINT environment property. To run OpenL Tablets Rule Services with enabled OpenTelemetry, use the following command:

docker run --rm -p 8080:8080 \
    -e OTEL_EXPORTER_OTLP_ENDPOINT=http://host.docker.internal:4318 \
    openltablets/ws

This minimal configuration allows logging both OpenL rules execution and default metrics, such as DB queries, HTTP networking, and Kafka messaging. To suppress the undesired agent instrumentation, add OTEL_INSTRUMENTATION_[NAME]_ENABLED=false to the configuration where NAME is the corresponding instrumentation name. See Suppressing specific agent instrumentation. The instrumentation name of the OpenL rules agent is openl-rules.

Note: In large projects, when a significant number (much more than 1,000) of OpenL methods is invoked internally, it can considerably decrease performance. In this case, it is reasonable to disable tracing of OpenL rules execution by defining OTEL_INSTRUMENTATION_OPENL_RULES_ENABLED=false as follows:

docker run --rm -p 8080:8080 \
    -e OTEL_EXPORTER_OTLP_ENDPOINT=http://172.17.0.1:4318 \
    -e OTEL_INSTRUMENTATION_OPENL_RULES_ENABLED=false \
    openltablets/ws