extension-jmeter

README

Steadybit extension-jmeter

A Steadybit action implementation to integrate jmeter load tests into Steadybit experiments.

Learn about the capabilities of this extension in our Reliability Hub.

Configuration

Environment Variable	Helm value	Meaning	required	default
STEADYBIT_EXTENSION_ENABLE_LOCATION_SELECTION	enableLocationSelection	By default, the platform will select a random instance when executing actions from this extension. If you enable location selection, users can optionally specify the location via target selection.	no	false

The extension supports all environment variables provided by steadybit/extension-kit.

Installation

Kubernetes

Detailed information about agent and extension installation in kubernetes can also be found in our documentation.

Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the helm-chart of the agent.

You must provide additional values to activate this extension.

--set extension-jmeter.enabled=true \

Additional configuration options can be found in the helm-chart of the extension.

Alternative (via own helm chart)

If you need more control, you can install the extension via its dedicated helm-chart.

helm repo add steadybit-extension-jmeter https://steadybit.github.io/extension-jmeter
helm repo update
helm upgrade steadybit-extension-jmeter \
    --install \
    --wait \
    --timeout 5m0s \
    --create-namespace \
    --namespace steadybit-agent \
    steadybit-extension-jmeter/steadybit-extension-jmeter

Linux Package

This extension is currently not available as a Linux package.

Extension registration

Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to the documentation for more information about extension registration and how to verify.

Location Selection

When multiple JMeter extensions are deployed in different subsystems (e.g., multiple Kubernetes clusters), it can be tricky to ensure that the load test is performed from the right location when testing cluster-internal URLs or having different load testing hardware sizings. To solve this, you can activate the location selection feature. Once you do that, the JMeter extension discovers itself as a JMeter location. When configuring the experiment, you can optionally define which extension's deployment should execute the loadtest. Also, the execution locations are part of Steadybit's environment concept, so you can assign permissions for execution locations.

Migration Guideline

Before activating the location selection feature, be sure to follow these steps:

1. The installed agent version needs to be >= 2.0.47, and - only for on-prem customers - the platform version needs to be >=2.2.2
2. Activate the location selection via environment or helm variable when deploying the latest extension version (see configuration options.
3. Configure every environment that should be able to run JMeter load tests by including the execution location in the environment configuration. One option is to add the statement or target via the query language.type="com.steadybit.extension_jmeter.location" to your existing query. You can also filter the available execution locations down, e.g., via the clustername by using (target.type="com.steadybit.extension_jmeter.location" and k8s.cluster-name="CLUSTER-NAME")