Turning off OpenTelemetry for a message flow

You can turn off the recording of OpenTelemetry data for an individual message flow by using the IBM® App Connect Enterprise administration REST API.

About this task

IBM App Connect Enterprise supports OpenTelemetry trace for integration servers on the Linux® x86-64, Linux zSeries, Linux on POWER® Systems - Little Endian, AIX®, and Windows platforms. If OpenTelemetry trace is enabled on an integration server (by setting properties in the server.conf.yaml file) it is enabled for all message flows on the server. If you want to turn off the recording of data for an individual message flow, you can do so by setting properties in the administration REST API.

When OpenTelemetry data is collected for a message flow, additional information is added as message properties to the RFH2 header of MQ messages that are produced by the MQOutput and MQPublication nodes, and as HTTP header properties by the HTTP, REST, and SOAP request nodes. If this additional data is not required by consumers of the data produced by these nodes, you can turn off the collection of OpenTelemetry data for a specific message flow by setting the openTelemetryEnabled property in the administration REST API to false.

For example, to switch off the collection of OpenTelemetry data for message flow Flow1 in application App1, run the following curl command to issue the request to the administration REST API:

curl -X PATCH --header 'content-type: application/json'  \
      --data "{ \"properties\": { \"openTelemetryEnabled\": \"false\" } }" \
      localhost:7600/apiv2/applications/App1/messageflows/Flow1

You can also turn off the collection of OpenTelemetry data for all message flows in an application, by setting the openTelemetryEnabled property on the application to false.

To re-enable OpenTelemetry for a message flow on which telemetry data collection has been turned off, set the value of the openTelemetryEnabled property to inherit.

When OpenTelemetry data collection has been turned off on the integration server or the application, you cannot enable OpenTelemetry on an individual message flow.

You can check the OpenTelemetry settings that are active for an integration server by using one of the following methods:
  • Use the administration REST API to issue a GET on /apiv2/resource-managers/opentelemetry-manager for independent integration servers.
  • Run the mqsireportproperties command using the object name opentelemetry-manager on a managed integration server.

For more information about using OpenTelemetry, see Configuring OpenTelemetry trace for an integration server and OpenTelemetry considerations and limitations.