| Action
Configuration. Specifies the type of action to be configured.
|
|
Name
|
Specifies the name of the metric to be
monitored.
You can select one of the available metrics:
- Availability.
Indicates whether the native API is available to the clients as specified in
the current interval.
webMethods API Gateway
calculates the availability of the native API based on the alert interval
specified and it is calculated from the instant the API activation takes place.
The availability of the API is calculated as = (time for which the native API
is up / total interval of time) x 100. This value is measured in %.
For example, if you set
Availability as less than 90,
then whenever the availability of the native API falls below 90%, in the
specified time interval,
webMethods API Gateway
generates an alert. Suppose, the alert interval is set as 1 minute (60 seconds)
and if there are 7 API invocations at various times in that 1 minute with a
combination of up and down as shown in the table, the availability is
calculated as follows:
| Request #
|
Invocation time (the second
at which the API is invoked)
|
Service status
|
Up time
|
| 1
|
5
|
Up
|
5 (from start to now)
|
| 2
|
15
|
Up
|
10 (between 1 and 2)
|
| 3
|
30
|
Down
|
15 (between 2 and 3)
|
| 4
|
40
|
Down
|
0 (since last state is
Down)
|
| 5
|
45
|
Up
|
0
|
| 6
|
50
|
Down
|
5 (between 5 and 6)
|
| 7
|
55
|
Up
|
0
|
|
|
|
|
5 (remaining 5 seconds
considered as Up inline with last state)
|
|
|
Total
|
|
40 (Availability is 67%)
|
- Average Response
Time. Indicates the average time in milliseconds taken by the
service to complete all invocations in the current interval. The average is
calculated from the instant the API activation takes place for the configured
interval.
For example, if you set an alert for Average response
time greater than 30 ms with an interval of 1 minute then on API activation,
the monitoring interval starts and the average of the response time of all
runtime invocations for this API in 1 minute is calculated. If this is greater
than 30 ms, then a monitor event is generated. If this is configured under
Monitor Performance, then all the runtime invokes are taken into account.
- Fault Count.
Indicates the number of faults returned in the current interval. The HTTP
status codes greater than or equal to 400, returned from
webMethods API Gateway
are considered as fault request transactions. This includes the downtime errors
as well.
- Maximum Response
Time. Indicates the maximum time in milliseconds to respond to a
request in the current interval.
- Minimum Response
Time. Indicates the minimum time in milliseconds to respond to a
request in the current interval.
- Success Count.
Indicates the number of successful requests in the current interval.
- Total Request
Count. Indicates the total number of requests (successful and
unsuccessful) in the current interval.
|
| Operator
|
Specifies the operator applicable to the
metric selected.
Select one of the available operator:
Greater Than,
Less Than,
Equals To.
|
| Value
|
Specifies the alert value for which the
monitoring is applied.
|
| Destination
|
Specifies the destination where the alert
is to be logged.
Select the required options:
- API
Gateway
- API
Portal
-
CentraSite
Note: This option is applicable only for the
APIs published from
CentraSite
to
webMethods API Gateway.
- External
Elasticsearch
- Email (you
can add multiple email addresses by clicking
 ). Note: If an email alias is available, you can type the email alias
in the Email Address field with the following
syntax, ${emailaliasname}. For example, if test is the email alias, then
type ${test}.
- JDBC
- Local Log: You
can select the severity of the messages to be logged (logging level) from the
Log Level drop-down list. The
available log levels are ERROR, INFO, and WARN.
Note:
- Set the
Integration Server Administrator's logging level for
webMethods API Gateway
to match the logging levels specified for the run-time actions (go to
Settings >
Logging >
Server Logger). For example,
if a Log Invocation action is set to the logging level of Error, you must also
set Integration Server Administrator's logging level for
webMethods API Gateway
to Error. If the action's logging level is set to a low level (Warning-level or
Information level), but Integration Server Administrator's logging level for
webMethods API Gateway
is set to a higher level (Error-level), then only the higher-level messages are
written to the log file.
- Entries
posted to the local log are identified by a product code of YAI and suffixed
with the initial alphabet of the logging level selected. For example, for an
error level, the entry appears as [YAI.0900.0002E].
- SNMP
- List of destinations configured using the
Custom destinations section. For
details on publishing to custom destinations, see
How Do I Publish API-specific Traffic Monitoring Data to a Custom Destination?.
|
| Alert Interval
|
Specifies the time period in which to
monitor performance before sending an alert if a condition is violated.
The timer starts once the API is activated and resets
after the configured time interval. If an API is deactivated the interval gets
reset, and on API activation the time interval starts afresh.
|
| Unit
|
Specifies the unit of measurement of the
Alert Interval configured, to monitor
performance, before sending an alert. For example:
|
| Alert Frequency
|
Specifies how frequently to issue alerts
for the counter-based metrics (Total Request Count, Success Count, Fault
Count).
Select one of the options:
- Only Once.
Triggers an alert only the first time one of the specified conditions is
violated.
- Every Time.
Triggers an alert every time one of the specified conditions is violated.
|
| Alert Message
|
Specifies the text to be included in the
alert.
|