Enrich Alerts Using the Enrichment API

You can use the Enrichment Workflow Engine with the Enrichment API Integration in Moogsoft Enterprise to add information to your alerts. The Enrichment API Integration provides the API endpoint for you to load and maintain your enrichment data. The Enrichment Workflow Engine lets you create actions to add your enrichment data to alerts.

This topic and its related topics use an example scenario to walk you through the process to add information like physical location to an alert’s custom_info object. For general information on enrichment, see Enrichment Overview.

Before you begin

Before you start the tutorial on enrichment, read through the topic Prepare to Enrich. It covers how you define your goals for the enrichment. In this example, you want to use your the Enrichment API to add hardware physical location and support group information to alerts to meet your operators' requirements.

Verify you have completed the steps to create the Enrichment API data store. See Create the Enrichment API Data Store for more information.

Enrichment API overview

The following diagram identifies the process to enrich alert data from an external database:

Enrichment_API.png

To walk through the enrichment process:

  1. Configure the Enrichment API Integration. Supply the database connection information for the data store you created when you installed the Moogsoft Add-ons. You can also set the caching options.

  2. Load Enrichment Data. Use the Enrichment API endpoint from the Enrichment API Integration to load your enrichment data into the data store.

  3. Create an Enrichment Workflow. Set up a workflow in the Enrichment Workflow Engine to add data to alerts from the Enrichment API data store.

Learn more

To walk through the Enrichment API example scenario, go to step 1:Configure the Enrichment API Integration.

For more information about enrichment:

For more information about Enrichment API components: