Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Figure 1: Policy Manager screen with Backlog Policy added

Property Name

Description

Application GUIDThe event process on which the policy is applied.
Service Instance NameThe service instance name on which the policy is applied if the policy is applied at SERVICE_LEVEL or PORT_LEVEL.
Port NameThe port name on which the policy is applied if the policy is applied at the PORT_LEVEL
Policy LevelThe level at which the policy is targeted. It could be targeted for the Event Process / Component / Port level. Event Process translates to all components and component-level translates to all ports of the component.
DirectionThe direction of reaching the specified depth. This could be ANY, UP or DOWN. If notification has to be raised when the pending requests are reducing, then DOWN will be specified otherwise UP will be specified. ANY is for both cases.
DepthThe integer value indicating the count of pending requests.
SubjectShort description of the content / subject of the message which is sent along with the alert.(Applicable only for SMTP alerts).
Message BodyThe actual Message content to be delivered .
AlertsThe list of alert IDs which will be executed when the condition for this policy is satisfied.

...

BackLog Policy has a set of variables which can be used in the Subject and MessageBody. Variables help build a context sensitive message/alert in contrast to a constant one. Variables are specific to types of policies. If there is a variable defined, which cannot be resolved by a particular kind of policy, it will remain unresolved in the final message. The table below lists the variables specific to backlog Policy.

Variable Name

Description

{policy_id}

The Policy ID for which this Alert is getting executed. Every time this alert is executed, this variable will get resolved.

{depth}

The count of pending requests for which the policy was configured.

{port_name}

The Port Name at which the requests-pending count reached the {depth} level in Direction {direction}. The port name has the following format: EVENT_PROCESS_ID_SERVICE_INSTANCE_NAME_PORT_NAME

{Service_instance_name}

The name of the service instance for which the requests-pending count reaches the {depth} level in Direction {direction}. The Service Instance has the following format: EVENT_PROCESS_ID__SERVICE_INSTANCE_NAME

{application_guid}

The event process within which the pending requests for {service_instance_name} / {port_name} reached the {depth} level in Direction {direction}.

{direction}

The direction in which the backlog depth was reached.

{event_time}

The date and time at which the backlog depth reached the specified {depth}

{alert_id}

This Alert ID can optionally be inserted in the message body and subject with this variable.

...


Figure 3: Policy Manager screen with Low MemoryPolicy added

Property Name

Description

Server

Server on which the policy is applied.

Application

Name of the application which has the component for which the policy is applied.

Service Instance

Component(Service instance) name on which the policy is applied

Threshold Value

The alert is raised if the memory usage reaches this threshold value.

Time Interval

Time interval(in seconds) between two successive same direction alerts.

Subject

Short description of the content / subject of the message which is sent along with the alert.(Applicable only for SMTP alerts).

Message Body

The actual Message content to be delivered .

Alerts

The list of alert IDs which will be executed when the condition for this policy is satisfied.

...

Low Memory Policy Type has a set of variables which can be used in the Subject and MessageBody. Variables help build a context sensitive message / alert in contrast to a constant one. Variables are specific to types of policies. If there is a variable defined which cannot be resolved by a particular kind of policy, it will remain un-resolved in the final message. The table below lists the variables specific to server Low memory Policy.

Variable Name

Description

{policy_id}

The Policy ID for which this Alert is getting executed. Every time this alert is executed, this variable will get resolved.

{max_memory}

Maximum memory available.

{threshold}

Decimal value

{server_name}

The name of the server.

{time_interval}

The minimum time interval between two successive same direction alerts.

{max_allowed_memory}

The Maximum memory allowed for the server.(max_memory*threshold)

{consumed_memory}

The memory used by the server.

{event_time}

The date and time at which the threshold has been reached.

{alert_id}

This Alert ID can optionally be inserted in the message body and subject with this variable.

The table below lists the variables specific to Component Low memory Policy.

Variable Name

Description

{policy_id}

The Policy ID for which this Alert is getting executed. Every time this alert is executed, this variable will get resolved.

{max_memory}

Maximum memory available.

{threshold}

Decimal value

{application_guid}

The name of the Application which has the component for which the policy is applied.

{service_instance_name}

The name of the component for which the policy is applied.

{time_interval}

The minimum time interval between two successive same direction alerts.

{max_allowed_memory}

The Maximum memory allowed for the server.(max_memory*threshold)

{consumed_memory}

The memory used by the server.

{event_time}

The date and time at which the threshold has been reached.

...

Adaptavist ThemeBuilder EngineAtlassian Confluence