Dynatrace
Dynatrace is a software intelligence platform that monitors and optimizes application performance, development and security, IT infrastructure, and user experience. The Dynatrace Software Intelligence Platform maps, and monitors applications, microservices, container orchestration platforms such as Kubernetes, and IT infrastructure running in multi-cloud and hybrid-cloud environments, and provides automated problem remediation.
Nobl9 integration with Dynatrace allows users to fetch metric datapoints via metric v2 API with a one-minute resolution. Users can provide a custom selector (by providing value for the metricSelector parameter of the API).
Dynatrace parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent, Direct
- Replay and SLI Analyzer: Historical data limit 28 days
- Event logs: Supported
- Query checker: Supported
- Query parameters retrieval: Supported
- Timestamp cache persistence: Supported
- Query parameters:
- Query interval: 1 min
- Query delay: 2 min
- Jitter: 15 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Plugin name: n9dynatrace
- Query delay environment variable: DYNATRACE_QUERY_DELAY
- Replay and SLI Analyzer: 0.66.0
- Query parameters retrieval: 0.73.2
- Timestamp cache persistence: 0.65.0
- Additional notes:
- Only metrics obtained with the metricSelector clause are supported
- Learn more
Dynatrace's metricSelector
allows you to query for multiple metrics at once. Note that Nobl9 treats SLO data points as time series. Effectively, it means that Nobl9 rejects any datapoint with a timestamp already stored for a given SLO.
To avoid uncertainty, query for data points for only one metric.
Authentication
When setting up the Nobl9 agent or direct connection to your Dynatrace instance, you must provide an access token with metrics.read
scope activated.
For details on how to get your token, refer to the Dynatrace API - Tokens and authentication | Dynatrace documentation.
Adding Dynatrace as a data source
You can add the Dynatrace data source using the direct or agent connection methods.
Direct connection method
Direct connection to Dynatrace requires users to enter their credentials which Nobl9 stores safely.
Nobl9 Web
To set up this type of connection:
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Add the URL to connect to your data source (mandatory).
Depending on the type of environment, the URL must match one of the following formats:-
SaaS:
<https://{your-environment-id}.live.dynatrace.com>
-
Managed:
<https://{your-domain}/e/{your-environment-id}>
-
Environment ActiveGate:
<https://{your-activegate-domain}/e/{your-environment-id}>
-
-
Enter the Dynatrace Token (mandatory).
To use the Dynatrace API, you must provide an access token withmetrics.read
scope activated. For more information, refer to the Authentication section above.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Dynatrace integration for Query delay is
2 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in Dynatrace integration for Query delay is
- Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
Find the maximum value for your data source. - A greater period can extend the loading time when creating an SLO.
- The value must be a positive integer.
- Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or
0
. - By default, this value is set to 0. When you set it to
>0
, you will create SLOs with Replay.
- Click Add Data Source
When you run Replay for the Maximum Period for Historical Data Retrieval for Dynatrace (28 days), remember that due to Dynatrace limitations, there may be 1h of degraded resolution at the beginning of the selected time range.
sloctl
- Create a YAML definition to set up a direct connection with Google BigQuery. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: dynatrace
displayName: Dynatrace Direct
project: default
spec:
description: Example Dynatrace Direct
releaseChannel: stable
dynatrace:
url: https://zvf10945.live.dynatrace.com/
dynatraceToken: "[secret]"
historicalDataRetrieval:
maxDuration:
value: 28
unit: Day
defaultDuration:
value: 14
unit: Day
triggeredBySloCreation:
value: 14
unit: Day
triggeredBySloEdit:
value: 14
unit: Day
queryDelay:
value: 3
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . • Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. • Must be a number less than 1440 minutes (24 hours). • Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Contact us to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
dynatrace.dynatraceURL mandatory | string | Interface URL. Depending on the environment, the expected URL format is: • SaaS: https://{your-environment-id}.live.dynatrace.com • Managed: https://{your-domain}/e/{your-environment-id} • ActiveGate: https://{your-activegate-domain}/e/{your-environment-id} |
dynatrace.dynatraceToken mandatory | string, secret | A hash that can be generated in the Dynatrace UI. See authentication for more details. |
Replay-related fields | ||
historicalDataRetrieval optional | n/a | Optional structure related to configuration related to Replay. ❗ Use only with supported sources. • If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration . |
maxDuration.value optional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer ≥ 0 . See Replay documentation for values of max duration per data source. |
maxDuration.unit optional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
defaultDuration.value optional | numeric | Specifies the default duration for historical data retrieval. Must be integer ≥ 0 and ≤ maxDuration . |
defaultDuration.unit optional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
spec.historicalDataRetrieval
- refer to Replay documentation for more details.
- Apply your YAML definition using the
sloctl apply
command.
Agent connection method
Nobl9 Web
Follow the instructions below to set up an agent connection.
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Add the URL to connect to your data source.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Dynatrace integration for Query delay is
2 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in Dynatrace integration for Query delay is
- Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
Find the maximum value for your data source. - A greater period can extend the loading time when creating an SLO.
- The value must be a positive integer.
- Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or
0
. - By default, this value is set to 0. When you set it to
>0
, you will create SLOs with Replay.
- Click Add Data Source
- Deploy your agent in a Kubernetes cluster or Docker container.
When you run Replay for the Maximum Period for Historical Data Retrieval for Dynatrace (28 days), remember that due to Dynatrace limitations, there may be 1h of degraded resolution at the beginning of the selected time range.
sloctl
- Create a YAML definition to set up an agent connection with Dynatrace. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: dynatrace
displayName: Dynatrace Agent
project: default
spec:
description: Example Dynatrace Agent
releaseChannel: stable
dynatrace:
url: https://zvf10945.live.dynatrace.com/
historicalDataRetrieval:
maxDuration:
value: 28
unit: Day
defaultDuration:
value: 14
unit: Day
queryDelay:
value: 3
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . • Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. • Must be a number less than 1440 minutes (24 hours). • Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
dynatrace.dynatraceURL mandatory | string | Interface URL. Depending on the environment, the expected URL format is: • SaaS: https://{your-environment-id}.live.dynatrace.com • Managed: https://{your-domain}/e/{your-environment-id} • ActiveGate: https://{your-activegate-domain}/e/{your-environment-id} |
Replay-related fields | ||
historicalDataRetrieval optional | n/a | Optional structure related to configuration related to Replay. ❗ Use only with supported sources. • If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration . |
maxDuration.value optional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer ≥ 0 . See Replay documentation for values of max duration per data source. |
maxDuration.unit optional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
defaultDuration.value optional | numeric | Specifies the default duration for historical data retrieval. Must be integer ≥ 0 and ≤ maxDuration . |
defaultDuration.unit optional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
- Apply your YAML definition using the
sloctl apply
command. - Deploy your agent in a Kubernetes cluster or Docker container.