Log Tags

Each library in the toolkit tags its log messages with its own log tags.

Some modules within a library may use more specific tags in addition to the library-level log tags.

For more information on using log tags to control logger output, see the logging user guide.

Handlers

The following tags are applied to log messages recorded by a handler, as well as all implementation in the Messaging namespace:

TagDescription
handleApplied to all log messages recorded by a handler
messagingApplied to all log messages recorded inside the Messaging namespace

The following tags may be applied to log messages recorded by a handler:

TagDescription
message_dataApplied to log messages that address the handling of a MessageData instance
messageApplied to log messages that address the handling of a typed message
dataApplied to log messages that record the data content of a typed message or a MessageData instance

See the handler user guide for more information on handlers.

Entity Projection

The following tags are applied to log messages recorded by an entity projection:

TagDescription
projectionApplied to all log messages recorded by an entity projection
applyApplied to log messages recorded when applying a typed message or MessageData to an entity

The following tags may be applied to log messages recorded by an entity projection:

TagDescription
messageApplied to log messages that record the projection of a typed message instance
message_dataApplied to log messages that record the projection of a MessageData instance
dataApplied to log messages that record the data content of a typed message or a MessageData instance

See the entity projection user guide for more information on entity projections.

Entity Store

The following tags are applied to log messages recorded by an entity store:

TagDescription
entity_storeApplied to all log messages recorded by an entity store

The following tags may be applied to log messages recorded by an entity store:

TagDescription
fetchApplied to log messages recorded while fetching an entity
getApplied to log messages recorded while getting an entity
refreshApplied to log messages recorded while refreshing an entity
entityApplied to log messages that record the data content of an entity
dataApplied to log messages that record the data content of an entity

See the entity store user guide for more information on entity stores.

Entity Cache

The following tags are applied to log messages recorded by an entity cache:

TagDescription
cacheApplied to all log messages recorded by an entity cache

The following tags may be applied to log messages recorded by an entity cache:

TagDescription
getApplied to log messages recorded while getting an entity from the cache
missApplied to log messages recorded when getting an entity from the cache and the entity is not in the cache
hitApplied to log messages recorded when getting an entity from the cache and the entity is found in the cache
putApplied to log messages recorded while putting an entity into the cache
restoreApplied to log messages recorded while restoring an entity to the cache

See the entity cache user guide for more information on entity caches.

Entity Snapshot

The following tags are applied to log messages recorded by an entity snapshot:

TagDescription
snapshotApplied to all log messages recorded by an entity snapshot
cacheApplied to all log messages recorded by an entity snapshot

The following tags may be applied to log messages recorded by an entity snapshot:

TagDescription
getApplied to log messages recorded while getting an entity from the snapshot store
missApplied to log messages recorded when getting an entity from the snapshot store and the entity snapshot is not stored
hitApplied to log messages recorded when getting an entity from the snapshot store and the entity is found
putApplied to log messages recorded while putting an entity into the snapshot store

See the entity snapshotting user guide for more information on entity snapshotting.

Reader

The following tags are applied to log messages recorded by a reader:

TagDescription
readApplied to all log messages recorded by a reader
message_storeApplied to all log messages recorded inside the MessageStore namespace

See the reader user guide for more information on readers.

Get::Last

The following tags are applied to log messages recorded by a Get::Last:

TagDescription
getApplied to all log messages recorded by a Get::Last
message_storeApplied to all log messages recorded inside the MessageStore namespace

The following tags may be applied to log messages recorded by a Get::Last:

TagDescription
message_dataApplied to log messages that record the data content of a MessageData instance
dataApplied to log messages that record the data content of a MessageData instance

See the Get::Last user guide for more information on the Get::Last class.

Consumer

The following tags are applied to log messages recorded by a consumer:

TagDescription
consumerApplied to all log messages recorded by a consumer

The following tags may be applied to log messages recorded by a consumer:

TagDescription
position_storeApplied to log messages recorded by the consumer's position store
getApplied to log messages recorded while getting an position record from the position store
putApplied to log messages recorded while putting a position record to the position store

See the consumer user guide for more information on consumers.

Component Host

The following tags are applied to log messages recorded by the component host:

TagDescription
component_hostApplied to all log messages recorded inside the ComponentHost namespace

The following tags may be applied to log messages recorded by the component host:

TagDescription
componentApplied to messages that pertain to a component
actorApplied to messages recorded by actors
lifecycleApplied to messages that pertain to the lifecycle of a actors
crashApplied to messages recorded while the host is terminating due to an error
signalApplied to messages recorded when handling operating system signals
startApplied to messages recorded when starting an actor
stopApplied to messages recorded when stopping an actor

See the component host user guide for more information on the component host.

Session

The following tags are applied to log messages recorded by a session:

TagDescription
sessionApplied to all log messages recorded by a session
message_storeApplied to all log messages recorded inside the MessageStore namespace

The following tags may be applied to log messages recorded by a session:

TagDescription
sqlApplied to log messages that record the SQL commands sent to the message store through the session
dataApplied to log messages that record the content of data

See the session user guide for more information on sessions.

Message Writer

The following tags are applied to log messages recorded by a message writer, as well as all implementation in the Messaging namespace::

TagDescription
writeApplied to all log messages recorded by a message writer
messagingApplied to all log messages recorded inside the Messaging namespace

The following tags may be applied to log messages recorded by a message writer:

TagDescription
replyApplied to log messages written by the message writer when replying to a message
messageApplied to log messages that record the writing of a typed message
dataApplied to log messages that record the data content of a typed message

See the message writer user guide for more information on message writers.

Message Data Writer

The following tags are applied to log messages recorded by a message data writer:

TagDescription
writeApplied to all log messages recorded by a message data writer
message_storeApplied to all log messages recorded inside the MessageStore namespace

The following tags may be applied to log messages recorded by a message data writer:

TagDescription
message_dataApplied to log messages that record the writing of a MessageData instance
dataApplied to log messages that record the data content of a MessageData instance

See the message data writer user guide for more information on message data writers.