Parameters Passed by a Health Rule Violation

The parameters describe the violated health rule violation that triggered the action.

The total number of elements in the array depends on the number of entities evaluated by the health rule and the number of triggered conditions per evaluation entity. Examples of evaluation entities are application, tier, node, business transaction, JMX. For each evaluation entity, the script expects the entity type, entity name, entity id, number of triggered conditions, and for each triggered condition, the set of condition parameters.

The parameter values are passed in the order in which they are described.

Structure of Parameters Sent by a Health Rule Violation

  • APP_NAME
  • APP_ID
  • PVN_ALERT_TIME
  • PRIORITY
  • SEVERITY // INFO, WARN, ERROR
  • ACTION_NAME
  • HEALTH_RULE_NAME
  • HEALTH_RULE_ ID
  • PVN_TIME_PERIOD_IN_MINUTES
  • AFFECTED_ENTITY_TYPE
  • AFFECTED_ENTITY_NAME
  • AFFECTED_ENTITY_ID
  • NUMBER_OF_EVALUATION_ENTITIES— The following parameters are passed for each evaluation entity:
    • EVALUATION_ENTITY_TYPE
    • EVALUATION_ENTITY_NAME
    • EVALUATION_ENTITY_ID
    • NUMBER_OF_TRIGGERED_CONDITIONS_PER_EVALUATION_ENTITY— The following parameters are passed for each triggered condition for this evaluation entity:
      • SCOPE_TYPE_x
      • SCOPE_NAME_x
      • SCOPE_ID_x
      • CONDITION_NAME_x
      • CONDITION_ID_x
      • OPERATOR_x
      • CONDITION_UNIT_TYPE_x
      • USE_DEFAULT_BASELINE_x
      • BASELINE_NAME_x
      • BASELINE_ID_x
      • THRESHOLD_VALUE_x
      • OBSERVED_VALUE_x
  • SUMMARY_MESSAGE
  • INCIDENT_ID
  • DEEP_LINK_URL
  • EVENT_TYPE
  • ACCOUNT
  • ACCOUNT_NAME

Definitions of Parameters Sent by a Health Rule Violation

Health Rule Violation Parameter Definition
APP_NAME

Name of the business application.

APP_ID

Application ID number.

PVN_ALERT_TIME

Alert time, such as Thu Dec 22 15:03:56 PST 2011.

PRIORITY

Integer designating how urgently a health rule violation should be fixed. The lowest number (0) is the most urgent.

SEVERITY

INFO, WARN, or ERROR. In the Controller UI, they are called Info, Warning, and Critical.

ACTION_NAME

Name of the action to be invoked post a health rule violation.

HEALTH_RULE_NAME

Name of the health rule that was violated.

HEALTH_RULE_ ID

Health rule ID.

PVN_TIME_PERIOD_IN_MINUTES

Health rule violation time period in minutes.

AFFECTED_ENTITY_TYPE

APPLICATION, APPLICATION_COMPONENT (aka Tier), APPLICATION_COMPONENT_NODE, BUSINESS_TRANSACTION, APPLICATION_DIAGNOSTIC_DATA (aka Error).

AFFECTED_ENTITY_NAME

The affected entity name.

AFFECTED_ENTITY_ID

The affected entity ID.

NUMBER_OF_EVALUATION_ENTITIES

Number of entities (Business Transactions, Applications, Tiers, Nodes, Errors, JMX counters, and so on) violating the health rule conditions.

EVALUATION_ENTITY_TYPE

APPLICATION, APPLICATION_COMPONENT (aka Tier), APPLICATION_COMPONENT_NODE, BUSINESS_TRANSACTION, APPLICATION_DIAGNOSTIC_DATA (aka Error), JMX.

EVALUATION_ENTITY_NAME

The evaluation entity name (for JMX it is the counter name).

EVALUATION_ENTITY_ID

The evaluation entity ID or <NULL> for JMX.

NUMBER_OF_TRIGGERED_CONDITIONS_PER_EVALUATION_ENTITY

Number of times to loop through the triggered condition parameters for each evaluation entity; if more than one condition is triggered, the parameters repeat for each triggered condition, where x is the position of the condition.

SCOPE_TYPE_x

The scope of the parameter, whether the scope is the application, tier, or node: APPLICATION, APPLICATION_COMPONENT, APPLICATION_COMPONENT_NODE.

SCOPE_NAME_x

The name of the scope, such as ACME Book Store Application.

SCOPE_ID_x

The scope ID.

CONDITION_NAME_x

The health rule condition name.

CONDITION_ID_x

The health rule condition ID.

OPERATOR_x

Allowed operators: LESS_THAN, LESS_THAN_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, EQUALS, NOT_EQUALS.

CONDITION_UNIT_TYPE_x

The condition for the threshold parameter: ABSOLUTE, BASELINE_STANDARD_DEVIATION, BASELINE_PERCENTAGE, BASELINE_PERCENTILE.

USE_DEFAULT_BASELINE_x

A Boolean parameter (true or false) applies only when the condition unit type is one of the BASELINE_ types.

BASELINE_NAME_x

Applicable only when the condition unit type is one of the BASELINE_ types and the use default baseline parameter is false.

BASELINE_ID_x

Applicable only when the condition unit type is one of the BASELINE_ types and the use default baseline parameter is false.

THRESHOLD_VALUE_x

Health rule threshold setting.

OBSERVED_VALUE_x

Value that violated the health rule threshold.

SUMMARY_MESSAGE

Summary of the notification, such as Health rules have been violated.

INCIDENT_ID

The incident identifier number for this health rule violation. Incident ID is unique within the Controller. The field is defined as int(11) which means it takes four bytes of space that is 32 bits of space with 2^(31) - 1 = 2147483647 max value and -2147483648 min value. One bit is for sign.

DEEP_LINK_URL

Controller deep link URL, such as:

http://<controller-host-url>/#location=APP_INCIDENT_DETAIL&incident=<incident-id>

Append the incident ID to the URL to provide a link to the Controller UI for this policy violation.

EVENT_TYPE

POLICY_OPEN_WARNING, POLICY_OPEN_CRITICAL, POLICY_CLOSE_WARNING, POLICY_CLOSE_CRITICAL, POLICY_UPGRADED, POLICY_DOWNGRADED, POLICY_CANCELED_WARNING, POLICY_CANCELED_CRITICAL, POLICY_CONTINUES_CRITICAL, and POLICY_CONTINUES_WARNING.

ACCOUNT

The entity type "ACCOUNT".

Note: This is a predefined text.
ACCOUNT_NAME

Name of the account in which the action was triggered.