OpenTelemetry Tracing

The OpenTelemetry tracing related properties can be configured in any of the following files:

  • bwengine.tra

  • designer.tra

  • <application_name>.tra

Configuration file option where changes can be applied

For the already deployed applications:

  1. Add the necessary properties in the application TRA file located at <TIBCO_HOME>\tra\domain\<Domain_name>\application\<application_name>\<application_name>.tra.

  2. After making the changes, restart the application’s service instances.

    No Redeployment is required.

To apply the configuration across all the applications deployed and created from a specific TIBCO_HOME, add the properties to bwengine.tra. This configuration is applied for newly created applications and its configuration file.

For the default auto-configuration mode

Following are the 3 properties needs to be added in the .tra file

  1. To enable OpenTelemetry, set the following property:

    java.property.bw.engine.opentelemetry.enable=true

  2. There are two types of protocol supported for the OpenTelemetry tracing which are GRPC and HTTP.

    Use the HTTP protocol to view ActiveMatrix BusinessWorks 5.x activities traces through the TIBCO Control Plane web UI.

    Use one of the following properties to set the required protocol:

    java.property.otel.exporter.otlp.traces.protocol=grpc or java.property.otel.exporter.otlp.traces.protocol=http/protobuf

  3. To enable tracing for the ActiveMatrix BusinessWorks 5.x applications from a remote machine, use the following property:

    java.property.otel.exporter.otlp.traces.endpoint=<< Endpoint URL >>

    On a bare metal on-premises setup with Jaeger UI through ActiveMatrix BusinessWorks 5.x engine use the properties with the sample value.

    For HTTP: java.property.otel.exporter.otlp.traces.endpoint=http://localhost:4318/v1/traces

    For GRPC: java.property.otel.exporter.otlp.traces.endpoint=http://localhost:4317

Note: You can configure the following property to expose the traces and to view these traces under the TIBCO Control Plane UI:

java.property.otel.exporter.otlp.traces.endpoint=http://<hostname>/tibco/agent/o11y/dataplane-ID/traces

For the non- auto-configuration mode

If you want to disable the default auto-configuration mode, add the following property in the .tra file.

java.property.bw.engine.opentelemetry.disableAutoConfiguration=true

After disabling the auto-configured mode, with the manual mode add the following properties in the .tra file:

  • java.property.bw.engine.opentelemetry.enable=true

  • java.property.bw.engine.opentelemetry.span.exporter=OTLP-GRPC

  • java.property.bw.engine.opentelemetry.span.exporter.endpoint=http://localhost:4317

OR

  • java.property.bw.engine.opentelemetry.span.exporter=OTLP-HTTP

  • java.property.bw.engine.opentelemetry.span.exporter.endpoint=http://localhost:4318/v1/traces

Note: You can configure the following property to expose the traces and to view these traces under the TIBCO Control Plane UI:

Java.property.bw.engine.opentelemetry.span.exporter.endpoint=http://<BareMetal_DP_MachineName>/tibco/agent/o11y/dataplane-ID/traces