HPELTextLog

This type is a class for model objects.

TextLog (optional) which provides a format like SystemOut.log. Can be generated on the fly, but this also enables it at runtime

Package: ras

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  HighPerformanceExtensibleLogging.hpelTextLog



Attributes Summary
enabled : EBoolean Whether or not the text log is enabled
dataDirectory : EString Directory under which the repository will be created.
purgeBySizeEnabled : EBoolean Enable the purging of records by size. Note that, if purge by size AND purge by time are both enabled, then records are purged if either of the 2 criteria are met.
purgeMaxSize : EInt Size in megabytes at which entries can be purged.
purgeByTimeEnabled : EBoolean Enable the purging of records by tme. Note that, if purge by size AND purge by time are both enabled, then records are purged if either of the 2 criteria are met.
purgeMinTime : EInt Time in hours at which entries can be purged.
outputFormat : OutputFormatKind Special formatting string for the text log
outOfSpaceAction : OutOfSpaceActionKind Action to take if repository is out of space (physical space or space configured).
bufferingEnabled : EBoolean Allow buffering for performance. This may cause some latency (usually imperceptible) in logging appearing in the file, and it makes writing notably faster, especially in high volume situations.
fileSwitchEnabled : EBoolean Close current file associated with logging and open a new file. This will happen automatically on server restart and at other times based on space management. This is purely a convenience facility for customers.
fileSwitchTime : EInt Hour at which to switch to a new file. Dflt of 0 = midnight.
traceIncluded : EBoolean Boolean to determine whether or not trace information should also be logged to the TextLog. The TextLog should not be used in high volume production environments. When it is used, tracing to it can cause additional performance overhead.



Attribute Details

enabled  -  Whether or not the text log is enabled
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

dataDirectory  -  Directory under which the repository will be created.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

purgeBySizeEnabled  -  Enable the purging of records by size. Note that, if purge by size AND purge by time are both enabled, then records are purged if either of the 2 criteria are met.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

purgeMaxSize  -  Size in megabytes at which entries can be purged.
    Data Type: EInt
    Default value:  50
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

purgeByTimeEnabled  -  Enable the purging of records by tme. Note that, if purge by size AND purge by time are both enabled, then records are purged if either of the 2 criteria are met.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

purgeMinTime  -  Time in hours at which entries can be purged.
    Data Type: EInt
    Default value:  48
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

outputFormat  -  Special formatting string for the text log
    Data Type: OutputFormatKind
    Default value:  BASIC
    Allowed values:
        0 - BASIC
        1 - ADVANCED
        2 - LOG_ANALYZER
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

outOfSpaceAction  -  Action to take if repository is out of space (physical space or space configured).
    Data Type: OutOfSpaceActionKind
    Default value:  PurgeOld
    Allowed values:
        0 - StopServer
        1 - PurgeOld
        2 - StopLogging
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

bufferingEnabled  -  Allow buffering for performance. This may cause some latency (usually imperceptible) in logging appearing in the file, and it makes writing notably faster, especially in high volume situations.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

fileSwitchEnabled  -  Close current file associated with logging and open a new file. This will happen automatically on server restart and at other times based on space management. This is purely a convenience facility for customers.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

fileSwitchTime  -  Hour at which to switch to a new file. Dflt of 0 = midnight.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

traceIncluded  -  Boolean to determine whether or not trace information should also be logged to the TextLog. The TextLog should not be used in high volume production environments. When it is used, tracing to it can cause additional performance overhead.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006