Log Invocation

Edit online

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.

The table lists the properties that you can specify for this policy:

Property Description
Store Request Headers Logs all request headers.
Store Request Payload Logs all request payloads.
Store Response Headers Logs all response headers.
Store Response Payload Logs all response payloads.
Compress Payload Data Compresses the logged payload data.

For details about payload compression and how to uncompress a payload, see Uncompressing a payload.

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. If an Analytics service is associated with webMethods API Gateway, the Gateway logs transaction events in the Analytics service.
  • API Portal
  • Audit Log

    Audit log destination can be configured as DB or File in the Administration > Destinations screen. It is recommended to use DB when you choose Audit Log as the destination to log transactions through Log Invocation policy.

    If you choose File, warnings appear in the log file since a few of the transaction log fields are not compatible with the Audit log file destination such as BLOB types. For more information, see Configure Audit Logging section in IBM webMethods Audit Logging Guide.
    Note: You can specify Audit Log as a destination only for the Log Invocation policy.

  • 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 +Add.
    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?.