Skip to content

Commit d8a5f53

Browse files
committed
Doc update
1 parent 81a2568 commit d8a5f53

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,25 @@
22

33
Get your application events and errors to Trakerr via the *Trakerr API*.
44

5+
You can send both **errors and non-errors** (plain log statements, for example) to Trakerr with this API.
6+
7+
## Overview
8+
9+
The **3-minute guide** is primarily oriented around sending **errors or warnings** and also do not allow sending additional
10+
parameters. **Option-3 in the detailed integration guide** describes how you could send a non-error (or any log statement) along with additional parameters.
11+
12+
The SDK takes performance impact seriously and all communication between the SDK <=> Trakerr avoids blocking the calling function. The SDK also applies asynchronous patterns where applicable.
13+
14+
A Trakerr *Event* is what is created by this SDK and is then sent to Trakerr for Trakerr to capture. A Trakerr *Event* can consist of various parameters as described here in [Model.AppEvent](https://github.com/trakerr-io/trakerr-csharp/blob/master/generated/docs/AppEvent.md).
15+
Some of these parameters are populated by default and others are optional and can be supplied by you.
16+
17+
Since some of these parameters are common across all event's, the API has the option of setting these on the
18+
TrakerrClient instance (described towards the bottom) and offers a factory API for creating AppEvent's.
19+
520
### Frameworks supported
621
- .NET 4.0 or later
722
- Windows Phone 7.1 (Mango) and later.
823

9-
1024
## Install SDK dependency using Nuget
1125
- [IO.TrakerrClient](http://www.nuget.org/packages/IO.TrakerrClient/) - 1.0.0 or later
1226

@@ -197,7 +211,7 @@ public TrakerrClient(string apiKey = null, string contextAppVersion = null, stri
197211

198212
The TrakerrClient class also has a lot of exposed properties. The benefit to setting these immediately after after you create TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in depth look at each of those.
199213

200-
If you're populating an app event directly, you'll want to take a look at the [AppEvent properties](generated/docs/AppEvent.md) as they contain properties unique to each AppEvent which do not have defaults you may set in the client.
214+
If you're populating an app event directly, you'll want to take a look at the [AppEvent properties](https://github.com/trakerr-io/trakerr-csharp/blob/master/generated/docs/AppEvent.md) as they contain properties unique to each AppEvent which do not have defaults you may set in the client.
201215

202216
Name | Type | Description | Notes
203217
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)