Dynatrace plugin
For more information about what this plugin does and the data streams it retrieves, see:
Monitor the Applications and Synthetic Transactions from your Dynatrace environment.
If you're not using a cloud-based Dynatrace environment and instead are running Dynatrace in your internal network, you want to use the on-prem Dynatrace data source, see How to add a Dynatrace on-prem data source.
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.
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 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.- Base URL:
Enter the Base URL to your Dynatrace environment, for examplehttps://myEnvironmentID.live.dynatrace.com/ - API Key:
Enter the API key you created in your Dynatrace environment. Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method. If this process fails, see Testing and troubleshooting for assistance with the corresponding errors.
Next steps
Data streams
The following data streams are installed with this plugin.
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.
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.
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.
How to add the on-prem data source
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.
An on-prem data source connects a service running in your internal network to SquaredUp. They require an agent installed on a machine that has access to your internal network.
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
If you have already created an agent in SquaredUp that you can use for this data source, 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.- 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 Sample Dashboards:
Select whether you would like to install sample dashboards with the data source. By default, this is set to on.You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.
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.
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. If this process fails, see Testing and troubleshooting for assistance with the corresponding errors.
Next steps
Data streams
The following data streams are installed with this plugin.
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.
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.
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.