us.abstracta.jmeter.javadsl.datadog

Class DatadogBackendListener

java.lang.Object

us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

us.abstracta.jmeter.javadsl.core.listeners.BaseListener

us.abstracta.jmeter.javadsl.core.listeners.DslBackendListener<DatadogBackendListener>

us.abstracta.jmeter.javadsl.datadog.DatadogBackendListener

All Implemented Interfaces:

DslTestElement, DslTestPlan.TestPlanChild, DslListener, BaseSampler.SamplerChild, MultiLevelTestElement, BaseThreadGroup.ThreadGroupChild

public class DatadogBackendListener
extends DslBackendListener<DatadogBackendListener>

Test element which publishes all test run metrics to DataDog.

Since:

1.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatadogBackendListener.CodeBuilder
static class	DatadogBackendListener.DatadogSite

Nested classes/interfaces inherited from class us.abstracta.jmeter.javadsl.core.listeners.DslBackendListener

DslBackendListener.BackendListenerCodeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_KEY_ARG
static String	API_URL_ARG
protected String	apiKey
protected String	apiUrl
static String	LOG_URL_ARG
protected String	logsUrl
static String	RESULT_LOGS_ARG
protected boolean	resultsAsLogs
protected String[]	tags
static String	TAGS_ARG

Fields inherited from class us.abstracta.jmeter.javadsl.core.listeners.DslBackendListener

listenerClass, queueSize, url

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

guiClass, name

Constructor Summary

Constructors

Constructor and Description
DatadogBackendListener(String apiKey)

Method Summary

Modifier and Type	Method and Description
protected org.apache.jmeter.config.Arguments	buildListenerArguments()
static DatadogBackendListener	datadogListener(String apiKey) Creates a new DataDog Backend listener posting sample result metrics to DataDog for easy reporting and analysis.
DatadogBackendListener	resultsLogs(boolean enabled) Allows to enable/disable sending sample results as logs to DataDog.
DatadogBackendListener	site(DatadogBackendListener.DatadogSite site) Allows selecting the site of your DataDog instance to use proper URLs for such site.
DatadogBackendListener	tags(String... tags) Allows to specify tags to add to every metric sent to DataDog.

Methods inherited from class us.abstracta.jmeter.javadsl.core.listeners.DslBackendListener

buildTestElement, queueSize

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

buildConfiguredTestElement, buildTestElementGui, buildTreeUnder, configureTestElement, durationToSeconds, loadBeanProperties, showAndWaitFrameWith, showFrameWith, showInGui, showTestElementGui

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface us.abstracta.jmeter.javadsl.core.DslTestElement

buildTreeUnder, showInGui

Field Detail

API_KEY_ARG

public static final String API_KEY_ARG

See Also:

Constant Field Values

API_URL_ARG

public static final String API_URL_ARG

See Also:

Constant Field Values

LOG_URL_ARG

public static final String LOG_URL_ARG

See Also:

Constant Field Values

RESULT_LOGS_ARG

public static final String RESULT_LOGS_ARG

See Also:

Constant Field Values

TAGS_ARG

public static final String TAGS_ARG

See Also:

Constant Field Values

apiKey

protected final String apiKey

apiUrl

protected String apiUrl

logsUrl

protected String logsUrl

resultsAsLogs

protected boolean resultsAsLogs

tags

protected String[] tags

Constructor Detail

DatadogBackendListener

public DatadogBackendListener(String apiKey)

Method Detail

datadogListener

public static DatadogBackendListener datadogListener(String apiKey)

Creates a new DataDog Backend listener posting sample result metrics to DataDog for easy reporting and analysis.

Parameters:

apiKey - specifies the DataDog api key. To create one just go to your organization api keys settings.

Returns:

the listener for further configuration and usage.

site

public DatadogBackendListener site(DatadogBackendListener.DatadogSite site)

Allows selecting the site of your DataDog instance to use proper URLs for such site.

Parameters:

site - specifies the site to use. When no site is specified, US1 is used by default.

Returns:

the listener for further configuration and usage.

resultsLogs

public DatadogBackendListener resultsLogs(boolean enabled)

Allows to enable/disable sending sample results as logs to DataDog.

It is useful to enable sample results as logs to be able to get all the information of every request in DataDog. But, enabling them incurs in additional DataDog usage (cost) and network traffic. So, only enable them when you actually need them (eg: tracing issues, or you need detail of each request).

Parameters:

enabled - specifies to enable logging of sample results to DataDog when true. By default, results logs are not sent to DataDog.

Returns:

the listener for further configuration and usage.

tags

public DatadogBackendListener tags(String... tags)

Allows to specify tags to add to every metric sent to DataDog.

This is useful in scenarios where you need to add additional metadata to the metric for later on filtering, grouping and comparison in DataDog. You can check more information here.

Parameters:

tags - specifies the tags to add to every metric.

Returns:

the listener for further configuration and usage.

buildListenerArguments

protected org.apache.jmeter.config.Arguments buildListenerArguments()

Specified by:

buildListenerArguments in class DslBackendListener<DatadogBackendListener>