Creating Dynatrace integrations

Creating Dynatrace integrations

There are three data collection methods that can be used when creating Dynatrace integrations. The first method outlined here shows how to gather metric data only, while the second shows a new method of gathering both metric and event data together. Note that metric and event data collection is available only for technology preview, and is not for production usage. The third method is for collecting topology data.

• Method 1: Metric-only data collection
• Method 2: Metric, event, and topology data collection
• Method 3: Topology-only data collection

Method 1: Metric-only data collection

To create a Dynatrace integration, collecting metric data only, complete the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. On the Integrations page, click Add integration.

4. From the list of all integrations, find and click the Dynatrace tile.

   Note: If you do not immediately see Dynatrace, you can filter the tiles by type of integration. Click the type of integration that you want in the Category section, or alternatively start typing Dynatrace in the search bar and the Dynatrace tile appears.

5. On the side-panel, review the instructions and select your required options from the following sections:

   • Select the data types that you need to collect: In this case select the Metrics checkbox, and not Events or Topology.

   • Specify whether you'd like to install the integration: Select between the Cluster running Cloud Pak for AIOps or Self-hosted with network visability to Dynatrace radio buttons.

   • Select Cloud Pak for AIOps integration: Deselect the Use the integration recommended by Cloud Pak for AIOPs checkbox.

   • Select the Metrics option at the top.

     

6. Then, click Next.

   You see an Overview, further direction such as what you need to have ready and also what AI algorithms analyze Dynatrace data information.

7. Click Get Started.

8. On the Add integration page, define the following general integration details:

   • Name: The display name of your integration. You cannot use spaces or special characters in the display name. Use only alphanumeric characters.

   • Description: An optional description for the integration.

   • Endpoint: Dynatrace data source base url, for example https://<your-environment-id>.live.dynatrace.com.

   • Access Token (API key): Enter an API key for the integration.

     

   • Tags (optional): Enter a comma-separated list of tags used to filter the entities for the integration.

     Note: It is recommended to configure Tags in order to collect data only for tags you are interested in.

   • Deployment options: Select between Local and Remote radio buttons.

     • Local: Install the integration in the same cluster and namespace where Cloud Pak for AIOps is installed.

     • Remote: Install the integration anywhere you choose, for example in a different network region, on SaaS, or remote on-premises (VM, cluster, container, and so on).

       Note: If you select Remote, you are be provided with a remote deployment script to establish your integration after adding it.

9. To verify the SSL/TLS configuration:

   1. Set the Verify the SSL/TLS certificate for the REST service toggle to on.
   2. Either enter a CA certificate used to verify the SSL/TLS integration to the REST service or click Fetch SSL certificate to fetch the certificate automatically.

10. Click Test connection. It is best to wait for the test to succeed before continuing to the next step. This can take some time.

    

11. Click Next.

12. On the Configure Proxy (Optional) page complete the following fields:

    • Connect to Dynatrace via a proxy server: Set the toggle button to on.

    • URL of HTTP proxy server: Enter a URL for the HTTP proxy server. Note: The URL for the metrics-only integration should have the protocol in the URL.

    • Port number of proxy server: Enter a port. The default is 8080.

      

    Note: Only unauthenticated HTTP proxy is supported.

13. Click Next.

14. Enter the following Collect metric data to define how you want to collect metric data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Select technologies to view the associated metrics: From this dropdown menu you can click the Select all technologies checkbox, or pick and choose technologies from the list as you need. You then see a list of all built-in metrics names for the options you selected. You can leave all checked or pick and choose from the list by clicking in the respective checkbox to deselect particular metrics for a technology. It is recommended to only select the metrics that are needed.

      

    • Aggregation intervals (minutes): The frequency at which data is collected. The default is 5.

    • Only collect live data once the integration is established: Click this checkbox if you want to only collect live data, as you are not be able to collect historical data after live data collection has started. If unchecked you are able to collect historical data.

      Note: The recommended time period for collecting historical metric data is two weeks. You can collect up to 31 days of historical data so your start date should not exceed 31 days from the present. If the end date is not specified, Cloud Pak for AIOps collects historical data from the specified start date and continue with live data collection. You are not be able to collect historical data after live data collection has started.

    • Start date: Enter in the format mm/dd/yyyy.

    • Start time: Enter in the format hh:mm.

    • Timezone: Set to local time.

    • Add End Date: click the Add End Date button if you want to set an end date.

15. Click Done.

