Integrating with Dynatrace

Dynatrace platform leverages unified AIOps at its core to simplify cloud operations, automate DevSecOps, and integrate with all major cloud platforms and technologies.

Configure an integration with Dynatrace, to view the alert, event, metric, and topology data from Dynatrace in the following products and derive actionable insights:

• BMC Helix Operations Management
  BMC Helix Operations Management displays alerts as events, even though Dynatrace separates events and alerts. 

  Important

  Starting from version 23.1.01, events are not collected from Dynatrace. If you have added a Dynatrace connector instance before upgrading to 23.1.01, event collection continues for that instance after upgrade.

• BMC Helix Discovery
• BMC Helix AIOps

As a tenant administrator, perform the following steps to integrate with Dynatrace, verify the integration, and view the collected data in various BMC products.

Plan for the connection

• Based on whether you have Helix subscription or the BMC Helix IT Operations Management on premises entitlement, choose the BMC Helix Intelligent Integrations deployment mode. For information about various deployment modes, see Deployment scenarios.

• To access the Dynatrace APIs required for the integration, generate an API token with the following scopes. For more information, see Dynatrace API - Tokens and authentication.
  • API v2:
    
    • entities.read
    • events.read
    • extensions.read
    • logs.read
    • metrics.read
    • networkZones.read
    • problems.read
    • releases.read 
    • securityProblems.read
    • slo.read
  • API v1:
    • DataExport
      
• Obtain the following details for Dynatrace from which you want to collect data: 
  • Host name
  • 80 (HTTP), 443 (HTTPS), or proxy port (if applicable)
  • Valid token id to access the API

To integrate with Dynatrace

1. In BMC Helix Intelligent Integrations, on the CONNECTORS  tab, click in the SOURCES panel.

2. Click Dynatrace.
3. Specify the following details for the source connection:

   1. Specify a unique instance name. 

      Recommendation

      We recommend that you specify the instance name in the following format: 

      <sourceType>_<sourceControllerServerName>{_<InstanceQualifier>}                    

      The instance qualifier helps you to distinguish the multiple instances configured from the same source server. For example, you can name your instances as Dynatrace_Host_PROD, Dynatrace_Host_TEST, and so on.

   2. Specify the Dynatrace host name and port number (default value is 443).

   3. Ensure that the HTTPS check box is selected to indicate that you plan to use an https connection to the Dynatrace host.
      

      Caution

      We recommend that you do not select the Allow Unsigned Certificate option in a production environment.  You might want to select this option to allow unsigned certificates in a test environment. See the Dynatrace  documentation to learn how to install SSL certificates.

      
      

   4. Specify the number of maximum concurrent REST API requests that should be executed during a collection schedule (default value is 5).
   5. Specify the time, in seconds, after which no attempt should be made to establish a connection (default value is 30).
   6. Specify a valid token id to access the API. Ensure that the token has the required permissions to access the API. For more information, see  Dynatrace API - Tokens and authentication. .
   7. (On-premises only) The Environment ID is similar to the Account ID. Leave this field blank for SaaS implementations.
   8. Click Proxy and specify if you want to configure a proxy server. If yes, specify the host name and port number (default value is 8888).
4. Click VALIDATE AND CREATE.
   The specified connection details are validated and the corresponding source connection is created in the Source Connection list.

5. Select the source connection that you created from the list if it is not selected already.

6. Do one of the following depending on the BMC Helix Intelligent Integrations deployment type you are using:

   BMC Helix Intelligent Integrations deployment mode	Proxy used	Destination created already	Action
   Helix subscription	No	Yes Created when a tenant is configured.	Skip to step 8.
   Helix subscription with on-premises gateway	Yes	Yes Created when you import the ade-default-destination-min.json file by using the Backup/Restore option.	Skip to step 8.
   On-premises gateway	No	No	Create the destination connection by performing the instructions in step 7.

