Data Sync Server Documentation Index
Configuration Reference Home

Console JSON Sync Failed Ops Log Publisher

Console JSON Sync Failed Ops Log Publishers publish JSON-formatted Sync log messages to the JVM's original standard output or standard error stream.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Console JSON Sync Failed Ops Log Publisher component inherits from the JSON Formatted Sync Failed Ops Log Publisher

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
↓ output-location
Synchronization Configuration Basic Properties: Advanced Properties:
↓ include-sync-pipe  None
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 Console JSON Sync Failed Ops Log Publisher is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
The Console JSON Sync Failed Ops Log Publisher is primarily intended to be used for server instances that are run in no-detach mode (that is, instances that are started with the --nodetach argument). When the logger is used in a server that is not running in no-detach mode, it may have reduced performance and functionality.

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

output-location

Property Group
Log File Management
Description
Specifies the output stream to which JSON-formatted Sync Failed Ops log messages should be written.
Default Value
standard-output
Allowed Values
standard-output - Messages should be written to the JVM's original standard output stream.

standard-error - Messages should be written to the JVM's original standard error stream.
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

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

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 Console JSON Sync Failed Ops Log Publisher:

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

To delete an existing Log Publisher:

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