Skip to content

Commit a97a51a

Browse files
committed
Added 'Key AppEvent Properties' section to README.md
1 parent 2a873e9 commit a97a51a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@ Some of these parameters are populated by default and others will need to be sup
1919
Since some of these parameters are common across all event's, the API has the option of setting these on the
2020
TrakerrClient instance (described towards the bottom) and offers a factory API for creating AppEvent's.
2121

22+
### Key AppEvent Properties
23+
24+
#### Log Level, Event Type and Classification
25+
* **Log Level** This enum specifies the logging level to be used for this event ('debug','info','warning','error' or 'fatal')
26+
* **Event Type** This defines the type of event or logger name. This is automatically set for errors.
27+
* **Classification** This is a user settable property that controls how the events are grouped. Defaults to 'Issue'. Set this to a different value to group this event in a different group.
28+
29+
#### Event User, Event Session and Correlation ID
30+
* **Event User** This is the user that is associated with this event. This can be any user data or could be encrypted if privacy is required.
31+
* **Event Session** This is any session specific information associated with this event.
32+
* **Cross App Correlation ID** This is an additional ID that can be used for cross-application correlation of the same event.
33+
34+
#### Operation Time
35+
* **Operation Time** This property in milliseconds measures the operation time for this specific event.
36+
37+
#### Custom properties and segments
38+
In addition to the above, you can use custom properties and segments to send custom event, performance data. These
39+
can then be visualized in Trakerr's dashboards.
40+
2241
### Requirements
2342
- Java 1.7+
2443
- log4j 1.2 (if you want to use our log4j functionality)

0 commit comments

Comments
 (0)