Mule 4 OpenTelemetry (OTel) Agent Extension

Table of Contents

• Link to the Extension jar file
• Release Notes
  • Version 1.5.0 [New Relic Labs ]
  • Version 1.4.15 [New Relic Labs ]
  • Version 1.0.2 [New Relic Labs ]
• Links to the documentation
  • HTML Version - Recommended**
  • ADOC Version
• Backends Tested Against

❗	This work effort is a field extension; hence, it is delivered on an "as-is" basis. Please refrain from contacting MuleSoft Support for technical support. Instead. use GitHub Issues to provide feedback, suggest enhancements or report a bug.

Link to the Extension jar file

Release Notes

Version 1.5.0 [New Relic Labs ]

✨ New Features & Enhancements in v1.5.0

This version focuses on providing deeper insights into your application’s performance and health, aligning with industry best practices for observability.

1. Golden Signals Metrics Implementation:

   • Latency (mule.flow.latency, mule.processor.latency): We’ve added detailed histogram metrics to measure the duration of Mule flow executions and individual message processor invocations. This provides critical insights into response times and helps identify performance bottlenecks. Latency is reported in milliseconds.

   • Traffic (mule.flow.traffic.total, mule.processor.traffic.total): New counter metrics now track the total number of Mule flow executions and message processor invocations. This helps you understand the load and throughput of your application.

   • Errors (mule.flow.errors.total, mule.processor.errors.total): Counter metrics have been introduced to count errors occurring within Mule flow executions and message processor invocations. This provides immediate visibility into the reliability of your application.

2. Enhanced Distributed Tracing Attributes:

   • Standard HTTP Semantic Conventions: For HTTP Listener spans, we now explicitly set http.target (full request path including query string) and http.route (the templated path configured in the listener). Crucially, the HTTP method is now correctly reported using the standard http.method attribute. These changes ensure that APM tools can accurately name and group your web transactions, eliminating "unknown" labels.

3. Existing Metrics Maintained:

   • The extension continues to report JVM Heap Memory Usage (jvm.memory.heap.usage) and System Workload Utilization (system.workload.utilization), providing foundational insights into runtime resource consumption.

     • Add following dependency to applications pom.xml

  <dependency>
      <groupId>com.newrelic.labs</groupId>
      <artifactId>otel-mule4-observability-agent</artifactId>
      <version>1.5.0</version>
      <classifier>mule-plugin</classifier>
  </dependency>

Version 1.4.15 [New Relic Labs ]

✨ New Features & Enhancements in v1.4.15

• Add following dependency to applications pom.xml

  <dependency>
      <groupId>com.newrelic.labs</groupId>
      <artifactId>otel-mule4-observability-agent</artifactId>
      <version>1.4.15</version>
      <classifier>mule-plugin</classifier>
  </dependency>

• Header Control: You can now configure the headers to be dropped from being sent to New Relic.

The sections to follow :

Global Element Properties → OLTP Trace Exporter → Custom Attributes → Headers to be exluded …​.

[Default values ] - mw_client_id,mw_client_secret


• JDK 17 Release: This version is compatible with JDK 17.

• Mule Runtime 4.9.2: Ensure your Mule environment is running version 4.9.2 for compatibility.

Version 1.0.2 [New Relic Labs ]

• Dependency

  <dependency>
      <groupId>com.newrelic.labs</groupId>
      <artifactId>otel-mule4-observability-agent</artifactId>
      <version>1.0.2</version>
      <classifier>mule-plugin</classifier>
  </dependency>

• JDK 17 Release: This version is compatible with JDK 17.

• Mule Runtime 4.9.2: Ensure your Mule environment is running version 4.9.2 for compatibility.

Links to the documentation

Please refer to one of the two options below for extended documentation on this extension.

HTML Version - Recommended**

The HTML version is usually more presentation friendly and preferred for viewing this documentation.

• Extended Documentation in HTML format

ADOC Version

The adoc version doesn’t always render optimally in GitHub but if you have trouble with HTML then use this link.

• Extended Documentation in adoc format

Backends Tested Against

backendsTested.adoc