7. Click the BMC Helix tile, and specify the following details to create the destination connection:
   
   1. Specify the host name and port number (default is 443) to connect to the BMC Helix applications.

   2. Specify the HTTP or HTTPS port number depending on the connection protocol (default port number is 443).

   3. Select the HTTPS option to use an https connection to the BMC Helix applications.
   4. Specify the number of maximum concurrent REST API requests that should be executed during a data collection schedule (default value is 5).

   5. Specify the access key and secret key required to the access the BMC Helix applications.
      For instructions about how to generate the access key and secret key, see Setting up access keys for programmatic access.

      Important

      The keys are generated in the following format: key:<access key>::<secret key>,tenant id: <tenant ID>. Enter <access key> and <secret key> as the values of the accessKey and accessSecretKey parameters.

      The access key and secret key must have the Administrators group and the Administrator role assigned.

   6. Specify the tenant ID.
      Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id: <tenant ID>) that you generated earlier.

8. Clear the options for which you don't want to collect data.

9. Click a data type and specify the configuration parameters in the Collectors section as described in the following table:

   Parameter name and description	Data Type
   	Dynatrace Managed Events (not available in versions 23.1.01 and later)	Dynatrace Managed Alerts	Dynatrace Managed Metrics	Dynatrace Managed Topology
   Collection Schedule Specify the data collection frequency (in minutes). Default: 5 minutes Example: Collection Schedule is set to 5 mins.  Current time is 00:30. If you run the collector just after 00:30, data is collected every 5 mins, first at 00:30 and next at 00:35, and so on. For more information about how this parameter affects data collection, see Data collection schedule.
   Data Collection Window Specify the historical time period (in minutes) from the current time for which the data should be collected from Dynatrace.  Default: 5 minutes Example: Collection Schedule is set to 5 mins. Data Collection Window is set to 5 mins. Current time is 00:30. If you run the collector just after 00:30, data is collected first at 00:30 for the interval, 00:25 - 00:30, and next at 00:35 for the interval, 00:30 - 00:35, and so on. For more information about how this parameter affects data collection, see Data collection window.
   Data Latency Specify the time (in minutes) by which the data time window should be shifted back on the timeline. This parameter is useful in delayed data availability situations. Default: 60 minutes Example: Collection Schedule is set to 5 mins. Data Collection Window is set to 10 mins. Data Latency is set to 2 mins. Current time is 00:30. If you run the collector just after 00:30, data is collected first at 00:30 for the interval, 00:18 to 00:28 and next at 00:35 for the interval, 0:23 to 00:33, and so on. For more information about how this parameter affects data collection, see Data latency.
   Applications Select one or more applications from the list.  This list is updated automatically from Dynatrace.
   Hosts Select one or more hosts from the list.  This list is updated automatically from Dynatrace.
   Process Groups Select one or more process groups from the list.  This list is updated automatically from Dynatrace.
   Processes Select one or more processes from the list.  This list is updated automatically from Dynatrace.
   Services Select one or more services from the list. This list is updated automatically from Dynatrace.
   Impacts Select one or more alert impact status from the list.
   Severities Select one or more alert severities from the list.
   Statuses Select the alert status from the list.
   Metric Categories Select all or a subset of metric categories from the list. This list is updated automatically from Dynatrace .
   Application Tags and Applications Use these lists to collect metrics for the applications having specific tags or all applications (default). These lists are updated automatically from Dynatrace. Do the following to collect metrics for the applications having tags: Select tags from the Application Tags list. Note: Tags are meant only for restricting the number of applications to be displayed in the Applications list. Metrics are collected based on the applications you select in the Applications list. Remove the All Applications option from the Application Tags list. The Applications list is populated with the applications that have the selected tags. Do one of the following: Select the applications one by one for which you want to collect metrics. Select the Select All option to display the applications having the selected tags and then, remove All Applications from the list. Else, the metrics for all the applications are collected. Note: If you select All Applications, the tags you have selected from the Application Tags list are not considered and metrics for all the applications are collected. Do the following to collect metrics for all applications (default): Ensure that All Applications is selected the Application Tags list. Ensure that All Applications is selected the Applications list.
   Service Tags and Services Use these lists to collect metrics for the services having specific tags or all services (default). These lists are updated automatically from Dynatrace. Do the following to collect metrics for the services having tags: Select tags from the Service Tags list. Note: Tags are meant only for restricting the number of services to be displayed in the Services list. Metrics are collected based on the services you select in the Services list. Remove the All Services option from the Service Tags list. The Services list is populated with the services that have the selected tags. Do one of the following: Select the services one by one for which you want to collect metrics. Select the Select All option to display the services having the selected tags and then, remove All Services from the list. Else, the metrics for all the services are collected. Note: If you select All Services, the tags you have selected from the Service Tags list are not considered and metrics for all the services are collected. Do the following to collect metrics for all services (default): Ensure that All Services is selected the Service Tags list. Ensure that All Services is selected the Services list.
   Host Tags and Hosts Use these lists to collect metrics for the hosts having specific tags or all hosts (default). These lists are updated automatically from Dynatrace. Do the following to collect metrics for the hosts having tags: Select tags from the Host Tags list. Note: Tags are meant only for restricting the number of hosts to be displayed in the Hosts list. Metrics are collected based on the hosts you select in the Hosts list. Remove the All Hosts option from the Host Tags list. The Host list is populated with the hosts that have the selected tags. Do one of the following: Select the hosts one by one for which you want to collect metrics. Select the Select All option to display the hosts having the selected tags and then, remove All Hosts from the list. Else, the metrics for all the hosts are collected. Note: If you select All Hosts, the tags you have selected from the Host Tags list are not considered and metrics for all the hosts are collected. Do the following to collect metrics for all hosts (default): Ensure that All Hosts is selected the Host Tags list. Ensure that All Hosts is selected the Hosts list.
   Process Tags and Processes Use these lists to collect metrics for the processes having specific tags or all processes (default). These lists are updated automatically from Dynatrace. Do the following to collect metrics for the processes having tags: Select tags from the Process Tags list. Note: Tags are meant only for restricting the number of processes to be displayed in the Processes list. Metrics are collected based on the processes you select in the Processes list. Remove the All Processes option from the Process Tags list. The Processes list is populated with the processes that have the selected tags. Do one of the following: Select the processes one by one for which you want to collect metrics. Select the Select All option to display the processes having the selected tags and then, remove All Processes from the list. Else, the metrics for all the processes are collected. Note: If you select All Processes, the tags you have selected from the Process Tags list are not considered and metrics for all the processes are collected. Do the following to collect metrics for all processes (default): Ensure that All Processes is selected the Process Tags list. Ensure that All Processes is selected the Processes list.
   Process Group Tags and Process Groups Use these lists to collect metrics for the process groups having specific tags or all process groups (default). These lists are updated automatically from Dynatrace. Do the following to collect metrics for the process groups having tags: Select tags from the Process Group Tags list. Note: Tags are meant only for restricting the number of process groups to be displayed in the Process Groups list. Metrics are collected based on the process groups you select in the Process Groups list. Remove the All Process Groups option from the Process Group Tags list. The Process Groups list is populated with the process groups that have the selected tags. Do one of the following: Select the process groups one by one for which you want to collect metrics. Select the Select All option to display the process groups having the selected tags and then, remove All Process Groups from the list. Else, the metrics for all the process groups are collected. Note: If you select All Process Groups, the tags you have selected from the Process Group Tags list are not considered and metrics for all the process groups are collected. Do the following to collect metrics for all process groups (default): Ensure that All Process Groups is selected the Process Group Tags list. Ensure that All Process Groups is selected the Process Groups list.
   V2 Metrics Select all or a subset of V2 metrics from the list. If you don't select any metrics, data for all the V2 metrics is collected. This list is updated automatically from Dynatrace.
   Use V2 API Select this option for compatibility with earlier versions of Dynatrace.
   Extract these entity types Select one or more entity types from the list.

