|
| 1 | +# Traceo SDK for Node.js |
| 2 | + |
| 3 | +Library for integration with the [Traceo Platform](https://github.com/traceo-dev/traceo). |
| 4 | + |
| 5 | +### Installation |
| 6 | +To install this SDK add this package to your package.json like below: |
| 7 | +``` |
| 8 | +yarn add @traceo-sdk/node |
| 9 | +``` |
| 10 | +or |
| 11 | +``` |
| 12 | +npm install @traceo-sdk/node |
| 13 | +``` |
| 14 | + |
| 15 | +### Usage |
| 16 | +First what you need is to initialize `TraceoClient` in your application. |
| 17 | +```ts |
| 18 | +import { TraceoClient } from "@traceo-sdk/node"; |
| 19 | + |
| 20 | +new TraceoClient({ |
| 21 | + projectId: <your_project_id>, |
| 22 | + url: <you_traceo_instance_url> |
| 23 | +}); |
| 24 | +``` |
| 25 | + |
| 26 | +`TraceoClient` options require two parameters. `projectId` is a unique identifier of an application created on the Traceo platform. Information about application ID you can get from the Traceo Platform in `Settings|Details` tab. `url` parameter specifies the address where your Traceo Platform instance is located. Address should be passed in the format `<protocol>://<domain>:<port>`, eq. `http://localhost:3000`. |
| 27 | + |
| 28 | +### Incidents handling |
| 29 | +Incidents are all the exceptions and other problems that occur in your application. After each exception occurs, the Traceo SDK catches the exception and sends it to the Traceo Platform. This package provide the two main ways to catch exceptions in your application - `Handlers` and `Middlewares`. |
| 30 | + |
| 31 | +##### Handlers |
| 32 | +The easiest way is to use `ExceptionsHandlers.catchException()` in `try-catch` clause like below: |
| 33 | +```ts |
| 34 | +import { ExceptionHandlers } from "@traceo-sdk/node"; |
| 35 | + |
| 36 | +try { |
| 37 | + //your code |
| 38 | +} catch (error) { |
| 39 | + ExceptionHandlers.catchException(error); |
| 40 | +} |
| 41 | +``` |
| 42 | + |
| 43 | +If you use [NestJS](https://nestjs.com/) framework then you can also create [Interceptor](https://docs.nestjs.com/interceptors) to catch exceptions like below: |
| 44 | + |
| 45 | +traceo.interceptor.ts |
| 46 | +```ts |
| 47 | +import { ExceptionHandlers } from "@traceo-sdk/node"; |
| 48 | +//other imports |
| 49 | + |
| 50 | +@Injectable() |
| 51 | +export class TraceoInterceptor implements NestInterceptor { |
| 52 | + intercept(context: ExecutionContext, next: CallHandler): Observable<any> { |
| 53 | + return next.handle().pipe( |
| 54 | + tap(null, (exception) => { |
| 55 | + ExceptionHandlers.catchException(exception); |
| 56 | + }), |
| 57 | + ); |
| 58 | + } |
| 59 | +} |
| 60 | +``` |
| 61 | + |
| 62 | +main.ts |
| 63 | +```ts |
| 64 | + app.useGlobalInterceptors(new TraceoInterceptor()); |
| 65 | +``` |
| 66 | + |
| 67 | +##### Middleware |
| 68 | +Another approach is to use `ExceptionMiddlewares.errorMiddleware()`. If you use the [Express.js](https://expressjs.com/) framework, you can use our middleware like below: |
| 69 | + |
| 70 | +Javascript: |
| 71 | +```js |
| 72 | +import { ExceptionMiddlewares } from "@traceo-sdk/node"; |
| 73 | + |
| 74 | +app.use(ExceptionMiddlewares.errorMiddleware()); |
| 75 | +``` |
| 76 | + |
| 77 | +Typescript: |
| 78 | +```ts |
| 79 | +const { ExceptionMiddlewares } from "@traceo-sdk/node"; |
| 80 | + |
| 81 | +app.use(ExceptionMiddlewares.errorMiddleware() as express.ErrorRequestHandler); |
| 82 | +``` |
| 83 | + |
| 84 | +Remember that `ExceptionMiddlwares.errorMiddleware()` should be before any other error middlewares and after all routes/controllers. |
| 85 | + |
| 86 | +##### Middleware options |
| 87 | + |
| 88 | + |
| 89 | +| Parameter | Description | Default | |
| 90 | +| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | |
| 91 | +| `allowLocalhost` | If false then middleware doesn't catch exceptions from requests coming from `localhost` | true | |
| 92 | +| `allowHttp` | If false then middleware doesn't catch exceptions received from requests where `req.protocol = http` and catch only exception received with `https` | true | |
| 93 | + |
| 94 | +### Logger |
| 95 | +The Traceo SDK can be used also as a logger. Each log is saved on the Traceo Platform, thanks to which it is possible to later easily access the recorded information. Logs are sent to Traceo in every 60 seconds. To change this behavior, set a custom value (measured in seconds) in the `scrapLogsInterval` field inside traceo client properties like below: |
| 96 | +```ts |
| 97 | +import { TraceoClient } from "@traceo-sdk/node"; |
| 98 | + |
| 99 | +new TraceoClient({ |
| 100 | + scrapLogsInterval: 120 //in seconds |
| 101 | +}); |
| 102 | +``` |
| 103 | + |
| 104 | +Example of using logger: |
| 105 | +```ts |
| 106 | +import { Logger } from "@traceo-sdk/node"; |
| 107 | + |
| 108 | +const traceo = new TraceoClient({...}); |
| 109 | + |
| 110 | +traceo.logger.log("Traceo"); |
| 111 | +``` |
| 112 | + |
| 113 | +The `logger` can use 5 different types of log: `log`, `info`, `debug`, `warn`, `error`. Each function responsible for logging the appropriate log type accepts a list of arguments in the parameter. |
| 114 | +```ts |
| 115 | +traceo.logger.log("Traceo", "Example", "Log"); |
| 116 | +// [TraceoLogger][LOG] - 31.10.2022, 13:55:45 - Traceo Example Log |
| 117 | + |
| 118 | +traceo.logger.debug("Traceo", { |
| 119 | + hello: "World" |
| 120 | +}); |
| 121 | +// [TraceoLogger][DEBUG] - 31.10.2022, 13:58:00 - Traceo { hello: 'World' } |
| 122 | +``` |
| 123 | +### Metrics |
| 124 | +To activate the collection of metrics from your application, set the parameter `collectMetrics` in your `TraceoClient` to true: |
| 125 | + |
| 126 | +```ts |
| 127 | +new TraceoClient({ collectMetrics: true }); |
| 128 | +``` |
| 129 | +Metrics are collected from the application every 30 seconds. If you want to collect metrics at a different time interval then you can use the `scrapMetricsInterval` parameter. |
| 130 | + |
| 131 | +```ts |
| 132 | +new TraceoClient({ scrapMetricsInterval: <interval_in_seconds> }); |
| 133 | +``` |
| 134 | + |
| 135 | +Remember that provided `scrapMetricsInterval` can't be less than `15` seconds. |
| 136 | + |
| 137 | +## Support |
| 138 | +Feel free to create Issues, Pull Request and Discussion. If you want to contact with the developer working on this package click [here](mailto:piotr.szewczyk.software@gmail.com). |
0 commit comments