Base Event Format Attribute Reference

Attribute Field Key Description
Creation Time _cl.creationTime The time the log event was created.
Expiration Time in DB _cl.expirationTimeInDB Expiration time (in hours) of log record. Log record will be automatically purged from db if it expires from the creation time.
Msg ID _cl.msgId Identifier of the log event message.
Msg _cl.msg The event message string.
Physical Component ID _cl.physicalCompId.key name Physical component identifier category. Subcategories are either generic or identified by a scheme. Contains a scheme field and fields defined by the scheme.
  • Generic Physical Component ID A generic physical component identifier. Contains a scheme field and up to eight fields defined by the scheme. Used to search for log events that don't have a scheme or whose scheme is not supported by the Log Viewer. For example, an application could specify a Generic Physical Component ID with field1 named cluster_name and field2 called host_name.
  • AMX Physical Component ID

    An ActiveMatrix physical component identifier. The ActiveMatrix scheme identifier is amx. The ID is: amx#environment name#host name#node name#typeadapter name.

Logical Component ID _cl.logicalCompId.key name Logical component identifier category. Subcategories are either generic or identified by a scheme. Contains a scheme field and fields defined by the scheme.
  • Generic Logical Component ID A generic logical component identifier. Contains a scheme field and up to eight fields defined by the scheme. Used to search for log events that don't have a scheme or whose scheme is not supported by the Log Viewer.
  • AMX Logical Component ID

    A TIBCO ActiveMatrix logical component identifier. The scheme identifier is amx. The ID is: amx#application#service name#operation name.

Scheme _cl.logicalCompId.scheme The logger name’s type: amx or bw.
Logger Name _cl.reportingCompId.Value The name of the destination for the log events.
Class Loader _cl.reportingCompId.Classloader The class loader active at the time the event was logged.
Hierarchy _cl.reportingCompId.hierarchyName The hierarchy of entities when the event was logged.
Global Instance ID _cl.globalInstanceId Globally unique identifier of the log event.
Correlation ID _cl.correlationId The ID to correlate the context with which the log event is associated with another context in the same message exchange.
Location ID _cl.locationId A physical address that corresponds to the location of a component.
Context ID _cl.contextId An identifier of the context with which the log event is associated.
Parent Context ID _cl.parentContextId An identifier of the parent context of the context with which the log event is associated.
Classifier _cl.classifier.key name

A set of name-value pairs. The name and the value are strings composed of any alphanumeric characters.

Supports searching for log events based on log event contents. For example, you could search for log records with the following classifiers:

classifierA: name=PONumber value=0001

classifierB: name=BuyerName value=aBuyer

Situation _cl.situation The situation that caused the log event to be generated. For the list of situation types and the contexts in which the situation type applies, see Table 110.
Security Principal _cl.securityPrincipal The authenticated entity that created the log event.

Situation Types

enumerates the situation types that cause components to log events and describes the Situation Types contexts in which the situation applies.

Situation Types
Situation Type Description
StartSituation Deals with the component startup process. Messages indicate that a component has finished the startup process or that it has aborted the startup process. Existing messages include words such as: starting, started, initializing, and initialized.
StopSituation Deals with the component shutdown process. Messages indicate that a component has begun to stop, that it has stopped, or that the stopping process has failed. Existing messages include words such as: stop, stopping, stopped, completed, and exiting.
ConnectSituation Deals with aspects of a component’s connection to another component. Messages indicate that a connection failed, that a connection was created, or that a connection was ended. Existing messages include words such as: connection reset, connection failed, and failed to get a connection.
RequestSituation Deals with the situations that identify the completion status of a request. Typically these requests are complex management tasks or transactions that a component undertakes on behalf of a requestor and not the mainline simple requests or transactions. Existing messages include words such as: configuration synchronization started and backup procedure complete.
ConfigureSituation Deals with components identifying their configuration. Any changes that a component makes to its configuration or that describe current configuration state should be logged using this category. Existing messages include words such as: port number ID, address ID, and process ID.
AvailableSituation Deals with component operational state and availability. Provides a context for operations that can be performed on the component by distinguishing if a product is installed, operational and ready to process functional requests, or operational and ready or not ready to process management requests. Existing messages include words such as: ready to take requests, online, and offline.
ReportSituation Deals with the situations reported from the component, such as heartbeat or performance information. Messages indicate current CPU utilization and current memory heap size. Existing messages include words such as: utilization value is, buffer size is, and number of threads is.
CreateSituation Deals with the situations documenting when a component creates an entity. Messages indicate a document was created or a file was created. Existing messages include words such as: was created, about to create, and now exists.
DestroySituation Deals with the situations documenting when a component removes or destroys an entity. Messages indicate that a document was destroyed or a file was deleted. Existing message include words such as: was created, about to create, and now exists.
FeatureSituation Deals with the situations that announce that a feature of a component is ready (or not ready) for service requests. Message indicate services being available and services or features being unavailable. Existing messages include words such as: now available, currently available, and transport is listening on port 123.
DependencySituation Deals with the situations in which components cannot find some component or feature that they require. Messages indicate a resource was not found, that an application or subsystem that was unavailable, or that the expected version of a component was not found. Existing messages include words such as: could not find and no such component.
OtherSituation Provides support for product-specific situations other than the predefined categories.