10. Click CREATE COLLECTORS to create the required collector streams for the selected data types.

11. Click a data type and specify the configuration parameters in the Distributors section as described in the following table:
    

    Parameter name and description
    Max Batching Size Specify the maximum number of data items to send in a single POST request to the destination API. The batch size depends on the destination’s ability to buffer the incoming data. Default: 250
    Max Batching Delay Specify the maximum time (in seconds) to wait before building a batch and processing. Default: 3 seconds
    Base Retry Delay Specify the initial time (in seconds) for which to wait before retrying to build a batch and processing. The waiting time increases in the following sequence: n1, n2, n3, and so on, where n indicates the number of seconds. Default: 2 seconds Example: Base Retry Delay is set to 2 seconds. Retry is performed after 2, 4, 8, 16, ... seconds.
    Max Intra-Retry Delay Specify the maximum limit for the base retry delay.  Default: 60 seconds Example: Max Intra-Retry Delay is set to 60 seconds. Base Retry Delay is set to 2 seconds. Retries are performed 2, 4, 8, 16, 32, 64,... seconds later again.
    Max Retry Duration Specify the total time for retrying a delivery. For REST destinations, a delivery is a batch of data items in one POST request.  Default: 5 minutes Example: Max Retry Duration is set to 8 hours. Base Retry Delay is set to 2 seconds. Requests are sent for 2+4+8+16+32+64+132... until 8 hours in total duration is reached. After that, no subsequent attempts are made to retry the delivery. The assumption here is that if there is an outage or other issue with the destination tool, recovery should take less than the value of the Max Retry Duration parameter to be completed.

