TNT4J Events Field Mappings Basics

<parser name="TokenParser" class="com.jkoolcloud.tnt4j.streams.parsers.ActivityTokenParser">
    <.../>
    <field name="StartTime" locator="1" format="dd MMM yyyy HH:mm:ss" locale="en-US"/>
    <field name="ServerIp" locator="2"/>
    <field name="ApplName" value="orders"/>
    <field name="Correlator" locator="3"/>
    <field name="UserName" locator="4"/>
    <field name="EventName" locator="5"/>
    <field name="EventType" locator="5">
        <field-map source="Order Placed" target="START"/>
        <field-map source="Order Received" target="RECEIVE"/>
        <field-map source="Order Processing" target="OPEN"/>
        <field-map source="Order Processed" target="SEND"/>
        <field-map source="Order Shipped" target="END"/>
    </field>
    <field name="MsgValue" locator="8"/>
</parser>

Predefined Fields Set

/**
 * Name of application associated with the activity.
 */
ApplName(String.class),

/**
 * Host name of server to associate with activity.
 */
ServerName(String.class),

/**
 * IP Address of server to associate with activity.
 */
ServerIp(String.class),

/**
 * Name to assign to activity entry. Examples are operation, method, API call, event, etc.
 */
EventName(String.class),

/**
 * Type of activity - value must match values in {@link com.jkoolcloud.tnt4j.core.OpType} enumeration.
 */
EventType(Enum.class),

/**
 * Status of activity - value must match values in {@link com.jkoolcloud.tnt4j.core.ActivityStatus} enumeration.
 */
EventStatus(Enum.class),

/**
 * Time action associated with activity started.
 */
StartTime(UsecTimestamp.class),

/**
 * Time action associated with activity ended.
 */
EndTime(UsecTimestamp.class),

/**
 * Elapsed time of the activity in microseconds.
 */
ElapsedTime(Long.class),

/**
 * Identifier of process where activity event has occurred.
 */
ProcessId(Integer.class),

/**
 * Identifier of thread where activity event has occurred.
 */
ThreadId(Integer.class),

/**
 * Indicates completion status of the activity - value must match values in {@link com.jkoolcloud.tnt4j.core.OpCompCode} enumeration.
 */
CompCode(Enum.class),

/**
 * Numeric reason/error code associated with the activity.
 */
ReasonCode(Integer.class),

/**
 * Error/exception message associated with the activity.
 */
Exception(String.class),

/**
 * Indicates completion status of the activity - value can either be label from {@link com.jkoolcloud.tnt4j.core.OpLevel} enumeration 
 * or a numeric value.
 */
Severity(Enum.class),

/**
 * Location that activity occurred at.
 */
Location(String.class),

/**
 * Identifier used to correlate/relate activity entries to group them into logical entities.
 */
Correlator(String[].class),

/**
 * User-defined label to associate with the activity, generally for locating activity.
 */
Tag(String[].class),

/**
 * Name of user associated with the activity.
 */
UserName(String.class),

/**
 * Name of resource associated with the activity.
 */
ResourceName(String.class),

/**
 * User data to associate with the activity.
 */
Message(String.class),

/**
 * Identifier used to uniquely identify the data associated with this activity.
 */
TrackingId(String.class),

/**
 * Length of activity event message data.
 */
MsgLength(Integer.class),

/**
 * MIME type of activity event message data.
 */
MsgMimeType(String.class),

/**
 * Encoding of activity event message data.
 */
MsgEncoding(String.class),

/**
 * CharSet of activity event message data.
 */
MsgCharSet(String.class),

/**
 * Type of log entry.
 */
LogType(String.class),

/**
 * Age of activity event message.
 */
MessageAge(Long.class),

/**
 * Activity event category name.
 */
Category(String.class),

/**
 * Identifier used to uniquely identify parent activity associated with this activity.
 */
ParentId(String.class),

/**
 * Identifier used to globally identify the data associated with this activity.
 */
Guid(String.class),

/**
 * Stream activity entity time-to-live attribute.
 */
TTL(Long.class);

<field name="Transport" locator="ActivityTransport" locator-type="Label"/>
<field name="Topic" locator="TopicName" locator-type="Label"/>

/**
 * Indicates that raw data value is the value of a named property of the current stream.
 */
StreamProp(String.class),

/**
 * Indicates that raw data value is at a specified index location, offset, etc. This is a generic index/offset value whose 
 * interpretation is up to the specific parser applying the locator. It also can be index of RegEx group.
 */
Index(Integer.class),

/**
 * Indicates that raw data value is the value of a particular key or label. Examples of this are XPath expressions for XML elements, 
 * and where each element of a raw activity data string is a name/value pair. It also can be name of RegEx group.
 */
Label(String.class),

/**
 * Indicates that raw data value is the value of a specific regular expression match, for parsers that interpret the
 * raw activity data using a regular expression pattern defined as a sequence of repeating match patterns. Match
 * identifier can be group sequence number or name.
 *
 * @deprecated use {@link #Label} instead. 
 */
@Deprecated
REMatchId(String.class),

/**
 * Indicates that data value is the value from stream stored cache with specified cache entry key.
 */
Cache(String.class),

/**
 * Indicates that data value is the value from currently processed activity data entity with specified entity field name.
 */
Activity(String.class),

/**
 * Indicates that data value shall be evaluated by using provided expression for parser context data.
 */
Expression(String.class),

/**
 * Indicates that raw data value is the value of a named property of the current parser.
 */
ParserProp(String.class),

/**
 * Indicates that raw data value is the value of a named JVM System property.
 */
SystemProp(String.class),

/**
 * Indicates that raw data value is the value of a named OS Environment variable.
 */
EnvVariable(String.class);

Index is default value and may be suppressed in field/locator definition:

this:

<field name="UserName" locator="4"/>

is the same as:

<field name="UserName" locator="4" locator-type="Index"/>

Obsolete (yet backward-compatible) locator types:

• REGroupName - now should be changed to Label
• REGroupNum - now should be changed to Index
• REMatchId - now should be changed to Label
• REMatchNum - now should be changed to Index

Click here to learn more about TNT4J Events Field Mappings.