You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,13 @@ As Trace uses scoped packages, be sure to use npm version greater than 2.7.0.
32
32
npm install --save @risingstack/trace
33
33
```
34
34
35
-
*If you can't update to [email protected] for whatever reason, you can still install Trace using `npm i risingstack/trace-nodejs`.*
35
+
> ⚠️
36
+
37
+
>Trace depends on a couple of native addons. We host precompiled
38
+
binaries of these for Linux and Darwin 64-bit platforms at https://oss.risingstack.com.
39
+
The installer will attempt to download these dependencies, so it should be allowed
40
+
through your firewall, or else the download will fail and the installer will fall back
41
+
to building from source. This also happens if there isn't a precompiled binary for your platform. Note that compiling native addons requires native toolchain.
36
42
37
43
After you installed Trace as a dependency, you just require it at the beginning of your main file.
38
44
```javascript
@@ -95,13 +101,14 @@ module.exports = {
95
101
96
102
For the complete set of configuration options, visit the [docs](https://trace-docs.risingstack.com/docs/advanced-usage#section-available-options).
97
103
98
-
*Note: Custom reporters are no longer supported in trace 2.x*
99
104
100
-
*Note: If you are running your app with NODE_ENV=test, Trace won't start*
105
+
> ⚠️
106
+
107
+
>If you are running your app with NODE_ENV=test, Trace won't start
101
108
102
109
## API
103
110
104
-
### trace.report(String, [Object])
111
+
### trace.report(name, object)
105
112
106
113
This method can be use to report additional data to the Trace servers which later on helps with debugging.
107
114
@@ -114,10 +121,9 @@ trace.report('name', {
114
121
Throws an error if first parameter is not a String.
115
122
Throws an error if second parameter is not an Object.
116
123
117
-
### trace.reportError(String, Error)
124
+
### trace.reportError(name, error)
118
125
119
-
This method can be used to send errors to the Trace servers - note that transactions that use
120
-
this method are not subject to sampling, so it will be collected all the time.
126
+
This method can be used to send errors to the Trace servers.
0 commit comments