Creating New Relic integrations

Creating New Relic integrations

To create a New Relic 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 Integrations page, click Add integration.

4. From the list of available integrations, find and click the New Relic tile.

   Note: If you do not immediately see the integration that you want to create, 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 the integration name in the search bar and the corresponding tile will appear.

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 for Metrics 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 New Relic radio buttons.

   • Select Cloud Pak for AIOps integration: You can leave this at the default Use the integration that is recommended by Cloud Pak for AIOps, or uncheck this and select either Metrics or Topology.

     

   The below steps presuppose you select Metrics but if you do select Topology then you will be brought to a New observer job page. The New Relic observer only supports a load job. When a New Relic job is run, it will gather and read New Relic Infrastructure data from New Relic Insights using New Relic APIs. As a query job, it can be used to load baseline topology data and consequently synchronize it. For more information, see Configuring a New Relic 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 New Relic data.

   

7. Click Get Started.

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

   • Name: Enter the display name of your integration.

   • Description (optional): Type in a description for the integration.

   • Endpoint: Enter an endpoint for the integration.

   • Access token: Enter an access token for the integration. You can create or obtain the access token from the API Keys section in your New Relic account.

     

   • Deployment options: Select one of the options, Local or Remote. Local deploys the integration in the same cluster where IBM Cloud Pak for AIOps is installed. Alternatively, Remote deploys it in your chosen location.

   Note: If you select Remote, after adding the integration, you are provided with a bootstrap command to finish the deployment.

   Important: Podman must be installed to execute the remote deployment script with a recommended minimum version of 4.4.1. Read and write access are required for the folder where the remote deployment script will be 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. 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. If successful, a Test succeeded message is displayed.

11. Click Next.

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

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

    • URL of HTTP proxy server: Enter a URL for the HTTP proxy server.

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

      

    Note: Only unauthenticated HTTP proxy is supported.

13. Click Next.

14. On the Collect metric data page enter your preferences to define how you want to collect metric data:

    • Enable data collection: Set Enable data collection to on. However, if you disable data collection, a new integration is created, but metrics are not collected.

    • Select application: Select one or more applications from the list to see their associated metrics in the filter table. The filter table displays all the associated metrics of the selected applications.

    • Search and select the required metrics from the filter table: Search through all the metrics and select the metrics from the table. By default, all metrics are selected. To remove a selected metric, search to locate it and clear its corresponding checkbox. You can also click Cancel to remove all selected metrics or Select all to reselect them.

    • Aggregation interval (minutes): Enter a value in minutes. The value represents the time interval for live or historical data collection. The default value is 5 minutes.

      Note: If aggregation interval is less than 60 minutes, IBM Cloud Pak® for AIOps collects only a maximum of past 8 days of historical data. This is because the integration aggregates data in hourly periods, instead of the time you enter, when the data request time range is older than 8 days. For more information about aggregation interval, see the New Relic documentation.

    • Select to collect historical or live data.

      Note: If you choose to collect only live data, you cannot collect historical data after the live data collection starts.

    • Live data collection: To collect live data, complete the following steps:

      • Only live data once the integration is established: Select the checkbox.

      • Scheduler run time (minutes): Enter a value in minutes. The value represents the frequency at which data is collected for live metrics. The default value is 5 minutes.

    • Historical data collection: To collect historical data, complete the following steps:

      • Start date and time: Select the start date from the calendar and enter the time in the hh:mm format (hours and minutes).

        Note: The start date must not exceed 31 days from the present as the maximum time period for historical data collection is 31 days. The recommended time period is two weeks.

      • Time zone: Select your time zone from the dropdown list.

      • End date and time: Click Add end date and select a date from the calendar. Also, enter the time in the hh:mm format (hours and minutes). If you want to remove an end date, click Remove end date.

        Note: If you do not set an end date, IBM Cloud Pak for AIOps collects historical data from the specified start date and continues with live data collection. You cannot collect historical data after the live data collection starts.

      • Scheduler run time (minutes): Enter a value in minutes. The value represents the frequency at which data is collected for live metrics. The default value is 5 minutes.

        Note: Scheduler run time is only applicable to live mode. You must configure the scheduler run time only if you do not add an end date as the integration will continue to run in live mode after historical mode.

15. Click Done.

For more information about performance considerations for metric data collection, see Performance considerations for metric data collection.

Enabling and disabling New Relic 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 New Relic integration type.

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

5. Go to the Collect metric data section. 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 New Relic integrations.

Editing New Relic integrations

After you create your integration, you can edit it. To edit 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 New Relic integration type on the Manage integrations tab of the Integrations page.

4. On the New Relic 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.

You edited your integration.

Deleting New Relic integrations

If you no longer need your New Relic integration and want to 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 New Relic integration type on the Manage integrations tab of the Integrations page.

4. On the New Relic integrations page, click the options menu (three vertical dots) for the integration that you want to delete and click Delete.

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

Your integration is deleted.