Note: The API limit can cause a delay in receiving metrics from Dynatrace. Each Dynatrace token is limited to 50 API requests per minute. Multiple API requests might be needed for each metric data collection interval based on the amount of data that Dynatrace returns. If the required requests to the API exceed the limit, the metrics-only integration throttles the requests until more requests are available in the next minute. Review the performance considerations for metric integrations and the filtering options available to optimize this behavior. For more information, see Performance considerations for metric data collection.

A message appears to indicate that the integration is complete, and that IBM Cloud Pak for AIOps has successfully created your Dynatrace integration and will start collecting data shortly.

Method 2: Metric, event, and topology data collection

To create a Dynatrace integration collecting metric and event data together, complete the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. On the Integrations page, click Add integration.

4. From the list of all integrations, find and click the Dynatrace tile.

   Note: If you do not immediately see Dynatrace, you can filter the tiles by type of integration. Click the type of integration that you want in the Category section, or alternatively start typing Dynatrace in the search bar and the Dynatrace tile appears.

5. On the side-panel, review the instructions and select your required options from the following sections:

   • Select the data types that you need to collect: Select the relevant checkbox from Metrics, Events, or Topology, which in this case is Metrics, Events or Topology.

   • Specify whether you'd like to install the integration: Select between the Cluster running Cloud Pak for AIOps or Self-hosted with network visability to Dynatrace radio buttons.

   • Select Cloud Pak for AIOps integration: You can leave this at the recommended default Use the integration recommended by Cloud Pak for AIOps, which collects both metric and event data.

     

     Important: Depending on which of the data types that you choose to collect the following sections vary. This integration does not support historical data collection. However it is worth noting that if did select Topology you would be brought to a New observer job page. Using the Dynatrace observer, you can query a specified Dynatrace environment for information about its applications, services, process groups, and infrastructure entities. For more information, see Configuring a Dynatrace Observer job.

6. Then, click Next.

   You see an overview, further direction such as what you need to have ready and also what algorithms analyze Dynatrace data information.

7. Click Get Started.

8. On the Add integration page, define the following general integration details:

   • Name: The display name of your integration. You cannot use spaces or special characters in the display name. Use only alphanumeric characters.

   • Description: An optional description for the integration.

   • Endpoint: Dynatrace data source base url, for example https://<your-environment-id>.live.dynatrace.com.

   • Dynatrace zone (optional): Enter a single Dynatrace zone to monitor for the integration.

   • Tags (optional): Enter a comma-separated list of tags used to filter the entities for the integration.

     Note: It is recommended to configure one of either Dynatrace zone or Tags in order to collect data only for tags or management zones you are interested in.

   • Deployment options: Select between Local and Remote radio buttons.

     • Local: Installs the integration in the same cluster and namespace where Cloud Pak for AIOps is installed.

     • Remote: Installs the integration anywhere you choose, for example, a different network region, on SaaS, or remote on-premises (VM, cluster, container, and so on) and enter a name in the Installation name field.

       Important: Podman must be installed to execute the remote deployment script with a recommended minimum version of 4.4.1. Read and write access is required for the folder where the remote deployment script is executed and the script also must have execution permissions in order to be run. No more than one remote deployment script should be executed per host.

9. Click Next.

10. On the Authentication page, define the following general integration details:

    • Authentication: Select between the Hashicorp Vault and Access token (API key) radio buttons.

      

    If you select Access token (API key) you need to enter an API key for the integration, and if you select Hashicorp Vault you need to complete the following fields:

    • Endpoint (URL): Endpoint URL of the Hashicorp Vault server instance.

    • HashiCorp Vault access token: Enter a Hashicorp Vault access token for this integration.

    • HashiCorp Vault secret path: Enter a Hashicorp Vault secret path for this integration.

    • CA HTTPS Certificate: Enter a CA certificate used for HTTPS with Hashicorp Vault.

    • HashiCorp Vault secret refresh rate: The HashiCorp Vault secret is refreshed automatically at a fixed hourly interval. The default refresh rate is every 24 hours.

      Note: Only HTTPS for Vault is supported, and not HTTP.

11. Click Next.

12. Enter the following Collect metric data (optional) to define how you want to collect metric data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Select technologies to view the associated metrics: From this dropdown menu you can click the Select all technologies checkbox, or pick and choose technologies from the list as you need. You then see a list of all built-in metric names for the options you selected. You can leave all checked or pick and choose from the list by clicking in the respective checkbox to deselect particular metrics for a technology. It is recommended to only select the metrics that are needed.

    • Polling interval (seconds): The frequency at which data is collected (in seconds). The default value is 300.

      

13. Click Next.

