Dynatrace

5 minute readExtensibilityDeveloper productivity

The EC-Dynatrace plugin integrates with Dynatrace Appmon test automation API.

Plugin version 1.2.3.2020102201 Revised on May 28, 2020

Plugin configurations

Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined parameter sets for end users, and securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.

Creating plugin configurations

To create plugin configurations in CloudBees CD, do these steps:

  1. Go to Administration Plugins to open the Plugin Manager.

  2. Find the EC-Dynatrace row.

  3. Click Configure to open the EC-Dynatrace Configurations page.

  4. Click Create Configuration.

  5. To enable CloudBees CD server to communicate with the Dynatrace API, enter the following information:

The EC-Dynatrace configurations page now shows the new configuration.

Editing plugin configurations

To edit plugin configurations in CloudBees CD, do these steps:

  1. Go to Administration > Plugins to open the Plugin Manager.

  2. Find the EC-Dynatrace row.

  3. Click Configure to open the EC-Dynatrace Configurations page.

  4. Find the configuration that you want to edit.

  5. Click Edit.

  6. Edit the parameters in the configuration.

  7. Click OK to save the modified configuration.

Plugin procedures

For all parameter descriptions below, required parameters are shown in bold italics.

Create test run

This procedure creates a new test run and writes its ID to the specified property. This ID can be used later for test run with Dynarace agent injected.

Create test run parameters

ParameterDescription

Configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

Category

Tests are organised into four categories. A category principally defines the key performance indicators (KPIs) that AppMon evaluates for your test. For every test category, only KPIs of interest are shown. The configuration required for capturing performance data depends on the test category and on the test framework used. For more information, please follow the link Capture Performance Data from Tests

System profile name

System profile name for test run creation. E.g. "Monitoring".

Version

Version in format major.minor.revision.build.milestone. Version parts can be divided by dot or hyphen. Version can be specified either here or below by version parts. This field can be used if there is already full artifact version saved in some property.

Marker

If a marker is set in the test metadata, it is displayed in the chart’s heat field.

Additional metadata

Additional meta data can be provided as key-value pairs, separated by newline. e.g. mykey=value. It will be returned as a part of test report.

Property name for test run ID

Property to save ID of the created test run. E.g. /myPipelineStageRuntime/dtTestrunID

Get test run result

This procedure retrieves results for test run and saves them under the specified property, and also generates HTML report.

Get test run result parameters

ParameterDescription

Dynatrace configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

Profile name

System profile name, required for test run creation. E.g. "Monitoring". By default will be taken from /myPipelineStageRuntime/dtSystemProfile. If the procedure does not run as a part of pipeline, please provide this value.

Test run ID

Previously saved test run ID. E.g. $[/myPipelineStageRuntime/dtTestrunID] will take test run ID from property in this pipeline stage runtime.

Min wait timeout

Time in seconds to wait before fetching test run result. For some test categories, like UI driven test run, Dynatrace takes some time to process results. If you get incomplete test result, with less cases than there should be, increase this value.

Max wait timeout

Timeout for test results polling in seconds. This value should be greater then "Delay Timeout" parameter. If there are no test results within the specified timeout, the procedure will fail.

Property name for results

A name of property to save Dynatrace test run result into. Results will be saved in JSON format.

Publish report?

If checked, HTML report with test run information will be published to the current pipeline summary and to the job summary.

Convert json to property sheet

This procedure takes raw json test result and writes it into the specified property sheet.

Convert json to property sheet parameters

ParameterDescription

Dynatrace configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

Raw JSON

Raw json to be converted.

Property name for results

A name of property to save Dynatrace test run result into.

Create deployment incident

This procedure takes information about the deployment and creates a new deployment incident in Dynatrace.

Create deployment incident parameters

ParameterDescription

Dynatrace configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

System profile name

System profile name, required for test run creation. E.g. "Monitoring".

Application name

A name of the application which is going to be deployed.

Application project name

Project name of the application.

Deployment snapshot name

A snapshot that was used for deployment.

Restore snapshot name

Snapshot name, which will represent restore point.

Environment name

Name of the environment.

Environment project name

Environment project name.

Incident duration

Duration of the deployment incident in seconds. 0 by default.

Incident message

A message for deployment incident. By default will be generated from the parameters above.

Additional parameters

Additional parameters to pass to deployment incident, in JSON format.

Get last deployment incident

This procedure takes information about the deployment and creates a new deployment incident in Dynatrace.

Get last deployment incident parameters

ParameterDescription

Dynatrace configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

System profile name

System profile name, required for test run creation. E.g. "Monitoring".

Period in minutes

Time period (in minutes), which should contain deployment incident. E.g., if this value is 60, then we will look for incident that has happened no later than one hour ago. By default retrieves all incidents within three days.

Property sheet name

Property sheet for saving incident data.

Application name

Application name to filter found incidents.

Application project name

Application project name to filter found incidents.

Environment name

Environment name to filter found incidents.

Environment project name

Environment project name to filter found incidents.

Additional parameters

Additional parameters to filter by. Should be provided in JSON format.

Get system profiles

This procedure retrieves system profiles from Dynatrace and stores them for using in drop-downs.

Get system profiles parameters

ParameterDescription

Dynatrace configuration

The name of an existing configuration which holds the connection information for Dynatrace API.

Release notes

EC-Dynatrace 1.2.3

  • The documentation has been migrated to the main documentation site.

EC-Dynatrace 1.2.2

  • Removing certain third-party dependencies to address security issues.

EC-Dynatrace 1.2.1

  • Renaming to "CloudBees CD".

EC-Dynatrace 1.2.0

Provisioning of binary dependencies (for example Grape jars) in the agent resource, required by this plugin, is now delivered through a newly introduced mechanism called plugin dependency management. Binary dependencies will now be seamlessly delivered to the agent resource from the CloudBees CD server, any time a new version of a plugin is invoked the first time. CloudBees CD repository set up is no longer required for this plugin.

EC-Dynatrace 1.1.1

Renaming to "CloudBees".

EC-Dynatrace 1.1.0

  • Plugin promotion time has been improved.

EC-Dynatrace 1.0.2

  • Configurations can be created by users with "@" sign in a name.

EC-Dynatrace 1.0.1

  • The plugin icon has been updated.

EC-Dynatrace 1.0.0

  • First release.