webMethods and Intelligent Business Operations 10.2 | API Gateway User's Guide | Policies | System-defined Stages and Policies | Traffic Monitoring | Log Invocation
 
Log Invocation
This policy enables logging requests or responses to a specified destination. This action also logs other information about the requests or responses, such as the API name, operation name, the Integration Server user, a timestamp, and the response time. In addition the Store Request and Store Response options when selected store the following:
*requestHeaders
*responseHeaders
*queryParameters in case of a REST request
*corelationId - an id that can be used to query the log
*customFieldList - custom fields specified for a transaction event
*errorOrigin - specifies where the error originated from, native service or API Gateway.
To add a custom field you have to implement a flow service adhering to pub.apigateway.utils:customFieldInTransactionEventSpec specification and call the flow service using Invoke webMethods IS policy in the stage you want to add the custom field to the transaction event. The custom field's key and value should be of String type.
Note: Sensitive information like Authorization headers present in request headers, response headers, and query parameters are masked to "**************"
The table lists the properties that you can specify for this policy:
Parameter
Description
Store Request
Logs all requests.
Store Response
Logs all responses.
Compress Payload Data
Compresses the logged payload data.
Log Generation Frequency
Specifies how frequently to log the payload.
Select one of the following options:
*Always. Logs all requests and responses.
*On Failure. Logs only the failed requests and responses.
*On Success. Logs only the successful responses and requests.
Destination
Specifies the destination where to log the payload.
Select the required options:
*API Gateway
*API Portal
*Audit Log
*CentraSite
Note: This option is applicable only for the APIs published from CentraSite to API Gateway.
*Digital Events
*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.
*Set the Integration Server Administrator's logging level for 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 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 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
Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release