Data Sync Server Documentation Index
Configuration Reference Home

Syslog JSON Sync Log Publisher

The Syslog JSON Sync Log Publisher can be used to write JSON-formatted sync log messages to a syslog server.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Syslog JSON Sync Log Publisher component inherits from the JSON Formatted Sync Log Publisher

Relations from This Component

The following components have a direct aggregation relation from Syslog JSON Sync Log Publishers:

Properties

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
Syslog Configuration Basic Properties: Advanced Properties:
↓ syslog-external-server ↓ queue-size
↓ syslog-facility
↓ syslog-severity
↓ syslog-message-host-name
↓ syslog-message-application-name
Log Message Elements To Include Basic Properties: Advanced Properties:
↓ include-product-name ↓ include-thread-id
↓ include-instance-name
↓ include-startup-id

Basic Properties

description

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

enabled

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

logging-error-behavior

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

write-multi-line-messages

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

include-sync-pipe

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

logged-message-type

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

syslog-external-server

Property Group
Syslog Configuration
Description
The syslog server to which messages should be sent. Multiple servers can be configured for the sake of redundancy. If multiple servers are configured, then they must all be configured to communicate over TCP (with or without TLS encryption). When sending a syslog message, servers will be tried in the order in which they are listed.
Default Value
None
Allowed Values
The DN of any Syslog External Server.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

syslog-facility

Property Group
Syslog Configuration
Description
The syslog facility to use for the messages that are logged by this Syslog JSON Sync Log Publisher.
Default Value
system-daemons
Allowed Values
user-level-messages - A facility that is commonly used for messages logged by user applications running on the system. This facility has an integer value of 1.

system-daemons - A facility that is commonly used for messages logged by daemon processes running on the system. This facility has an integer value of 3.

security-and-authorization - A facility that is commonly used for messages related to security and authorization-related processing. This facility has an integer value of 4.

security-and-authorization-alternative - An alternative facility for messages related to security and authorization-related processing. This facility has an integer value of 10.

log-audit - A facility for messages related to log audit processing. This facility has an integer value of 13.

log-alert - A facility for messages related to log alert processing. This facility has an integer value of 14.

local-use-0 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 16.

local-use-1 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 17.

local-use-2 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 18.

local-use-3 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 19.

local-use-4 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 20.

local-use-5 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 21.

local-use-6 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 22.

local-use-7 - A facility that does not have any predefined purpose and may be used for any arbitrary purpose. This facility has an integer value of 23.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

syslog-severity

Property Group
Syslog Configuration
Description
The syslog severity to use for the messages that are logged by this Syslog JSON Sync Log Publisher.
Default Value
informational
Allowed Values
emergency - A severity that is commonly used for messages indicating that the system is unusable. This severity has an integer value of 0.

alert - A severity that is commonly used for messages that require immediate administrative action. This severity has an integer value of 1.

critical - A severity that is commonly used for messages that represent critical error conditions. This severity has an integer value of 2.

error - A severity that is commonly used for messages that represent non-critical error conditions. This severity has an integer value of 3.

warning - A severity that is commonly used for messages that represent warning conditions. This severity has an integer value of 4.

notice - A severity that is commonly used for messages that represent normal but significant conditions. This severity has an integer value of 5.

informational - A severity that is commonly used for informational messages. This severity has an integer value of 6.

debug - A severity that is commonly used for debug messages. This severity has an integer value of 7.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

syslog-message-host-name

Property Group
Syslog Configuration
Description
The local host name that will be included in syslog messages that are logged by this Syslog JSON Sync Log Publisher. If this is specified, then the value must be between 1 and 255 characters in length, and it must contain only printable ASCII characters between 0x21 (the '!' character) and 0x7E (the '~') character, inclusive. It should represent a qualified or unqualified hostname, an IPv4 address, or an IPv6 address.

If this is not specified, then the server will attempt to automatically determine the hostname for the local system.

If no hostname should be included in syslog messages, then a value of "-" should be used.

Default Value
The server will attempt to automatically determine the hostname for the local system.
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

syslog-message-application-name

Property Group
Syslog Configuration
Description
The application name that will be included in syslog messages that are logged by this Syslog JSON Sync Log Publisher. If this is specified, then the value must be between 1 and 48 characters in length, and it must contain only printable ASCII characters between 0x21 (the '!' character) and 0x7E (the '~') character, inclusive.

If this is not specified, then the server will use a default value of "PingDataSync".

If no application name should be included in syslog messages, then a value of "-" should be used.

Default Value
The server will use a default value of "PingDataSync".
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

include-product-name

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

include-instance-name

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

include-startup-id

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


Advanced Properties

queue-size (Advanced Property)

Property Group
Syslog Configuration
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
100000
Allowed Values
An integer value. Lower limit is 1000. Upper limit is 100000 .
Multi-Valued
No
Required
No
Admin Action Required
The Syslog JSON Sync Log Publisher must be restarted if this property is changed and the asynchronous property is set to true.

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


dsconfig Usage

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 Syslog JSON Sync Log Publisher:

dsconfig create-log-publisher
     --publisher-name {name}
     --type {type}
     --set enabled:{propertyValue}
     --set syslog-external-server:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher:

dsconfig delete-log-publisher
     --publisher-name {name}