Adding a custom Optimizer rule

Use the Rules page in the TrueSight Capacity Optimization console to create, configure, and manage Optimizer rules to generate alerts and recommendations. You can create an Optimizer rule based on a predefined template or create a customized rule. For more information about Optimizer rules, see Configuring and managing Optimizer rules.

This topic explains the procedure to add a customized rule. Review the existing templates before you create a new custom rule. For instructions about creating a template-based rule, see Adding a template-based Optimizer rule.

Note

This procedure is intended for advanced users only.

Adding a custom rule 

  1. In the TrueSight Capacity Optimization console, click Administration > OPTIMIZER > Rules
  2. In the Optimizer Rules page, click Add rule.
  3. In the New rule page, enter values and make appropriate selections for the following properties:

    Properties marked with (tick) are available only while building a rule in Advanced mode. To switch (toggle) to Advanced mode, click Advanced.

    PropertyDescription 
    General
    NameSpecify a name for the rule.
    (OptionalDescriptionSpecify a short description for the rule. For example, vSphere datastore oversaturation rule.
    Generation schedule

    Select an Optimizer task that defines the schedule of the Optimizer rule. All the configured Optimizer rules are available for selection. For example: Optimizer - daily, Optimizer - weekly.

    Rule type

    Select custom rule.

    By default, one condition, Condition 1, is displayed in the Conditions section, Also, a new collapsed tab, called Condition 1, is displayed after the Filters tab.

    (tick) Input data and Data martsSelect whether you want the input data to be based on historical data or a specific data mart. Select one of the following:
    • based on historical data:
    • based on Data marts: Select a data mart in the Data marts tab, which is a new collapsed tab that is displayed after the Filters tab:

      Select a data mart from the Data mart list or manually specify a name in the View or table name field and click Apply.
      Select a value in the Entities id column and select the Entities type. If you choose the Entities type to be specified by column, then select a value in the Structureid column field. All the available values in these fields are based on the selected data mart.

    Conditions

    Add and apply conditions based on your requirement. A condition, Condition 1, is added by default. You need to configure details of the conditions in their respective collapsed tabs.

    For more information, see the Condition n section in this table.

    Filters
    Period type

    Specify the period for which the condition applies. Select one of the following values:

    • Use time filter: Select a period from the predefined list.
    • Manually specified: If none of the predefined periods meets your requirements, specify the period manually. You can select the resolution (hours, days, weeks, or months) and specify the number. You can also select whether you want to include the current hour/day/week/month in the period based on the resolution. Click Apply after selecting the check box.

    Entity selection method

    Select the method to choose the entities to which the rule applies. You can select specific entities, those based on a filter, or entities in one or many domains and subdomains.

    Select one of the following methods:

    • Entity filter: Select a filter from the Select entity filter list as defined in the Workspace. For more information, see Managing entity filters.
    • All entities
    • All entities of a domain: Select one or more domains from the Domain list.
    • All entities of a domain and its subdomains: Select a domain or subdomain.
    • Specified entities: Select specific systems or business drivers from the Specified systems or business drivers list.

    Specified system types

    Add specified system types to the rule:

    1. Click Edit.
    2. Select a system type from the Available items list and click >> to add it to the Selected items list. Use Shift+click to select multiple system types at once.
    3. Click Apply.
    Specified business driver types

    Add specified business driver types to the rule:

    1. Click Edit.
    2. Select a business driver type from the Available items list and click >> to add it to the Selected items list. Use Shift+click to select multiple business driver types at once.
    3. Click Apply.
    (tick) Exclude systems or business driversSelect specific systems or business drivers part of the included domain that you want to exclude from the rule definition.

    Condition n

    Severity

    Select the level of severity to be associated with the alert and recommendation when the specified condition is met.

    • Warning
    • Critical
    • Efficiency (low)
    • Efficiency (medium)
    • Efficiency (high)
    MetricsSelect a metric over which you want recommendations to be generated with the specified severity.
    Condition type

    Select the type of condition on which you want the recommendation to be triggered:

    • Monitor Violations: Enables you to evaluate the percentage of GOOD, WARNING, and POOR samples of a resource over a specified time range.
    • Data vs. Threshold: Enables you to set specific thresholds for each metric of your system (or business driver) and its subobjects, using standard TrueSight Capacity Optimization statistics (average, min, max, and sum) and resolutions (summary, hour, detail, and day). For example, you can configure a rule that generates an alert if the average value of samples at resolution summary in the period 05-07 2010 [May-July 10] is greater than 70.
    • Formula: Enables you to enter a custom formula to generate recommendations.

    For more information, see Working with producer-based and rule-based custom statistics.

    Condition type 1 > Monitor violations

    Aggregation functionThe type of aggregation to use on the data samples:
    • good
    • warning
    • poor
    ComparatorThe comparative relationship on which to base the condition:
    • greater
    • greater or equal
    • less or equal
    • less
    • different more
    ThresholdThe threshold value on which to base the condition.
    Condition descriptionAn auto-generated description briefly describing the current condition. For example: Generate alert if average value of samples at resolution aggregated in the period Last 7 days is greater than 12.

    Condition type 2 > Data vs. Threshold

    Aggregation functionThe type of aggregation to use on the data samples:
    • average
    • max
    • min
    • sum
    Resolution

    The sample resolution on which to base the condition:

    • summary/day: Both these resolution types perform an aggregation using the selected statistic of the whole time filter to a single point, on which the rule is evaluated.
    • hour: Aggregates all samples (across time filter) using the selected statistic (for example, average, max) of a specific hour of the day, to a single point. The output is a 24 samples-long series, on which the rule is evaluated.This behavior is equivalent to the “Day profile” resolution type, in the analysis.
    • detail: Aggregates all samples (across time filter) using the selected statistic (for example, average, max) of a specific point in time of the day, to a single point. The rule is evaluated on the output series, which may vary according to the granularity of the detail resolution (for example, 15 minutes).

    For related information, see Working with producer-based and rule-based custom statistics.

    ComparatorThe comparative relationship on which to base the condition. Select any one:
    • greater
    • greater or equal
    • less or equal
    • less
    • different more
    Threshold type

    The type of threshold on which to base the condition. Select any one:

    • Optimizer threshold
    • custom: In the Threshold field, type a numeric value
    Thresholds for subresources

    The thresholds to apply to subresources:

    • Same threshold for each subresource: Use the same threshold for each subresource.
    • Custom threshold for some subresources: Use different thresholds for selected subresources. Click Edit to activate the Choose subresources list. Under Available items, select the subresources and click . The subresources are added to Selected items. Click Apply to add selected subresources to the rule. Then, in the Threshold subresources section, type a threshold value for each of the selected subresource.
    Condition descriptionDisplays an auto-generated description that describes the current condition.

    Condition type 3 > Formula

    Formula options

    Select one or more options:

    • Based on metrics: Click Edit in Metrics section to activate the list, then select the metrics, and click Apply to add the metrics to the rule.
    • Based on indicators: Click Edit in Indicators section to activate the list, then select the indicators, and click Apply to add the indicators to the rule.
    Parameters and Formula

    In the Parameters section, type parameters in the following syntax for the current condition to be used in the Formula section.

    <name of parameter> | <description> | <threshold value> | <type>
    Where <type> can be a number or a string.

    In the Formula section, enter a formula for the rule.

    For more information about parameters and formulas, see Examples of formulas and parameters in custom Optimizer rules.

    Condition descriptionA description in the form of a formula for this rule.
    Condition type > Common to Condition types 1 – 3
    (tick) Condition description message

    Select any one option:

    • Automatic: Use the auto-generated description for the rule.
    • Manual: Add velocity template-based custom description messages for alert emails and log tables.
    (tick) Custom description for alert email (Velocity)

    Available when you select the Manual option for Condition description message. Add a custom description for alert emails and the log table by using the Apache Velocity syntax to populate the following variables:

    • point: Data point in which the alert condition is triggered.
    • dataFetcher: Extracts a configuration metric, given the key and metric name.
    • key: Identifies the system/business driver ID.
    • numberFormatter: A utility class to format numbers with measure units. For more information, see Using Velocity Templates in Recommendation rules.
    (tick) Custom description for log table (Velocity)
    Recommendation type

    Select one of the following recommendation types:

    • No recommendation: Do not generate any recommendation.
    • Cluster over-subscription: Generate recommendations when a cluster is oversubscribed.
    • Cluster under-subscription: Generate recommendations when a cluster is under-subscribed.
    • Forecasted saturation: Generate recommendations when there are capacity issues related to forecasted saturation.
    • Generic:Generate a general recommendation.
    • Idle VM: Generate recommendations when idle VMs are identified.
    • Old snapshots: Generate recommendations when old and outdated snapshots are identified.
    • Overallocated VM: Generate recommendations when overallocated VMs are identified.
    • (If TrueSight Cloud Cost Control is installed) Reserved instances: Generate recommendations about the number of AWS reserved instances to be purchased.

      For more information about each recommendation type, see Using recommendations to resolve capacity risk and efficiency issues.
    Recommendation text
    (Does not apply to the No recommendation value for the Recommendation type property)

    Add recommendation text for each recommendation type by using the Apache Velocity syntax to populate the following variables:

    • point: Data point in which the alert condition is triggered.
    • dataFetcher: Extracts a configuration metric, given the key and metric name.
    • key: Identifies the system/business driver ID.
    • numberFormatter: A utility class to format numbers with measure units. For more information, see Using Velocity Templates in Recommendation rules.
    Actions
    Actions to perform

    Specify the action to be taken when the rule generates an alert or a recommendation.

    Select one or all of the following actions:

    • Send an alert mail:
      • Type the email addresses for recipients of alert notifications, separated by a semicolon (;) in the Send an email to field.
      • To send a copy of the email to the product administrators, in the Admin copy section, select Send to all TrueSight Capacity Optimization Admins.
      • To attach a specific report with the email that is sent out, in the Mail attachment section, select Attach a report and choose a report from the list. By default, Nothing is selected.
      • Extract additional columns for email template: Click Edit. Under Available items, select the columns you want to add and click  . The columns are added under Selected items. Click Apply.
      • Additional columns custom name: Type a custom name for each additional column you have selected.
      • To save the email template for future use, specify a name in Mail template name.
    • Send an SNMP trap: Select this option to send SNMP traps for alerts. If SNMP traps have not been configured, selecting this option has no effect.
    • Publish events to TrueSight Operations Management: Events based on the rule definition are triggered and sent to TrueSight Operations Management. This option is available only if you are integrating with TrueSight Operations Management and have configured the required details in the Global configuration page. For more information, see Integrating with TrueSight Operations Management

    • Change the status of alerted systems/business drivers and domains based on Risk conditions: To change the status of a report select a report from the list in the Change status of the following reports section.
  4. Click Save.

The rule is saved and enabled by default. The rule is listed in the Optimizer rules table. The rule is triggered to run based on the Optimizer task that is associated with the rule.

Was this page helpful? Yes No Submitting... Thank you

Comments