💠
Dynatrace
StackState core integration
This page describes StackState version 4.3.
The StackState 4.3 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.3 version range to upgrade to a more recent release.
The Dynatrace StackPack creates a synchronization between a Dynatrace instance and StackState. When the integration is enabled, Dynatrace Smartscape topology and events for the configured
relative_time
(default 1 hour) will be available in StackState.Data flow
- Events are available in the StackState Events Perspective and listed in the details pane of the StackState UI.
To set up the Dynatrace integration you will need to have:
- A running Dynatrace instance.
- A Dynatrace API Token with access to read the Smartscape Topology and Events, see REST API endpoints.
Install the Dynatrace StackPack from the StackState UI StackPacks > Integrations screen. You will need to provide the following parameters:
- Dynatrace URL - the Dynatrace URL from which topology will be collected.
- Dynatrace Instance Name - the user-defined name of the Dynatrace account shown in configurations such as views.
To enable the Dynatrace check and begin collecting data from Dynatrace, add the following configuration to StackState Agent V2:
- 1.Edit the Agent integration configuration file
/etc/stackstate-agent/conf.d/dynatrace.d/conf.yaml
to include details of your Dynatrace instance:
- url - the URL of the Dynatrace instance.
- # Section used for global dynatrace check configinit_config:instances:# mandatory- url: <url> # URL of the Dynatrace instancetoken: <token> # API-Token to connect to Dynatrace# verify: True # By default its True# timeout: 10# cert: /path/to/cert.pem# keyfile: /path/to/key.pem# domain: <domain> # default 'dynatrace'# environment: <environment> # default 'production'# relative_time : <relative_time> # default 'hour'# events_bootstrap_days: 5 # default 5 days# events_process_limit: 10000 # default 10k events# tags:# - foo:bar
- 1.Optional: Add a domain and environment in the
conf.yaml
file to specify where imported Dynatrace topology will end up in StackState (default domain=dynatrace and environment=production). - 2.
- 3.Once the Agent has restarted, wait for data to be collected from Dynatrace and sent to StackState.
To check the status of the Dynatrace integration, run the status subcommand and look for Dynatrace under
Running Checks
:sudo stackstate-agent status
When a new version of the Dynatrace StackPack is available in your instance of StackState, you will be prompted to upgrade in the StackState UI on the page StackPacks > Integrations > Dynatrace. For a quick overview of recent StackPack updates, check the StackPack versions shipped with each StackState release.
The API Token configured in StackState Agent V2 must have the permission Access problems and event feed, metrics, and topology (API value
DataExport
), see Dynatrace API token permissions (dynatrace.com) for details. The API endpoints used in the StackState integration are listed below:/api/v1/entity/applications
/api/v1/entity/infrastructure/hosts
/api/v1/entity/infrastructure/processes
/api/v1/entity/infrastructure/process-groups
/api/v1/entity/services
/api/vi/events
The Dynatrace check retrieves all events and their parameters from Dynatrace for the configured
relative_time
(default 1 hour). Retrieved events are available in the StackState Events Perspective and listed in the details pane of the StackState UI.The Dynatrace check does not retrieve any metrics data.
All tags defined in Dynatrace will be retrieved and added to the associated components and relations in StackState. The Dynatrace integration also understands common tags and applies these to topology in StackState.
The Dynatrace check retrieves the following topology data from Dynatrace:
Data | Description |
---|---|
Components | Smartscape Applications, Hosts, Processes, Process-Groups and Services. |
Relations | Relations between the imported components are included in the component data retrieved from Dynatrace. |
The Dynatrace check does not retrieve any traces data.
When the Dynatrace integration is enabled, the following additional keys can be used to filter views in the StackState UI:
- dynatrace-ManagementZones
- dynatrace-EntityID
- dynatrace-Tags
- dynatrace-MonitoringState
For example, to filter a view by Dynatrace Management Zone, add the key
dynatrace-managementZones:<value>
to the Labels filter box.
Use a Dynatrace topology filter
The code for the Dynatrace check is open source and available on GitHub at: https://github.com/StackVista/stackstate-agent-integrations/tree/master/dynatrace
To uninstall the Dynatrace StackPack and disable the Dynatrace check:
- 1.Go to the StackState UI StackPacks > Integrations > Dynatrace screen and click UNINSTALL.
- All Dynatrace specific configuration will be removed from StackState.
- 2.Remove or rename the Agent integration configuration file, for example:mv dynatrace.d/conf.yaml dynatrace.d/conf.yaml.bak
- 3.
Dynatrace StackPack v1.1.1 (2021-04-02)
- Feature: Gather Events from your Dynatrace instance and provides Health info about Dynatrace components.
- Feature: Support for Dynatrace tags.
- Improvement: Enable auto grouping on generated views.
- Improvement: Common bumped from 2.2.3 to 2.5.1
- Improvement: StackState min version bumped to 4.3.0
Dynatrace StackPack v1.0.0
- Feature: Gathers Topology from your Dynatrace instance and allows visualization of your Dynatrace components and the relations between them.
Last modified 10mo ago