Skip to content

Latest commit

 

History

History
102 lines (96 loc) · 5.2 KB

README.md

File metadata and controls

102 lines (96 loc) · 5.2 KB
Raw

Elastic APM agent for Mule 4.x

important note

Until version 1, the agent is considered work in progress, where some of the features may be broken or missing. Please feel free to download the agent, raise issues, test and contribute to make it better.

Work in progress

These items are still missing and still need to be developed:

  • Distributed tracing with HTTP.
  • Generic distributed tracing for non-HTTP protocols.
  • Capturing flow variables and properties in the flow.
  • Documentation.

Overview

The agent allows tracking the timing of Mule flow steps executions and captures data, metrics and exceptions raised in Mule flows. It is included as Maven dependency and is instantiated in the flow. The data collected by the agent is stored in Elasticsearch and can be visualised in Kibana in a way compatible with the rest of Elastic APM stack. This allows Mule 4 components to be monitored and profiled alongside other technologies in Elastic APM. The agent is built using Elastic Java APM agent and is compatible with Java APM agent configuration options.

Installation

Download the latest jar from the Releases and install it using Maven. Make sure to populate the right values for PATH_TO_JAR and AGENT_VERSION.

mvn install:install-file -Dfile=$PATH_TO_JAR -DgroupId=co.elastic.apm -DartifactId=mule4-agent -Dversion=$AGENT_VERSION -Dpackaging=jar

Setup in Mule

Add dependency in Maven

Add the following dependency to Mule project's pom.xml file. You can use elastic.mule4.apm.agent property as the version to match the version of the agent downloaded and installed previously in the properties section of Mule project pom.xml file.

<dependency>
  <groupId>co.elastic.apm</groupId>
  <artifactId>mule4-agent</artifactId>
  <version>${elastic.mule4.apm.agent}</version>
</dependency>

Top-level Mule flow

In the top level flow, add the follwing import statement to initialise the agent. The id warning can be ignored, or the id can be regenerated.

<import file="tracer.xml"  doc:name="Import" doc:id="3cd0c923-2ca2-4173-a2e8-c43380f03b3c" />

Configuration

The agent configuration is done using system properties with all the properties used in Elastic Java APM agent configuration.

Command line

When running Mule through the command line, use the following format to configure the APM agent.

-M-Delastic.apm.server_urls=http://localhost:8200 \
-M-Delastic.apm.service_name=component1 \
-M-Delastic.apm.service_version=v1.0.0 \
-M-Delastic.apm.stack_trace_limit=15 \
-M-Delastic.apm.span_frames_min_duration=0ms \
-M-Delastic.apm.log_level=INFO

It is also possible to use property file based configuration by specifying the location of the properties file in elastic.apm.config_file option.

Anypoint Studio

Pass the configuraion parameters in command line arguments section of Run Configurations... dialog, as per the image below. Anypoint Run Configuration

Test projects

dep-test

Mule flow

The dep-test folder in this repo contains a sample test project configured to work with Elastic APM agent for Mule 4 and containing the flow below. Note the last logger in the topmost flow didn't run due to exception thrown by the Execute step denoted as red square. dep-test-flow

The above flow should produce APM transaction similar to this:

dep-test-apm

The agent also captures exceptions thrown in Mule:

error1

Metrics

Elastic Java APM agent also captures JVM metrics, so all the Mule JVM metrics collected by the agent are there as well: metrics

Support for Mule domains

The mule4-agent APM dependency should be added to the domain pom.xml file and also be declared as sharedLibrary there for it to be visible to the domain projects deployed with the domain configuration. pom.xml:

<build>
  <plugins>
    <plugin>
      <groupId>org.mule.tools.maven</groupId>
      <artifactId>mule-maven-plugin</artifactId>
      <version>${mule.maven.plugin.version}</version>
      <extensions>true</extensions>
      <configuration>
        <sharedLibraries>

          <!-- Added exported dependency at the domain level for the code to be visible for domain projects -->
          <sharedLibrary>
            <groupId>co.elastic.apm</groupId>
            <artifactId>mule4-agent</artifactId>
          </sharedLibrary>

        </sharedLibraries>
      </configuration>
    </plugin>
  </plugins>
</build>

<dependencies>
...
  <dependency>
    <groupId>co.elastic.apm</groupId>
    <artifactId>mule4-agent</artifactId>
    <version>${elastic.mule4.apm.agent}</version>
  </dependency>
...
</dependencies>

Then, every project that needs to be traced, should include the following in the flow definition once per project:

<import doc:name="Import" doc:id="b9240848-52ad-4dcc-8ed4-6f9e864bd1e4" file="tracer.xml" />