Dynatrace plugin

Monitor the Applications and Synthetic Transactions from your Dynatrace environment.

For more information about what this plugin does and the data streams it retrieves, see:

The Dynatrace plugin is a "hybrid" plugin, meaning it is available in SquaredUp as both a cloud and an on-prem plugin.

Use the cloud plugin if your Dynatrace instance is cloud-based. You do not need to configure a relay agent.
Use the on-prem plugin if you are running Dynatrace on your internal network. You will need to configure a relay agent before you configure the Dynatrace on-prem plugin.
An on-prem data source uses a relay agent to connect SquaredUp to a data source running on your internal network.
A relay agent is installed on a server on your internal network, and has access to your data source.
Using a relay agent means that you don't need to open your firewall to allow access.

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

Before you start

Generate Dynatrace Access Token

Generate a new token in Dynatrace and save the token to use when adding the data source to SquaredUp later, see Dynatrace: Generate an access token.

Configuring and deploying an agent

For an on-prem plugin you will need a relay agent that can access the server hosting your on-prem data source. You do not need a relay agent for cloud plugins.

If you have already created a relay agent in SquaredUp that can access this data source, then you can skip this step and choose the agent group you want to use while Configuring the data source.

See one of the following, depending on your platform type:

Configuring the data source

Display Name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Agent Group:
Select the Agent Group that contains the agent(s) you want to use.
This field will only appear if you are adding the on-prem plugin.
Base URL:
Enter the Base URL to your Dynatrace environment in the following format:
https://your-domain/e/your-environment-id/
API Key:
Enter the API key you created in your Dynatrace environment.
Install Dashboards:
Select whether you would like to install pre-built dashboards and perspectives with the data source. By default, this is set to on.

Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

Use the Restrict access to this data source dropdown to control who has access to the workspace:

By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.
Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.
At least one user or group must be given Full Control.
Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

Access level	Permissions
Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
Full Control	User can change the data source configuration, ACL, and delete the data source.

See Access control for more information.

Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.

Next steps

Data streams

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

The following data streams are installed with this plugin.

Data stream	Description
Browser Monitor Health	Health based on the Monitor's problems
Custom Application Health	Health state based on a Custom Application's problems
Database Health	Health state based on a Database's problems
Host Health	Health state based on a Host's problems
HTTP Monitor Health	Health based on the Monitor's problems
Problems	Dynatrace problems for the selected nodes
Response Time	Dynatrace response time for the selected nodes
Response Time History	Dynatrace response time for the selected nodes
Service Health	Health state based on a Service's problems

You can visualize the status of your hosts or services with the Dynatrace Health data streams. The available Health data streams are:

Application Health
Browser Monitor Health
Database Health
HTTP Monitor Health
Host Health
Service Health

You can visualize the data as blocks by first setting up the requirements for potential problems related to the state of your hosts and services from your Dynatrace account. SquaredUp will then visualize the block as red/green based on the reported problems from Dynatrace.

If the block displays as green, there are no problems with the state of your hosts or services. If the block displays as red, there are problems associated with the state of your hosts or services.

Alternatively, you can visualize the data as a table in SquaredUp.

Configurable data streams

The following data streams have configurable Parameters.

Data stream	Description	Parameters
Metric	Get Metrics for the following objects, depending on the selected collection: Services Custom applications applications hosts databases monitors	Metric Key: Enter a metric key to filter by. Show only most recent value: Select this checkbox to retrieve only the most recent value.

This data stream calls the /api/v2/metrics/query endpoint with a pre-set query, and allows you to enter a custom metric key.

In the tile editor, filter by the Dynatrace data source, select the configurable Metric data stream that you want to use and then click Next.
Select the objects that you want to use and then click Next.
Select a Metric Key from the dropdown, for example: builtin:service.response.time
Optionally, tick Show only most recent value if you want to only show the one latest value. If this is not ticked then any historical data is shown, so line graphs over time are possible. If you are showing historical data, you might like to name your data stream to indicate this, for example Availability History.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket