Metrics Engine Documentation Index
Configuration Reference Home

Error Log Field Mapping

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.

The Error Log Field Mapping provides a mapping to column names in a table used to store error log elements.

Parent Component
Relations to This Component
Properties
dsconfig Usage

Parent Component

The Error Log Field Mapping component inherits from the Log Field Mapping

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ log-field-timestamp
↓ log-field-product-name
↓ log-field-instance-name
↓ log-field-startupid
↓ log-field-category
↓ log-field-severity
↓ log-field-message-id
↓ log-field-message

Basic Properties

description

Description
A description for this Log Field Mapping
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-timestamp

Description
The time that the log message was generated.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-product-name

Description
The name for this Metrics Engine product, which may be used to identify which product was used to log the message if multiple products log to the same database table.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-instance-name

Description
A name that uniquely identifies this Metrics Engine instance, which may be used to identify which instance was used to log the message if multiple server instances log to the same database table.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-startupid

Description
The startup ID for the Metrics Engine. A different value will be generated each time the server is started.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-category

Description
The category for the log message.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-severity

Description
The severity for the log message.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-message-id

Description
The numeric value which uniquely identifies the type of message.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-field-message

Description
The text of the log message.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log Field Mappings:

dsconfig list-log-field-mappings
     [--property {propertyName}] ...

To view the configuration for an existing Log Field Mapping:

dsconfig get-log-field-mapping-prop
     --mapping-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log Field Mapping:

dsconfig set-log-field-mapping-prop
     --mapping-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Error Log Field Mapping:

dsconfig create-log-field-mapping
     --mapping-name {name}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Field Mapping:

dsconfig delete-log-field-mapping
     --mapping-name {name}