Moogsoft Docs

Configure a Cookbook

Cookbook is a deterministic clustering algorithm in Moogsoft AIOps that creates Situations defined by the relationships between alerts.

When you add a Cookbook via the UI, you can only configure the visible properties. Cookbook requires at least one active Recipe in order to function and cluster alerts into Situations. See Configure a Cookbook Recipe for more details.

If you want to implement a more complex Cookbook with advanced configuration and additional properties, see Configure a Cookbook Manually. Refer to Cookbook and Recipe Reference to see all available properties.

Before You Begin

Before you set up your Cookbook via the UI, ensure you have met the following requirements:

  • You have set up the Recipes you want your Cookbook to use. See Configure a Cookbook Recipe for details.

  • Your LAMs or integrations are running and Moogsoft AIOps is receiving events.

  • You have configured the Moolet that is the source of the alerts for the Cookbook. You select the source using the process_output_of property.

Create a Cookbook

To create a new Cookbook from the UI:

  • Navigate to the Settings tab.

  • Click Cookbooks in the Sigaliser section.

  • Click the + icon to create a new Cookbook. See the Cookbook and Recipe Reference for a full description of all properties. You cannot configure some properties from the UI.

  • Fill in the properties to name and describe the Cookbook:

    • name: Name of the Cookbook (required).

    • description: Text description of the Cookbook.

  • Configure the Cookbook's input and clustering behaviour:

    • process output of: Defines Moolet source of the alerts for the Cookbook (required).

    • cluster by: Determines the Cookbook's clustering behavior.

    • entropy threshold: Minimum entropy value an alert must have in order for Cookbook to cluster it into a Situation.

    • cook for: Period of time that Cookbook clusters alerts for before the recipe resets and determines when to start a new cluster.

    • scale by severity: Treat alerts with a high severity value like alerts with a higher entropy value.

  • Configure which recipes that Cookbook uses and when it uses them:

    • first recipe match only: Enables a priority order for recipes in the Cookbook.

    • selected recipes: Determines the Cookbook's clustering behavior.

  • Click Save Changes to create the Cookbook.

  • To enable the new Cookbook, return to System Settings and click Cookbook Selection.

  • Move the new Cookbook to Active Cookbooks and click Save Changes.

Select a Cookbook

After completing the configuration, you can activate the new Cookbook to run alongside any existing active Cookbooks:

  • Navigate to the Settings tab.

  • Click Cookbook Selection in the Sigaliser section.

  • Move the Cookbook under 'Active Cookbooks' using the arrow icons.

  • Click the Merging tab and choose the merging option you want to use:

    • Resultant Situations from active Cookbooks are not to be merged together. Default.

    • Resultant Situations from active Cookbooks are eligible to be merged together if they share a degree of similarity. The similarity is set using the slider.

  • Click the Advanced tab configure if you want Moogsoft AIOps to purge closed and superseded Situations from moogfarmd. Define how often you want the purge to occur in hours and minutes.

  • Save any changes.

Changes to the settings initiate a restart of Moogfarmd and all running Cookbooks.