14. Enter the following Collect event data (optional) to define how you want to collect event data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Select technologies to view the associated events: From this dropdown menu you can click the Select all technologies checkbox, or deselect this, and pick and choose from the list as you need. You then see a list of Event names for the technologies you selected. You can leave all checked or pick and choose from the list by clicking in the respective checkbox. It is recommended to only select the events that are needed.

    • Polling interval (seconds): The frequency at which data is collected (in seconds). The default value is 60.

15. Click Done.

A message appears to indicate that the integration is complete, and that IBM Cloud Pak for AIOps has successfully created your Dynatrace integration and will start collecting data shortly.

Method 3: Topology-only data collection

To create a Dynatrace integration, collecting topology data, complete the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. On the Integrations page, click Add integration.

4. From the list of all integrations, find and click the Dynatrace tile.

   Note: If you do not immediately see Dynatrace, you can filter the tiles by type of integration. Click the type of integration that you want in the Category section, or alternatively start typing Dynatrace in the search bar and the Dynatrace tile appears.

5. On the side-panel, review the instructions and select your required options from the following sections:

   • Select the data types that you need to collect: In this case select the Topology checkbox.

   • Specify whether you'd like to install the integration: Select between the Cluster running Cloud Pak for AIOps or Self-hosted with network visability to Dynatrace radio buttons.

   • Select Cloud Pak for AIOps integration: Deselect the Use the integration recommended by Cloud Pak for AIOPs checkbox.

   • Select the Topology option at the bottom.

     

6. Then, click Next.

   You see an Overview, further direction such as what you need to have ready and also what AI algorithms analyze Dynatrace data information.

7. Click Get Started.

8. On the Add integration page, define the following general integration details:

   • Name: The display name of your integration. You cannot use spaces or special characters in the display name. Use only alphanumeric characters.

   • Description: An optional description for the integration.

   • Endpoint: Dynatrace data source base url, for example https://<your-environment-id>.live.dynatrace.com.

   • Dynatrace zone (optional): Enter a single Dynatrace zone to monitor for the integration.

   • Tags (optional): Enter a comma-separated list of tags used to filter the entities for the integration.

     Note: It is recommended to configure one of either Dynatrace zone or Tags in order to collect data only for tags or management zones you are interested in.

   • Deployment options: Select between Local and Remote radio buttons.

     • Local: Installs the integration in the same cluster and namespace where Cloud Pak for AIOps is installed.

     • Remote: Installs the integration anywhere you choose, for example, a different network region, on SaaS, or remote on-premises (VM, cluster, container, and so on) and enter a name in the Installation name field.

       Important: Podman must be installed to execute the remote deployment script with a recommended minimum version of 4.4.1. Read and write access is required for the folder where the remote deployment script is executed and the script also must have execution permissions in order to be run. No more than one remote deployment script should be executed per host.

9. Click Next.

10. On the Authentication page, define the following general integration details:

    • Authentication: Select between the Hashicorp Vault and Access token (API key) radio buttons.

      

    If you select Access token (API key) you need to enter an API key for the integration, and if you select Hashicorp Vault you need to complete the following fields:

    • Endpoint (URL): Endpoint URL of the Hashicorp Vault server instance.

    • HashiCorp Vault access token: Enter a Hashicorp Vault access token for this integration.

    • HashiCorp Vault secret path: Enter a Hashicorp Vault secret path for this integration.

    • CA HTTPS Certificate: Enter a CA certificate used for HTTPS with Hashicorp Vault.

    • HashiCorp Vault secret refresh rate: The HashiCorp Vault secret is refreshed automatically at a fixed hourly interval. The default refresh rate is every 24 hours.

      Note: Only HTTPS for Vault is supported, and not HTTP.

11. Click Next.

12. On the Configure Proxy (Optional) page complete the following fields:

    • Connect to Dynatrace via a proxy server: Set the toggle button to on.

    • URL of HTTP proxy server: Enter a URL for the HTTP proxy server. Note: The URL for the metrics-only integration should have the protocol in the URL.

    • Port number of proxy server: Enter a port. The default is 8080.

      

13. Click Next.

14. Enter the following Collect metric data (optional) to define how you want to collect metric data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Select technologies to view the associated metrics: From this dropdown menu you can click the Select all technologies checkbox, or pick and choose technologies from the list as you need. You then see a list of all built-in metric names for the options you selected. You can leave all checked or pick and choose from the list by clicking in the respective checkbox to deselect particular metrics for a technology. It is recommended to only select the metrics that are needed.

    • Polling interval (seconds): The frequency at which data is collected (in seconds). The default value is 300.

      

