Note: this is an abstract component that cannot be instantiated.
JSON Formatted Sync Log Publishers are responsible for distributing sync log messages from the sync logger to a destination, formatted as JSON objects.
Sync log messages provide information about synchronization events that happen during server processing.
The following JSON Formatted Sync Log Publishers are available in the server :
These JSON Formatted Sync Log Publishers inherit from the properties described below.
The JSON Formatted Sync Log Publisher component inherits from the Sync Log Publisher
The properties supported by this managed object are as follows:
| General Configuration Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| logging-error-behavior | |
| Log File Management Basic Properties: | Advanced Properties: |
| write-multi-line-messages | None |
| Synchronization Configuration Basic Properties: | Advanced Properties: |
| include-sync-pipe | None |
| logged-message-type | |
| Log Message Elements To Include Basic Properties: | Advanced Properties: |
| include-product-name | include-thread-id |
| include-instance-name | |
| include-startup-id |
| Property Group | General Configuration |
| 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 |
| Property Group | General Configuration |
| 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 |
| Property Group | General Configuration |
| Description | Specifies the behavior that the server should exhibit if an error occurs during logging processing. |
| Default Value | standard-error |
| Allowed Values | standard-error - Write a message to standard error in the event of a logging failure. lockdown-mode - Place the server in lockdown mode in the event of a logging failure. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log File Management |
| Description | Indicates whether the JSON objects should use a multi-line representation (with each object field and array value on its own line) that may be easier for administrators to read, but each message will be larger (because of additional spaces and end-of-line markers), and it may be more difficult to consume and parse through some text-oriented tools. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Synchronization Configuration |
| 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 |
| Property Group | Synchronization Configuration |
| 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-ignored change-failed-detailed aborted-by-plugin plugin-error plugin mapping-warning endpoint-warning |
| 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. change-ignored - This summary message is logged each time a change is ignored. 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. plugin-debug - This message is logged by a plugin that provides custom logic when it has debug information relevant to synchronizing an operation. mapping-warning - This message is logged when attribute mapping encounters an error but does not abort the synchronization operation. endpoint-warning - This message is logged whenever an unexpected condition is encountered at an endpoint but the operation is not aborted. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log Message Elements To Include |
| Description | Indicates whether log messages should include the product name for the Data Sync Server. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log Message Elements To Include |
| Description | Indicates whether log messages should include the instance name for the Data Sync Server. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Property Group | Log Message Elements To Include |
| Description | Indicates whether log messages should include the startup ID for the Data Sync Server, which is a value assigned to the server instance at startup and may be used to identify when the server has been restarted. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
include-thread-id (Advanced Property)
| Property Group | Log Message Elements To Include |
| Description | Indicates whether log messages should include the thread ID for the Data Sync Server in each log message. This ID can be used to correlate log messages from the same thread within a single log as well as generated by the same thread across different types of log files. More information about the thread with a specific ID can be obtained using the cn=JVM Stack Trace,cn=monitor entry. |
| Default Value | false |
| Allowed Values | true false |
| 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 delete an existing Log Publisher:
dsconfig delete-log-publisher
--publisher-name {name}