Data Governance Server Documentation Index
Configuration Reference Home

Writer Based Trace Log Publisher

Note: this is an abstract component that cannot be instantiated.

Writer Based Trace Log Publishers are log publishers that use TextWriter implementations.

↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Writer Based Trace Log Publishers are available in the server :

These Writer Based Trace Log Publishers inherit from the properties described below.

Parent Component

The Writer Based Trace Log Publisher component inherits from the Trace 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 Messages To Include Basic Properties: Advanced Properties:
↓ debug-message-type  None
↓ http-message-type
↓ access-token-validator-message-type
↓ pdp-message-type
↓ policy-message-type
↓ scim-message-type
↓ open-banking-message-type
↓ gateway-message-type
↓ directory-rest-api-message-type
↓ sideband-message-type
↓ pdp-api-message-type
↓ include-path-pattern
↓ exclude-path-pattern
Other Configuration Basic Properties: Advanced Properties:
 None ↓ asynchronous
↓ queue-size
↓ max-string-length

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

debug-message-type

Property Group
Log Messages To Include
Description
Specifies the debug message types which can be logged. Note that enabling these may result in sensitive information being logged.
Default Value
No debug messages are logged.
Allowed Values
http-full-request-and-response - The full HTTP request and response for an inbound request to the Data Governance Server.

ldap-external-server-request - The LDAP request and response for an outbound request performed through an LDAP External Server.

server-sdk-extension - The messages logged by Server SDK extensions.

store-adapter-mapping - Detailed tracing of attributes before and after they are mapped from SCIM to a store adapter and vice-versa.

store-adapter-processing - Detailed tracing of operations processed by store adapters.

access-token-validator-request-and-response - The full HTTP request and response of an outbound request to an external access token validator.

access-token-validator-processing - Detailed information about the processing of incoming access tokens.

consent-service-request-and-response - The full HTTP request and response of an outbound request to a consent service external server.

gateway-request-and-response - The full HTTP request and response of an outbound request from the Data Governance Server to an API server.

policy-request-and-response - The full HTTP request and response of an outbound request to a policy external server.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

http-message-type

Property Group
Log Messages To Include
Description
Specifies the HTTP message types which can be logged.
Default Value
No HTTP messages are logged.
Allowed Values
request - The HTTP request summary.

response - The HTTP response summary.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

access-token-validator-message-type

Property Group
Log Messages To Include
Description
Specifies the access token validator message types that can be logged.
Default Value
No access token validator messages are logged.
Allowed Values
subject-lookup - Access token subject lookup events.

external-server-request - Summary information about an outbound HTTP request made by an access token validator.

external-server-response - Summary information about the response to an outbound HTTP request made by an access token validator.

validation - Access token validation events.

error - Potentially fatal errors in access token validator processing.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

pdp-message-type

Property Group
Log Messages To Include
Description
Specifies the Policy Decision Point (PDP) message types that can be logged.
Default Value
No PDP messages are logged.
Allowed Values
started - PDP started.

stopped - PDP stopped.

info - Informational messages about embedded PDP processing.

warning - Warning messages about embedded PDP processing.

error - PDP error messages, typically concerning initialization or finalization.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

policy-message-type

Property Group
Log Messages To Include
Description
Specifies the policy message types which can be logged.
Default Value
No policy messages are logged.
Allowed Values
request - The policy decision request.

impacted-attributes - The server calculated impactedAttributes for the request.

result - The policy decision result.

advice - Post-policy decision advice processing.

advice-skipped - Advice returned from PDP but not processed.

advice-error - Advice processing error.

request-skipped - A policy request was skipped due to server configuration.

exception - Policy processing exception.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

scim-message-type

Property Group
Log Messages To Include
Description
Specifies the SCIM message types which can be logged.
Default Value
No SCIM messages are logged.
Allowed Values
request - Information about SCIM requests received from clients.

result - Information about the results of SCIM requests received from clients.

internal-request - Information about SCIM requests that initiated internally (for example, operations initiated during processing of a client request).

internal-result - Information about the results of SCIM requests that initiated internally (for example, operations initiated by plugins).

error - SCIM errors caused by exceptions.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

open-banking-message-type

Property Group
Log Messages To Include
Description
Specifies the Open Banking message types which can be logged.
Default Value
No Open Banking messages are logged.
Allowed Values
account-request-created - Account Request created.

account-request-retrieved - Account Request retrieved.

account-request-updated - Account Request updated.

