File Based Sync Log Publishers publish sync messages to the file system.
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The File Based Sync Log Publisher component inherits from the Sync Log Publisher
The following components have a direct aggregation relation from File Based Sync Log Publishers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ asynchronous |
| ↓ enabled | ↓ queue-size |
| ↓ include-sync-pipe | ↓ time-interval |
| ↓ logged-message-type | ↓ buffer-size |
| ↓ timestamp-precision | ↓ auto-flush |
| ↓ log-file | ↓ compression-mechanism |
| ↓ log-file-permissions | |
| ↓ append | |
| ↓ rotation-policy | |
| ↓ retention-policy |
| Description | A description for this Log Publisher |
| 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 Publisher 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 | Specifies which Sync Pipes can log messages to this Sync Log Publisher. When a value is specified for this property, only log messages related to the specified Sync Pipes will be included in the log. This allows you to include only the messages from Sync Pipes you are interested in. If left undefined, then this Sync Log Publisher will log messages from all Sync Pipes (the default behavior). |
| Default Value | All Sync Pipes will be included by this Sync Log Publisher. |
| Allowed Values | The DN of any Sync Pipe. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the types of sync messages that will be logged. |
| Default Value | change-detected dropped-out-of-scope dropped-op-type-not-synchronized no-change-needed synchronizing-out-of-date-change change-applied change-failed-detailed aborted-by-plugin plugin-error plugin |
| Allowed Values | change-detected - This summary message is logged each time a change is detected. change-detected-detailed - This detailed message is logged each time a change is detected. It includes attribute values for added and modified entries. This level of information is often useful for diagnosing problems, but it causes log files to grow faster and can impact performance. dropped-out-of-scope - Logged when a change is dropped because it does not match any Sync Class. dropped-op-type-not-synchronized - Logged when a change is dropped because the operation type (e.g. ADD) is not synchronized for the matching Sync Class. no-change-needed - This summary message is logged when a change is dropped because the modified source entry is already in-sync with the destination entry. synchronizing-out-of-date-change - This summary message is logged when a change is synchronized even if it is out-of-date. That is, the change is stale and does not reflect the current state of the source. With the default configuration, these changes are not synchronized. entry-mapping-details - This detailed message is logged each time a source entry (attributes and DN) are mapped to a destination entry. This level of information is often useful for diagnosing problems, but it causes log files to grow faster and can impact performance. change-applied - This summary message is logged each time a change is applied successfully. change-applied-detailed - This detailed message is logged each time a change is applied. It includes attribute values for added and modified entries. This level of information is often useful for diagnosing problems, but it causes log files to grow faster and can impact performance. change-failed - This summary message is logged when a change cannot be applied. It includes the reason of the failure but not enough information to manually repair the failure. change-failed-detailed - This detailed message is logged when a change cannot be applied. It includes the reason of the failure and details about the change that can be used to manually repair the failure. intermediate-failure - This message is logged each time an attempt to apply a change fails. Note: a subsequent retry of applying the change might succeed. aborted-by-plugin - This message is logged when a plugin that provides custom logic aborts a synchronization operation. plugin-error - This message is logged by a plugin that provides custom logic when it experiences an error synchronizing an operation. plugin - This message is logged by a plugin that provides custom logic. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the smallest time unit to be included in timestamps. |
| Default Value | milliseconds |
| Allowed Values | seconds - Timestamps will be precise to the nearest second. milliseconds - Timestamps will be precise to the nearest millisecond. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The file name to use for the log files generated by the File Based Sync Log Publisher. The path to the file can be specified either as relative to the server root or as an absolute path. |
| Default Value | None |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The File Based Sync Log Publisher must be disabled and re-enabled for changes to this setting to take effect. Modification requires that this component be disabled and then re-enabled |
| Description | The UNIX permissions of the log files created by this File Based Sync Log Publisher. |
| Default Value | 640 |
| Allowed Values | A valid UNIX mode string. The mode string must contain three digits between zero and seven. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies whether to append to existing log files. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The rotation policy to use for the File Based Sync Log Publisher . When multiple policies are used, rotation will occur if any policy's conditions are met. |
| Default Value | No rotation policy is used and log rotation will not occur. |
| Allowed Values | The DN of any Log Rotation Policy. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The retention policy to use for the File Based Sync Log Publisher . When multiple policies are used, log files are cleaned when any of the policy's conditions are met. |
| Default Value | No retention policy is used and log files are never cleaned. |
| Allowed Values | The DN of any Log Retention Policy. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
asynchronous (Advanced Property)
| Description | Indicates whether the File Based Sync Log Publisher will publish records asynchronously. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
queue-size (Advanced Property)
| Description | The maximum number of log records that can be stored in the asynchronous queue. The server will continuously flush messages from the queue to the log. That is, it does not wait for the queue to fill up before flushing to the log. Lowering this value can impact performance. |
| Default Value | 10000 |
| Allowed Values | An integer value. Lower limit is 1000. Upper limit is 100000 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The File Based Sync Log Publisher must be restarted if this property is changed and the asynchronous property is set to true. |
time-interval (Advanced Property)
| Description | Specifies the interval at which to check whether the log files need to be rotated. |
| Default Value | 5s |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
buffer-size (Advanced Property)
| Description | Specifies the log file buffer size. |
| Default Value | 64kb |
| Allowed Values | A positive integer representing a size. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
auto-flush (Advanced Property)
| Description | Specifies whether to flush the writer after every log record. If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
compression-mechanism (Advanced Property, Read-Only)
| Description | Specifies the type of compression (if any) to use for log files that are written. Note that this setting cannot be changed once the logger has been created, because of the possibility of mixing compressed and uncompressed data in the same file. Further, because it is difficult to append to a compressed file, any existing active log file will automatically be rotated when the server is started. If compressed logging is used, it may also be desirable to have another logger enabled that does not use compression. The rotation and retention policies for the uncompressed logger can be configured to minimize the amount of space it consumes, but having ready access to information about recent operations in uncompressed form may be convenient for debugging purposes. Alternately, you could consider having the uncompressed logger defined but not enabled so that it can be turned on as needed for debugging such problems. |
| Default Value | none |
| Allowed Values | none - No compression will be performed. gzip - Compress file data using gzip with the default compression level. If this compression level is specified, then files will automatically be given a ".gz" extension. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Log Publishers:
dsconfig list-log-publishers
[--property {propertyName}] ...
To view the configuration for an existing Log Publisher:
dsconfig get-log-publisher-prop
--publisher-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log Publisher:
dsconfig set-log-publisher-prop
--publisher-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new File Based Sync Log Publisher:
dsconfig create-log-publisher
--publisher-name {name}
--type file-based
--set enabled:{propertyValue}
--set log-file:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}