Set Up Customized Service Logging in Designer
For each service, you can choose the following logging options. For complete information on working with services, see the Software AG Designer Online Help.
Whether to log and, if so, when, as follows:
Every time the service is called, whether by a client request, trigger, or another service.
Only when the service is called by a client request or a trigger (that is, when the service is a top-level service).
The statuses in the service’s execution on which to log - when the service fails, fails or succeeds, or starts and fails or succeeds.
Whether to store the service’s input pipeline and, if so, always or only when an error occurs. Storing the input pipeline allows you to resubmit the service later if necessary.
Note:
You can only log input pipelines if you are writing service data to an external RDBMS.
Whether to log select fields from the service signature.
Note:
If any of the selected fields you log from the service signature require a greater length than the default of 512 characters, you can modify the length of the STRINGVALUE column in the WMSERVICECUSTOMFLDS table to accommodate a larger value. Keep the following points in mind when increasing the column length:
If the data written to the STRINGVALUE column contains multibyte characters, data can be truncated in the middle of a character. To avoid this,
Integration Server truncates the last character boundary before the maximum length of the field, which could result in the data contained in the column being slightly smaller than the maximum value set in the audit logging database. To ensure that characters are not truncated, use the watt.server.audit.dbEncoding server configuration parameter to specify the character set used by the audit logging database. For more information about watt.server.audit.dbEncoding, see
watt.server..
Integration Server checks the database for column width by obtaining the metadata and examining the CHAR_OCTET_LENGTH field of the column. If the database vendor does not supply a CHAR_OCTET_LENGTH value for the column,
Integration Server uses the default length of 512 characters for the STRINGVALUE column.
You must restart Integration Server for the new length to take effect.
Whether to associate a custom value with an auditing context. The custom value can be used to search for service audit records in the
Integration Server.
To improve service logging performance, do the following:
Set up customized logging for top-level services only. Avoid logging nested services.
Log on service failure or log on service failure or success. Only choose to log on service failure or success
and start when you need the greatest possible quality of service.
Logging the pipeline can negatively affect performance, especially if the pipeline contains large objects, because
Integration Server has to make a copy of the pipeline every time the service is invoked. Store the input pipeline only for top-level services, and only when absolutely necessary (for example, on failure only). Remove all unnecessary data from the pipeline to minimize the volume of data to store.
The audit log entries that the
Process Engine can write for business process steps that run services convey the same information as the audit log entries you can write for services. In addition, the
Process Engine can store the input pipeline for services that are run by process steps. To improve logging performance, avoid logging the same information twice by coordinating audit logging for services that are invoked by process steps.
Note:
When coordinating logging, keep in mind that when a service is run by a process step, it is actually called by a wrapper service, making it a nested service rather than a top-level service.