account-request-deleted - Account Request deleted.

error - Open Banking error.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

gateway-message-type

Property Group
Log Messages To Include
Description
Specifies the Gateway HTTP message types which can be logged.
Default Value
No Gateway HTTP messages are logged.
Allowed Values
api-endpoint-selected - Information about the API Endpoint selected to handle a request.

request - The Gateway-to-API server HTTP request summary.

response - The API server-to-Gateway HTTP response summary.

error - Gateway error.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

directory-rest-api-message-type

Property Group
Log Messages To Include
Description
Specifies the Directory REST API message types which can be logged.
Default Value
No Directory REST API messages are logged.
Allowed Values
error - Directory REST API errors caused by exceptions.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

sideband-message-type

Property Group
Log Messages To Include
Description
Specifies the Sideband API message types which can be logged.
Default Value
No Sideband API messages are logged.
Allowed Values
request-received - The Request Gateway-to-Sideband HTTP request summary.

request-result - The Request Sideband-to-Gateway HTTP response summary.

response-received - The Response Gateway-to-Sideband HTTP request summary.

response-result - The Response Sideband-to-Gateway HTTP response summary.

api-endpoint-selected - Information about the Sideband API selecting the API Endpoint used to handle a sideband request.

error - Information about errors that occur while processing a Sideband API request.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

pdp-api-message-type

Property Group
Log Messages To Include
Description
Specifies the PDP API message types that can be logged.
Default Value
No PDP API messages are logged.
Allowed Values
error - Information about errors that occur while processing a PDP API request.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

include-path-pattern

Property Group
Log Messages To Include
Description
Specifies a set of HTTP request URL paths to determine whether log messages are included for a HTTP request. Log messages are included for a HTTP request if the request path does not match any exclude-path-pattern, and the request path does match an include-path-pattern (or no include-path-pattern is specified). Paths are matched using the following rules:
  • '?' matches one character within a path segment
  • '*' matches zero or more characters within a path segment (i.e. does not match the '/' separator)
  • '/**/' matches zero or more segments in a path (segments are separated by '/')

Some pattern examples:

  • /example/t?st - matches /example/test but also /example/tast or /example/txst
  • /example/*.png - matches all .png files directly under /example (does not match /example/path1/test.png)
  • /example/**/test.png - matches all test.png files whose path starts with /example
  • /scim/v2/Users/** - matches the path to any SCIM resource whose resource type endpoint is Users
  • /example/path1/**/*.png - matches all .png files whose path starts with /example/path1
  • /example/**/servlet/bla - matches /example/path1/servlet/bla but also /example/path1/testing/servlet/bla and /example/servlet/bla

Default Value
All request paths are included except any specified in exclude-path-pattern.
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

exclude-path-pattern

Property Group
Log Messages To Include
Description
Specifies a set of HTTP request URL paths to determine whether log messages are excluded for a HTTP request. Log messages are included for a HTTP request if the request path does not match any exclude-path-pattern, and the request path does match an include-path-pattern (or no include-path-pattern is specified). Paths are matched using the following rules:
  • '?' matches one character within a path segment
  • '*' matches zero or more characters within a path segment (i.e. does not match the '/' separator)
  • '/**/' matches zero or more segments in a path (segments are separated by '/')

Some pattern examples:

  • /example/t?st - matches /example/test but also /example/tast or /example/txst
  • /example/*.png - matches all .png files directly under /example (does not match /example/path1/test.png)
  • /example/**/test.png - matches all test.png files whose path starts with /example
  • /scim/v2/Users/** - matches the path to any SCIM resource whose resource type endpoint is Users
  • /example/path1/**/*.png - matches all .png files whose path starts with /example/path1
  • /example/**/servlet/bla - matches /example/path1/servlet/bla but also /example/path1/testing/servlet/bla and /example/servlet/bla

Default Value
No request paths are explicitly excluded.
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


Advanced Properties

asynchronous (Advanced Property)

Property Group
Other Configuration
Description
Indicates whether the Writer Based Trace 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)

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

max-string-length (Advanced Property)

Property Group
Other Configuration
Description
Specifies the maximum number of characters that may be included in any string in a log message before that string is truncated and replaced with a placeholder indicating the number of characters that were omitted. This can help prevent extremely long log messages from being written. A value of zero indicates that no limit will be imposed.
Default Value
50000
Allowed Values
An integer value. Lower limit is 0.
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 delete an existing Log Publisher:

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