Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Summarize Log File Rotation Listener may be used to invoke the summarize-access-log tool on a recently-rotated access log file.
This should only be used for access log files written by the file-based access log publisher, the operation timing access log publisher, or some other logger that uses a syntax that is supported by the summarize-access-log tool. Compressed log files are not supported.
The Summarize Log File Rotation Listener component inherits from the Log File Rotation Listener
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| output-directory |
| Description | A description for this Log File Rotation Listener |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Log File Rotation Listener is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The path to the directory in which the summarize-access-log output should be written. If no value is provided, the output file will be written into the same directory as the rotated log file. The output file will have the same name as the rotated log file, plus an extension of ".summary". These summary files will not automatically be removed by log retention policies, so administrators will be required to move or delete them when they are no longer needed. |
| Default Value | None |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Log File Rotation Listeners:
dsconfig list-log-file-rotation-listeners
[--property {propertyName}] ...
To view the configuration for an existing Log File Rotation Listener:
dsconfig get-log-file-rotation-listener-prop
--listener-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log File Rotation Listener:
dsconfig set-log-file-rotation-listener-prop
--listener-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Summarize Log File Rotation Listener:
dsconfig create-log-file-rotation-listener
--listener-name {name}
--type summarize
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log File Rotation Listener:
dsconfig delete-log-file-rotation-listener
--listener-name {name}