|
1 | 1 | # Trakerr - Javascript API Client |
2 | | -Get your application events and errors to Trakerr via the *Trakerr API |
3 | 2 |
|
4 | | -## 3-minute Integration Guide |
| 3 | +Get your application events and errors to Trakerr via the *Trakerr API*. |
| 4 | + |
| 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 does not let you specify additional parameters. |
| 10 | +**Option-4 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* can consist of various parameters as described here in [TrakerrApi.AppEvent](https://github.com/trakerr-com/trakerr-javascript/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 | + |
5 | 20 | ### Requirements |
6 | 21 | Node or Javascript supported Browser. |
7 | 22 | - [superagent.js](https://github.com/visionmedia/superagent) |
8 | 23 | - [stacktrace.js](https://www.stacktracejs.com/) |
9 | 24 |
|
| 25 | +## 3-minute Integration Guide |
| 26 | + |
10 | 27 | ### HTML/Javascript: 3-minute guide |
11 | 28 | Include the following in your HTML |
12 | 29 |
|
@@ -202,19 +219,18 @@ Name | Type | Description | Notes |
202 | 219 | ## Documentation for AppEvent |
203 | 220 | - [TrakerrApi.AppEvent](https://github.com/trakerr-com/trakerr-javascript/blob/master/generated/docs/AppEvent.md) |
204 | 221 |
|
205 | | -## Developer dependencies |
206 | | -- [grunt.js](https://gruntjs.com/) (if you want to build from source) |
| 222 | +## Developer Notes |
| 223 | + |
| 224 | +**Dependencies:** [grunt.js](https://gruntjs.com/) (if you want to build from source) |
207 | 225 |
|
208 | | -## Installation via NPM |
| 226 | +**Installation via NPM:** |
209 | 227 | To install off a branch which may have experimental features, you can use: |
210 | 228 |
|
211 | 229 | ```bash |
212 | 230 | npm install --only=prod --save trakerr-com/trakerr-javascript#<branch name> |
213 | 231 | ``` |
214 | | -without the angle brackets. |
215 | 232 |
|
216 | | -## Building from Source |
217 | | -If you want to build from source for the browser, use the following command: |
| 233 | +**Building from Source:** If you want to build from source for the browser, use the following command: |
218 | 234 |
|
219 | 235 | ```bash |
220 | 236 | npm install [--save] trakerr-com/trakerr-javascript |
|
0 commit comments