Moogsoft Docs

Configure a Cookbook Recipe

A Cookbook Recipe is a set of configurable filters, triggers, and calculations that defines the type of alerts and the alert relationships that Cookbook detects and clusters into Situations.

Cookbook requires at least one active Recipe in order to function and cluster alerts into Situations. When you add Recipes via the UI, you can only configure the visible properties. Refer to Cookbook and Recipe Reference to see the available properties. You can only configure two recipe types from the UI:

  • CValueRecipeV2: Default Recipe that extracts and analyzes groups of consecutive characters to measure text similarity between alerts.

  • CValueRecipe: First version of the CValue Recipe that uses a string comparison mechanism to determine text similarity between alerts.

See Recipe Types for more details on the different types of recipes available in Cookbook. If you want to implement a more complex Cookbook such as the CBotRecipe that allows you to call Moobot functions, see Configure a Recipe Manually .

Before you Begin

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

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

  • If you want to use Vertex Entropy or hop limit in your Recipes, you have imported your network topology. See Import a Topology .

Create a Cookbook Recipe

To create a new Cookbook Recipe from the Moogsoft AIOps UI:

  1. Navigate to the Settings tab.

  2. Click Cookbook Recipes in the Algorithms section.

  3. Click the + icon to create a new Recipe. See the Cookbook and Recipe Reference for full descriptions of all properties. Some of these properties cannot be configured from the UI.

  4. Fill in the properties to name and describe the Recipe:

    • Name: Name of the Recipe (required).

    • Description: Text description of the Recipe.

    • Situation Description: Description that appears in Situations that the Recipe creates.

    • Recipe Type: Type of recipe. The only options are Value Recipe and Value Recipe V2. See Recipe Types for more information.

  5. Configure the Recipe behavior and filters that define the alert relationships:

    • Trigger Filter: Determines the alerts that Cookbook considers for Situation creation.

    • Exclusion Filter: Determines the alerts to exclude from Situation creation.

    • Seed Alert Filter: Determines whether to create a Situation from a seed alert.

    • Rate Filter: Determines the minimum event rate per minute required for Cookbook to create a Situation.

    • Alert Threshold: Minimum number of alerts required before Cookbook creates a Situation.

    • Cook For: Time period that Cookbook clusters alerts for before the recipe resets and starts a new cluster. The Recipe Cook For value overwrites the Cookbook Cook For value.

    • Cook For Extension: Time period that Cookbook can extend clustering alerts for before the Recipe resets and starts a new cluster. The Recipe Cook For Extension value overwrites the Cookbook Cook For Extension value. Setting this value enables the cook for auto-extension feature for this Recipe.

    • Max Cook For: Maximum time period that Cookbook clusters alerts for before the Recipe resets and starts a new cluster. The Recipe Max Cook For value overwrites the Cookbook Max Cook For value. If Cook For Extension is set and this value is not set, it defaults to three times the Cook For value.

  6. Configure the alert matching properties for the Recipe:

    • Cluster By: Defines how Cookbook matches alerts to clusters.

    • Hop Limit: Maximum number of hops between the alert source nodes in order for the alerts to qualify for clustering.

  7. Navigate to the Clustering tab.

  8. Click the + icon to add alert fields you want Cookbook to factor in when clustering alerts.

  9. Use the slider to edit the similarity threshold for each field. The value determines the required percentage similarity for Cookbook to cluster a set of alerts.

  10. If you want to use custom info fields, configure the Match List Items option. See Match List Item in Recipes for details.

  11. If you are configuring a Value Recipe, check Case Sensitive if you want the text similarity calculation to factor in case sensitivity.

  12. If you are configuring a Value Recipe V2, select whether you want Cookbook to calculate text similarity using shingles or words:

    • If you want to use shingles, select Shingles from the drop-down list in the Language Processing field and select a Shingle Size. The default of "3" is the optimal shingle size.

    • If you want to use words, select Words from the drop-down list in the Language Processing field.

  13. Click Save Changes.

When the configuration is complete, the changes are applied to any active Cookbooks that use the Recipe as soon as you save the changes. If the Recipe has not been added to an active Cookbook, go to Settings > Cookbook and move the Recipe under Selected Recipes for that Cookbook.