15. Click Next.

16. Enter the following Collect event data (optional) to define how you want to collect event data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Select technologies to view the associated events: From this dropdown menu you can click the Select all technologies checkbox, or deselect this, and pick and choose from the list as you need. You then see a list of Event names for the technologies you selected. You can leave all checked or pick and choose from the list by clicking in the respective checkbox. It is recommended to only select the events that are needed.

    • Polling interval (seconds): The frequency at which data is collected (in seconds). The default value is 60.

17. Click Next.

18. Enter the following Collect topology data (optional) to define how you want to collect topology data:

    • Enable data collection: Set the Enable data collection toggle button to on.

    • Cloud Pak for AIOps topology entity selector: This mapping configures the entities and filters used to ingest topology data from Dynatrace to Cloud Pak for AIOps. The entity selector from the Observer Jobs UI can be used in this field.

    • Data collection mode: Select between the Collect topology data continuously at a specified time interval and Collect topology data once radio buttons.

    • Schedule topology data collection: Select between the Start data collection after creating the integration and Start data collection at a scheduled date and time radio buttons.

    • Time interval of data collection: Specify how frequently to run the topology data collection.

    • Unit of time: Specify the unit of time for topology data collection.

    • Number of records to be fetched per page: Specify a value between 100 and 4000. The default value is 4000.

    • Cloud Pak for AIOps topology edge mapping (optional): This mapping defines the relationship between the Cloud Pak for AIOps topology edges and Dynatrace. Cloud Pak for AIOps will use a default mapping for edges by default, but edge mapping values can be overrided in this field.

    • Cloud Pak for AIOps entity mapping (optional): This mapping defines the relationship between the Cloud Pak for AIOps topolopy entities and Dynatrace entity types. Cloud Pak for AIOps will use a default mapping for the entity relationship by default, but the entity types can be overrided in this field.

    • Grouping vertex preference (optional): Cloud Pak for AIOps will create a defined topology for the discovered vertices. By default, there is no grouping vertex preference.

    • Connection timeout (optional): The connection timeout for the topology collection in milliseconds. The default is 5000 milliseconds.

    • Access scope (optional): The access scope provides the scope for the topology resources. The access scope can be used to aid the mapping of alerts to resources when resources in different scopes share the same matchTokens. Examples of scope would be locations, project names, or namespaces.

19. Click Done.

A message appears to indicate that the integration is complete, and that IBM Cloud Pak for AIOps has successfully created your Dynatrace integration and will start collecting data shortly.

Enabling and disabling Dynatrace integrations

If you didn't enable your data collection during creation, you can enable your integration afterward. You can also disable a previously enabled integration the same way. To enable or disable a created integration, complete the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. On the Manage integrations tab of the Integrations page, click the Dynatrace integration type.

4. Click the integration that you want to enable or disable.

5. Go to the Collect metric data section for the metrics-only Dynatrace integration, or indeed for the combined events and metrics integration go to both the Collect metric data and Collect event data sections. Set Enable data collection to On or Off to enable or disable data collection. Disabling data collection for an integration does not delete the integration.

You enabled or disabled your integration. For more information about deleting an integration, see Deleting Dynatrace integrations.

Editing Dynatrace integrations

After you create your integration, your can edit the integration by completing the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. Click the Dynatrace integration type on the Manage integrations tab of the Integrations page.

4. On the Dynatrace integrations page, click the name of the integration that you want to edit. Alternatively, you can click the options menu (three vertical dots) for the integration and click Edit. The integration configuration opens.

5. Edit your integration as required. Click Save when you are done editing.

   

Your integration is now edited. If your application was not previously enabled or disabled, you can enable or disable the integration directly from the interface. For more information about enabling and disabling your integration, see Enabling and disabling Dynatrace integrations. For more information about deleting an integration, see Deleting Dynatrace integrations.

Deleting Dynatrace integrations

If you no longer need your Dynatrace integration and want to not only disable it, but delete it entirely, you can delete the integration from the console.

To delete an integration, complete the following steps:

1. Log in to IBM Cloud Pak for AIOps console.

2. Expand the navigation menu (four horizontal bars), then click Define > Integrations.

3. Click the Dynatrace integration type on the Manage integrations tab of the Integrations page.

4. On the Dynatrace integrations page, click the options menu (three vertical dots) for the integration that you want to delete and click Delete, or alternatively click the dustbin icon.

5. Enter the name of the integration to confirm that you want to delete your integration. Then, click Delete.

Your integration is deleted.