12. Click CREATE DISTRIBUTORS to create the required distributor streams for the selected data types.
13. Click one of the following buttons:
    
    • SAVE STREAM : Click this button if you want to edit the integration details before creating the instance. After you save the stream, the connector that you just created is listed in the SOURCES panel. Move the slider to the right to start the data stream.
    • SAVE AND START STREAM : Click this button if you want to save the integration details and start receiving data immediately.

          For more information about data streams, see Starting or stopping data streams .

To verify the integration

In BMC Helix Intelligent Integrations , on the SOURCES panel, confirm that the data streams for the integration you created are running. Data streaming is indicated by moving colored arrows.

• Moving dark blue arrows () indicate that event and alert streams are running. Event and alert data will be pushed according to the configured Collection Schedule interval.
• A moving red arrow () indicates that the metric stream is running. Metric data will be pushed according to the configured Collection Schedule interval.
• A moving light blue arrow () indicates that the topology stream is running. Topology data will be pushed according to the configured Collection Schedule interval.

To view events in BMC Helix Operations Management

In BMC Helix Operations Management, select Monitoring > Events to view the events received from Dynatrace.

Incoming events from Dynatrace are processed in BMC Helix Operations Management through a set of deduplication rules to determine whether the incoming event is a duplicate event or a new event. For more information, see Event deduplication and suppression for reducing event noise.

For information about events, see Monitoring and managing events .

To view metrics in BMC Helix Operations Management

1. In BMC Helix Operations Management, select Monitoring > Devices.
2. Click the links for the required device.
3. On the Monitors tab, click the required monitor.
   The Performance Overview tab shows the metrics graph. For information about metrics, see Viewing collected data .

To view the topology data in BMC Helix Discovery

In BMC Helix Discovery, select Explore > Data, and click <count> Import Records in the Miscellaneous section. The Import Record List page shows the CI records received from Dynatrace. For information about records, see Managing your IT infrastructure .

To view services and situations in BMC Helix AIOps

Before you view services and situations in BMC Helix AIOps, create a Business Service model in BMC Helix Discovery. For information about creating models, see Creating a model .  

In BMC Helix AIOps, on the Overview page, view the services and situations for the event and topology data received from Dynatrace.