Data Governance Broker 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
Log Messages To Include Basic Properties: Advanced Properties:
↓ debug-message-type  None
↓ http-message-type
↓ oauth-message-type
↓ xacml-policy-message-type
↓ scim-message-type
↓ authentication-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

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
authenticator-request-and-response - The full request and response authenticator parameters.

external-identity-provider-request-and-response - The full HTTP request and response for an outbound request to an External Identity Provider.

http-full-request-and-response - The full HTTP request and response for an inbound request to the Data Governance Broker.

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

policy-decision-trace - The policy decision trace.

saml-message - The XML content of SAML messages sent and received.

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.
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

oauth-message-type

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

code-granted - Code granted.

code-consumed - Code consumed.

token-granted - Token granted.

token-revoked - Token revoked.

token-validation - Token validation.

consent-denied - Consent denied.

consent-permitted - Consent permitted.

consent-requested - Consent requested.

consent-deleted - All consents for a client application deleted.

id-token-granted - Token granted.

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

xacml-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
result - The policy result.
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).
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

authentication-message-type

Property Group
Log Messages To Include
Description
Specifies the authentication and session-related messages which can be logged.
Default Value
No authentication messages are logged.
Allowed Values
authentication-chain-processing - Tracing of authentication chain evaluation processing.

login - Successful and failed logins.

logout - Logout.

second-factor - Successful and failed second-factor authentications.

account-flow - Account flow events.
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}