Products | Versions |
---|---|
TIBCO ActiveMatrix BusinessWorks | 5.15.1 |
Support for the OpenTelemetry has been added to the TIBCO BusinessWorks 5.15.1. You need to apply BusinessWorks 5.15.1 hotfix-02 to use this functionality. Refer article 000054003 for complete details on installing BW 5.15.1 hotfix-02.
A trace represents a complete execution made up of single or multiple spans.
Following are the 3 properties needs to be added in the configuration file:
1. java.property.bw.engine.opentelemetry.enable=true
There are two types of protocol supported for the Open Telemetry tracing which are GRPC and HTTP. Either GRPC or HTTP protocol can be used.
Though It is required to use the HTTP protocol to view the BW5 activities traces through the TIBCO Control Plane web UI.
2. java.property.otel.exporter.otlp.traces.protocol=grpc
OR
java.property.otel.exporter.otlp.traces.protocol=http/protobuf
3. java.property.otel.exporter.otlp.traces.endpoint=<< Endpoint URL >>
Note:
java.property.otel.exporter.otlp.traces.endpoint= can be configured in the following manner to expose-emits the traces and to be viewed these traces under the TIBCO Control Plane UI
java.property.otel.exporter.otlp.traces.endpoint=http:///tibco/agent/o11y/dataplane-ID/traces
=======================================
Above mentioned properties are for default auto-configured mode of OTEL Tracing.
===================================
If user wants to disable the default auto-configured mode then following properties needs to added in the configuration file
java.property.bw.engine.opentelemetry.disableAutoConfiguration=true
Post disabling the auto configured mode, with the manual mode, there will be slight changes in the other required properties which are as following :==
1. java.property.bw.engine.opentelemetry.enable=true
2. 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
Java.property.bw.engine.opentelemetry.span.exporter.endpoint= << Endpoint URL >>
can be configured in the following manner to expose-emits the traces and to be viewed 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
================================================
—-------------------------------------------------------------------
For the already deployed applications:
Add the necessary properties in the application TRA file located at <TIBCO_
HOME>\tra\domain\<Domain_name>\application\<application_name>\appname.tra file
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.