Skip to content

Commit 369c8a8

Browse files
committed
Added 'Key AppEvent Properties' section to README.md
1 parent d8a5f53 commit 369c8a8

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
@@ -17,6 +17,25 @@ Some of these parameters are populated by default and others are optional and ca
1717
Since some of these parameters are common across all event's, the API has the option of setting these on the
1818
TrakerrClient instance (described towards the bottom) and offers a factory API for creating AppEvent's.
1919

20+
### Key AppEvent Properties
21+
22+
#### Log Level, Event Type and Classification
23+
* **Log Level** This enum specifies the logging level to be used for this event ('debug','info','warning','error' or 'fatal')
24+
* **Event Type** This defines the type of event or logger name. This is automatically set for errors.
25+
* **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.
26+
27+
#### Event User, Event Session and Correlation ID
28+
* **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.
29+
* **Event Session** This is any session specific information associated with this event.
30+
* **Cross App Correlation ID** This is an additional ID that can be used for cross-application correlation of the same event.
31+
32+
#### Operation Time
33+
* **Operation Time** This property in milliseconds measures the operation time for this specific event.
34+
35+
#### Custom properties and segments
36+
In addition to the above, you can use custom properties and segments to send custom event, performance data. These
37+
can then be visualized in Trakerr's dashboards.
38+
2039
### Frameworks supported
2140
- .NET 4.0 or later
2241
- Windows Phone 7.1 (Mango) and later.

0 commit comments

Comments
 (0)