Integrating with Dynatrace via webhook

Dynatrace uses webhook to push real-time alerts about problems detected in the environment. Whenever Dynatrace detects any problem, its webhook triggers an HTTP POST request to send alerts to a target URL.

Configure an integration with Dynatrace to receive alerts via webhook in BMC Helix Intelligent Integrations and monitor them as events. As a tenant administrator, you can optimize the performance, availability, reliability, and reachability of the applications in a IT network.

Related topics

Supported-out-of-the-box-integrations-for-BMC-Helix-Intelligent-Integrations

Editing-and-deleting-integrations

Event-deduplication-and-suppression-for-reducing-event-noise

Integrating-with-Dynatrace-via-API

You can view the collected data in various BMC Helix application and derive the following benefits:

BMC Helix application

Type of data collected or viewed

Benefits

BMC Helix Operations Management

Events (Dynatrace alerts are received as events) 

Use a centralized event view to monitor and manage events, perform event operations, and filter events. Identify actionable events from a large volume of event data by processing events.

For more information, see Monitoring events and reducing event noise.

Important

You can also configure the BMC Helix Intelligent Integrations Dynatrace connector to collect alert, metric, and topology data from Dynatrace by using APIs. For the alert and topology data received from Dynatrace, you can view the services and situations in BMC Helix AIOps. For more information, see Integrating-with-Dynatrace-via-API.


As a tenant administrator, perform the following steps to configure a connection with Dynatrace, verify the connection, and view the alerts received as events in various BMC Helix applications.

Connector steps.png

Planning for the connection

  • Depending on the location (SaaS, on-premises) of the third-party product, choose one or more BMC Helix Intelligent Integrations deployment modes and review the corresponding port requirements. For information about various deployment modes and port requirements, see Deployment-scenarios.
  • Based on the deployment modes, use the BMC Helix Intelligent Integrations SaaS deployment or the BMC Helix Intelligent Integrations on-premises gateway or both. For more information about the gateway, see Deploying-the-BMC-Helix-Intelligent-Integrations-on-premises-gateway.

In the preceding list, third-party product refers to Dynatrace.


Configuring the connection with Dynatrace via webhook

  1. Access BMC Helix Intelligent Integrations:
    • BMC Helix Intelligent Integrations SaaS – Log on to BMC Helix Portal, and click Launch on BMC Helix Intelligent Integrations.
    • BMC Helix Intelligent Integrationson-premises gateway – Use one of the following URLs to access BMC Helix Intelligent Integrations:
      • http://<hostName>:<portNumber>/swpui
      • https://<hostName>:<portNumber>/swpui
  2. On the CONNECTORS tab, clickadd_icon.pngin the SOURCES panel.
  3. Click the Dynatrace Alerts Webhook tile.

  4. Specify a unique instance name.

    Best practice
    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 DynatraceAlertsWebhook_Host_PROD, DynatraceAlertsWebhook_Host_TEST, and so on.

  5. Click CREATE COLLECTORS to create the collector stream for the selected data type.
  6. Configure the distributors for the selected data type by clicking the data type in the Distributors section and specifying the parameters for the selected data type, as explained in the following table:
  1. Click CREATE DISTRIBUTORS to create the required distributor stream for the selected data type.
  2. Click VALIDATE AND CREATE and then click SAVE STREAM to save the stream.
    After you save the stream, the connector that you just created is listed on the SOURCES panel.
  1. On the SOURCES panel, click Configure Mediator ConfigureMediator_icon.pngfor the source connection that you created.
  2. Depending on whether you are using only SaaS deployment of BMC Helix Intelligent Integrationsor BMC Helix Intelligent Integrationson-premises gateway, perform the following steps:
    • If you are using only SaaS deployment of BMC Helix Intelligent Integrations, do the following:
      1. Click copy copy_URL.pngto copy the auto-generated Dynatrace collector URL and save the URL in a temporary file.
        For example, https://hostA/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdf?token=API-KEY

      2. Log on to BMC Helix Portaland generate an API key.
        For more information, see Setting up access keys for programmatic access. 

      3. Copy the generated API key and save it in a temporary file.
        The key is generated in the format: <accessKey>::<secretKey>::<tenantID>.
        For example, Y4B0OSC49QZA11Q8A1H9H6::MnVLk69TNyCEponsthHJ1Hj1uKcjTB::385261281
      4. Change the format of the API key to <tenantID>::<accessKey>::<secretKey>.
        For example, 385261281::SC49QZA11Q8A1H9H6::MnVLk69TNyCEponsthHJ1Hj1uKcjTB 
      5. In a temporary file, modify the auto-generated Dynatrace webhook URL by replacing API-KEY with the API key that you formatted in the previous step.
        For example, https://host.ab.com/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdfd?token=385261281::SC49QZA11Q8A1H9H6::MnVLk69TNyCEponsthHJ1Hj1uKcjTB.
      6. Configure webhook to forward alerts data to BMC Helix Intelligent Integrations.

    • If you are using the BMC Helix Intelligent Integrationson-premises gateway, do the following:
      1. Click copy copy_URL.pngto copy the auto-generated Dynatrace collector URL and save the URL in a temporary file.
        For example, http://hostA/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdf
      2. (If you are using HTTP port to access the UI) Update the URL to include port 7457 if you are using port 80 to access the UI.
        For example, http://hostA:7457/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdf

      3. (If you are using HTTPS port to access the UI) Update the URL to include port 7443 if you are using port 443 to access the UI.
        For example, https://hostA:7443/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdf

      4. Configure Dynatrace to forward alerts data to BMC Helix Intelligent Integrationsvia webhook.
  3. On the SOURCES panel, move the slider to the right to start the data stream for the connector you created in step 8.


