CentraSite User's Guide : Runtime Governance : Run-Time Policy Management : Built-In Run-Time Actions Reference (CentraSite Business UI) : Built-in Actions for Run-Time Policies (CentraSite Business UI) : Monitor Service Level Agreement
Monitor Service Level Agreement
This action monitors a set of run-time performance conditions for an API, and sends alerts to a specified destination when the performance conditions are violated. This action enables you to monitor run-time performance for one or more specified clients.
You can configure this action to define a Service Level Agreement (SLA), which is a set of conditions that defines the level of performance that a client should expect from an API. You can use this action to identify whether an API threshold rules are met or exceeded. For example, you might define an agreement with a particular client that sends an alert to the client (consumer application) if responses are not sent within a certain maximum response time. You can configure SLAs for each API or consumer application combination.
For the counter-based metrics (Total Request Count, Success Count, Fault Count), Mediator sends an alert as soon as the performance condition is violated, without having to wait until the end of the metrics tracking interval. You can select whether to send an alert only once during the interval, or every time the violation occurs during the interval. (Mediator sends another alert the next time a condition is violated during a subsequent interval.)
For the aggregated metrics (Average Response Time, Minimum Response Time, Maximum Response Time), Mediator aggregates the response times at the end of the interval, and then sends an alert if the performance condition is violated.
This action does not include metrics for failed invocations.
Note:  
To enable Mediator to publish performance metrics, you must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to Solutions > Mediator > Administration > CentraSite Communication). For the procedure, see Administering webMethods Mediator.
Input Parameters
Action Configuration Parameters
Specify one or more conditions to monitor. To do this, specify a metric, operator, and value for each metric. To specify multiple conditions, use the plus button to add multiple rows. If multiple parameters are used, they are connected by the AND operator.
Name Operator
(String). (Array). The metrics to monitor.
Value
Description
Availability
Indicates whether the API was available to the specified clients in the current interval.
Average Response Time
The average amount of time it took the service to complete all invocations in the current interval. Response time is measured from the moment Mediator receives the request until the moment it returns the response to the caller.
Fault Count
Indicates the number of faults returned in the current interval.
Maximum Response Time
The maximum amount of time to respond to a request in the current interval.
Minimum Response Time
The minimum amount of time to respond to a request in the current interval.
Successful Request Count
The number of successful requests in the current interval.
Total Request Count
The total number of requests (successful and unsuccessful) in the current interval.
(String). (Array). Specifies an operator.
Value
(String). (Array). Specifies an alert value.
Alert for Consumer Applications
(Object). (Array). Specify the Application asset to which this Service Level Agreement applies. To specify multiple consumer applications, use the plus button to add multiple rows.
Alert Configuration Parameters
Specifies the parameters for the alerts that reports on the Service Level Agreement conditions:
Alert Interval
(Number). The time period (in minutes) in which to monitor performance before sending an alert if a condition is violated.
Alert Frequency
(String). Specifies how frequently to issue alerts for the counter-based metrics (Total Request Count, Success Count, Fault Count).
Value
Description
Every Time
Issue an alert every time one of the specified conditions is violated.
Only Once
Issue an alert only the first time one of the specified conditions is violated.
Alert Destination
(String). Specifies where to log the alert.
Important:  
Ensure that Mediator is configured to send event notifications to the destination(s) you specify here. For details about alerts and transaction logging, see Administering webMethods Mediator.
Value
Description
API Portal
Mediator can use API Portal destination to publish data about run-time events and key performance indicator (KPI) metrics.
Mark the checkbox API Portal and select an API Portal instance from the drop-down list. When you mark the checkbox, CentraSite displays the list of API Portal instances that are registered and are available to you. To specify multiple API Portal instances, use the plus button to add rows.
Note:  
When you publish an API that is configured with an API Portal destination to Mediator, CentraSite automatically creates an entry of the configured API Portal destination in the Integration Server Administrator's Solutions > Mediator > Administration > API Portal page.
Mediator uses the API Portal destination to publish the following event types:
*Transaction Events
*Monitoring Events
*Lifecycle Events
*Policy Violation Events
*Error Events
*Performance Metrics
You can also use the Mediator capability to specify the intervals at which the events and KPI metrics must be published to the API Portal destination.
Prerequisite: You must configure CentraSite to communicate with API Portal using the Add Gateway action.
CentraSite
Sends the alerts to the API's Events profile in CentraSite.
Prerequisite: You must configure Mediator to communicate with CentraSite (in the Integration Server Administrator, go to Solutions > Mediator > Administration > CentraSite Communication). For information about how to configure communication with CentraSite, see Administering webMethods Mediator.
Elasticsearch
Mediator can use Elasticsearch destination to publish data about run-time events and key performance indicator (KPI) metrics.
Mediator uses the Elasticsearch destination to publish the following event types:
*Transaction Events
*Monitoring Events
*Lifecycle Events
*Policy Violation Events
*Error Events
*Performance Metrics
You can also use the Mediator capability to specify the intervals at which the events and KPI metrics must be published to the Elasticsearch destination.
Prerequisite: You must configure the Elasticsearch destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > Elasticsearch). For the procedure, see Administering webMethods Mediator.
Local Log
Sends the alerts to the server log of the Integration Server on which Mediator is running.
Also select a value in the Log Level field:
*Info: Logs error-level, warning-level, and informational-level alerts.
*Warn: Logs error-level and warning-level alerts.
*Error: Logs only error-level alerts.
Important:  
The Integration Server Administrator's logging level for Mediator should match the logging level specified for this action (go to Settings > Logging > Server Logger).
SNMP
Sends the alerts to CentraSite's SNMP server or a third-party SNMP server.
Prerequisite: You must configure the SNMP server destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > Email). For the procedure, see Administering webMethods Mediator.
Email
Sends the alerts to an SMTP email server, which sends them to the email address(es) you specify here. To specify multiple addresses, use the plus button to add rows.
Prerequisite: You must configure the SMTP server destination (in the Integration Server Administrator, go to Solutions > Mediator > Administration > Email). For the procedure, see Administering webMethods Mediator.
EDA/Database
Sends the alerts to an EDA endpoint or Database destination that you configured in Integration Server Administrator:
*An EDA endpoint (that is, a default endpoint configured in the universal messaging configuration).
*A Database (that is, a JDBC connection pool is defined in Integration Server and associated with the Mediator functional alias).
Prerequisite: You must configure the EDA/Database destination in Integration Server on the Solutions > Mediator > Administration > EDA/Database Configuration page. For details, see Administering webMethods Mediator.
Alert Message
(String). (Optional). Specify a text message to include in the alert.
Copyright © 2015- 2017 Software AG, Darmstadt, Germany. (Innovation Release)
Product LogoContact Support   |   Community   |   Feedback