New Relic integration for Gatling

Send load test metrics to New Relic.

Introduction#

The New Relic integration allows Gatling Enterprise Edition to send load-test metrics - such as response times, throughput, and error rates - directly into New Relic. Once enabled, performance data from Gatling Enterprise Edition is sent to New Relic, where it can be correlated with infrastructure and application metrics already collected in New Relic.

With this integration in place, you can:

• Monitor Gatling scenarios alongside server-level KPIs (CPU, memory, network) in a single dashboard.
• Investigate performance issues more effectively by overlaying load-test metrics on traces, logs, and resource utilization charts.

Prerequisites#

• A valid New Relic license key (for the metrics and events APIs)
• Your New Relic organization id (for the events)
• A Gatling Enterprise Edition account with private locations that can connect to the New Relic database.

Install the New Relic integration#

The New Relic integration requires installation steps on your private locations control plane.

In your control-plane configuration, in the section system-properties, add:

control-plane {
  locations = [
    {
      system-properties {
        "gatling.enterprise.newrelic.license.key" = "<your NewRelic license key>"
        "gatling.enterprise.newrelic.account" = "<your NewRelic account>" # for events
        "gatling.enterprise.newrelic.dc" = "US|EU" # optional, default is US
      }
    }
  ]
}

Uninstall the New Relic integration#

To remove the link between Gatling Enterprise Edition and New Relic, remove the lines containing gatling.enterprise.newrelic in your control-plane configuration.

Metrics#

Common attributes#

All the metrics Gatling Enterprise Edition sends have the following attributes:

• run_id: the ID of your run
• test: the name of your test
• team: the ID of the team your test belongs to
• load_generator: the O-based index of the load generator in the cluster used to run your test

Extra user-defined attributes#

You can set extra attributes with Java System properties set on your test. These System properties must follow the convention:

• name: gatling.enterprise.newrelic.attributes.<ATTRIBUTE_NAME>
• vale: <ATTRIBUTE_VALUE>

Pushed Metrics#

Gatling Enterprise Edition sends the following metrics in your New Relic account:

Events#

Gatling Enterprise Edition sends events to notify of the start and the end of a test.

Edit this page on GitHub