To configure Dynatrace to push alerts to BMC Helix Intelligent Integrations via webhook

  1. Log on to Dynatrace, and from the menu select Manage > Settings.
  2. On the Settings page, scroll down to expand the Integration option and select Problem notifications.
  3. On the Problem notifications page, click Add notification.
  4. Depending on whether you are using only SaaS deployment of BMC Helix Intelligent Integrationsor BMC Helix Intelligent Integrationson-premises gateway, perform the following steps:
    • For SaaS deployment of BMC Helix Intelligent Integrations, copy the webhook URL that you modified in step 10 (e) and paste it as the default value of the Webhook URL field.
    • For BMC Helix Intelligent Integrationson-premises gateway, copy the webhook URL that you saved in step 10 (b) or step 10 (c) and paste it as the default value of the Webhook URL field.
  5. Ensure that the Call webhook if problem is closed option is selected.

  6. Specify the notification format and content in the Custom payload field. Whenever any vulnerability is detected or resolved in Dynatrace, the custom payload is sent through an HTTP POST to BMC Helix Intelligent Integrations:

    {
    "state":"{State}",
    "problemId":"{ProblemID}",
     "problemURL":"{ProblemURL}",
    "problemDetailsMarkdown":"{ProblemDetailsMarkdown}",
    "ProblemDetailsJSON":{ProblemDetailsJSON},
     "ProblemDetailsJSONv2":{ProblemDetailsJSONv2}
    }

  7. Click Save Changes.
  8. (Optional) Click Send test notification to verify whether Dynatrace webhook can push the sample payload to BMC Helix Intelligent Integrations.


Verifying the connection

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.

DynatraceWebhook_Stream.png

A moving dark blue arrow (EventsStream_Icon.png) indicates that event stream is running. Event data will be pushed as soon as alerts are available.


Viewing data in BMC Helix applications

Important

If the event or metric data is ingested by using BMC Helix Intelligent Integrations, and the topology data is ingested through some other means, all the use cases in BMC Helix AIOps might not work as expected because the external IDs generated by BMC Helix Intelligent Integrations and BMC Helix Discovery differ. In addition, host name might differ in both the products. 

To view events in BMC Helix Operations Management

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

Incoming event from are processed in BMC Helix Operations Managementthrough 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.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*