Use an Activity Log policy to control your activity logs and the data that is written to them.
Activity logs contain information about message flows and how they interact with external resources. They can be generated for a message flow or a resource type. The data in your activity logs is organized into columns, and you can use tags to filter data and to provide additional information. You can use an Activity Log policy to control, at run time, where you write your activity logs, what data you write to them, and whether the logs are formatted.
You attach an Activity Log policy to an integration server by specifying the name of the integration server in the Integration server label property of this policy. You must then deploy this policy (in a policy project) to that integration server.
Property | Property name in .policyxml file | Value |
---|---|---|
Enabled | enabled | If this property is set to True (the default), the properties in this policy
are used for activity logging. If this property is set to False, the properties in
this policy are ignored. Value type: Boolean |
Integration server label | executionGroupFilter | This property specifies the name of the integration server that this
policy applies to. If this property is left blank, the policy applies to all integration servers to
which it is deployed. Value type: String |
Tag filter string | filter | This property consists of a string value that consists of tag-value pairs that are used to
filter what is written to a file. Use a semi-colon to delimit tag-value pairs; for example:
RM=JMS;MSGFLOW=myflow. For a full list of tags and their valid values,
see Activity Logs. By default, this property is not set; therefore, all Activity Log entries are written to a file. Value type: String |
Minimum severity of log entries | minSeverityLevel | This property specifies the minimum severity level of messages that are written to the
Activity Log. Only messages with a severity level equal to or above the specified value for this
property are logged. Valid values are as follows, where Error is the highest severity level and
Informational is the lowest:
Value type: String |
File name | fileName | This mandatory property specifies the fully qualified path and file name for Activity Log
files. The value must be unique for each instance of the Activity Log policy. The most recent activities are logged to a file named fileName. The names of the other files in the circular log are constructed from fileName and standard suffixes. For example, a value of filePath\myLog results in log files named myLog (the current log file), myLog.1, myLog.2, and so on, where files with higher prefixes contain older log entries. These files are written to the directory that is identified by filePath. Value type: String |
Number of log files | numberOfLogs | This property consists of an integer value that specifies the number of files that make up
the circular log. This property has a default value of 4. It can have any positive integer value greater than or equal to 1. The value applies to each integration server where this policy is deployed. Value type: Integer |
Maximum age of log files (minutes) | maxAgeMins | This property consists of an integer value that specifies the maximum age in minutes of an
individual file in the circular log. When this age is reached, the log rotates to the next
file. This property has a default value of 0 (zero), which means that file rotation based on age is not performed. Any positive integer value is valid. Value type: Integer |
Maximum log file size (MB) | maxFileSizeMb | This property consists of an integer value that specifies the maximum size in megabytes of an
individual file in the circular log. When this size is reached, the log rotates to the next
file. If you set this property to 0, file rotation based on file size is not performed. Any positive integer value is valid and the default value is 25. Value type: Integer |
Format the entries | formatEntries | If you set this property to True, Activity Log messages are written to a
file in formatted form. This property has a default value of False, which means that the log column for formatted messages has no entries. A separate log column exists for all the message inserts. Set the property to True to generate formatted messages in the appropriate national language. The insert variables in these messages are replaced with the insert values. Value type: Boolean |
Write to log analysis service | bluemixReporting | This property specifies whether the activity log messages are logged to a Kibana dashboard.
The default value is False, which means that activity log messages are not logged
to Kibana. Value type: Boolean |