Apache JMeter tool plugin to Manage the integration of OpenTelemetry from Elastic Application Performance Monitoring in a JMeter script.
Link to github project otel-apm-jmeter-plugin
Apache JMeter tool plugin to manage the OpenTelemetry Elastic Application Performance Monitoring (OTEL ELASTIC APM) in JMeter script
This tool is present in the Menu Tools > vdn@github - OTEL ELASTIC APM Integration Tool
When you click and the menu line "vdn@github - OTEL ELASTIC APM Integration Tool", the tool GUI is display
Parameters are :
- file_in the JMeter script to read
- file_out the file result, if the text field is empty then the file_out is the file name of file_in without the extension with suffix "_modif.jmx"
e.g. file_in = script1.jmx, file_out is empty then file_out will be script1_modif.jmx - action = ADD or REMOVE,
- ADD = Add "User Defined Variables for OTEL_ACTIVE", add a "setUp Thread Group for init OpenTelemetry" contains JSR22 Groovy code and add "JSR223 groovy otel api call"
- REMOVE = remove "User Defined Variables for OTEL APM", remove "setUp Thread Group for init OpenTelemetry" and children, and remove "JSR223 groovy otel api call", the script will be as before action ADD
- regex the regular expression matches the "Transaction Controller" label, if the label doesn't match the regular expression then NO "JSR223 groovy otel api" surround the "Transaction Controller"
- default all = .* (this regular expression matches all labels)
- e.g. regex = SC\d+_P.+ matches labels "SC01_P01_LOGIN" or "SC20_P12B_LOGOUT" or SC01_P01_LOGIN|SC02_P02_FIND|SC02_P012_LOGOUT for some Transaction Controllers
Button "MODIFY SCRIPT", this button launch the tool with parameters.
Button "MODIFY SCRIPT AND LOAD NEW SCRIPT", this button launch the tool with parameters and next if no error LOAD the generated script in the current JMeter.
Status, the status line contains the tool status or the tool result.
e.g. : Status Results OK
- Tool OTEL ELASTIC APM Integration Finished OK, ACTION = ADD, fileOut=C:\Temp\script1_add.jmx
- Tool OTEL ELASTIC APM Integration Finished OK, ACTION = REMOVE, fileOut=C:\Temp\script1_add_modif.jmx
e.g. : Status Results KO
- Tool OTEL ELASTIC APM Integration Finished KO, CAN'T READ jmx fileIn = C:\Temp\script1zzzz.jmx
- Tool OTEL ELASTIC APM Integration Finished KO, exception = java.util.regex.PatternSyntaxException: Unmatched closing ')' near index 1 .*)
- Tool OTEL ELASTIC APM Integration Finished KO, CAN'T CREATE or jmx file doesn't exist (look in the log file), fileOut = c:\toto (in log file : java.io.FileNotFoundException: c:\toto (Access denied) )
For more documentation (configuration of the OpenTelemetry ELASTIC Java Agent, download OTEL Elastic Java Agent, JMeter start script shell modified ...) look at README from jmeter-otel-apm
All Transactions in Kibana APM Dashboards with the vision of the page in JMeter (JMeter Transaction Controller usually == page) (click on image to see the full size image)
And the TIMELINE for JMeter Transaction Controller, you see the JMeter Page and the web application gestdoc running in Tomcat (click on image to see the full size image)
The simplified architecture : Apache JMeter and a Java OTEL Elastic Agent, Apache Tomcat and the Java OTEL Elastic Agent with web application gestdoc, ElasticSearch suite with ElasticSearch, APM Server and Kibana, a user views the Kibana Dashboards with navigator.
This tool could be use with script shell Windows or Linux.
Scripts shell are in <JMETER_HOME>/bin
- otel-apm-integrate.cmd for Windows OS
- otel-apm-integrate.sh for Linux/Mac OS
Help to see all parameters :
C:\apache-jmeter\bin>otel-apm-integrate.cmd -help
usage: io.github.vdaburon.jmeter.otelxml.OtelJMeterManager -action <action> [-extract_end <extract_end>] [-extract_start
<extract_start>] [-extract_udv <extract_udv>] -file_in <file_in> -file_out <file_out> [-help] [-regex <regex>]
io.github.vdaburon.jmeter.otelxml.OtelJMeterManager
-action <action> action ADD or REMOVE, ADD : add groovy api call and REMOVE : remove groovy api call
-extract_end <extract_end> optional, file contains groovy end call api (e.g : extract_end.xml), default read file
in the jar
-extract_start <extract_start> optional, file contains groovy start call api (e.g : extract_start.xml), default read
file in the jar
-extract_udv <extract_udv> optional, file contains User Defined Variables and setUp Thread Group for init
OpenTelemetry (e.g : extract_udv.xml), default read file in the jar
-file_in <file_in> JMeter file to read (e.g : script.jmx)
-file_out <file_out> JMeter file modified to write (e.g : script_add.jmx)
-help Help and show parameters
-regex <regex> regular expression matches Transaction Controller Label (default .*) (e.g : SC[0-9]+_.
for SC01_P01_HOME or SC09_P12_LOGOUT)
E.g : java -jar jmeter-otel-apm-<version>-jar-with-dependencies.jar -file_in script1.jmx -file_out script1_add.jmx
-action ADD -regex SC.*
E.g : java -jar jmeter-otel-apm-<version>-jar-with-dependencies.jar -file_in script1_add.jmx -file_out
script1_remove.jmx -action REMOVE -regex .*
e.g. action = ADD :
C:\apache-jmeter\bin>otel-apm-integrate.cmd -file_in C:\temp\script1.jmx -file_out C:\temp\script1_add_cli.jmx -action ADD -regex SC.*
e.g. action = REMOVE :
/var/opt/apache-jmeter/bin>otel-apm-integrate.sh -file_in /tmp/script1_add.jmx -file_out /tmp/script1_remove_cli.jmx -action REMOVE
This tool could be installed with the jmeter-plugins-manager from https://jmeter-plugins.org/
The tool name is : "vdn@github - otel-apm-tool"
The maven groupId, artifactId and version, this plugin is in the Maven Central Repository
<groupId>io.github.vdaburon</groupId>
<artifactId>otel-apm-jmeter-plugin</artifactId>
<version>1.0</version>version 1.0 2025-01-15, First release