Skip to content

Commit b7b32a8

Browse files
committed
docs(readme): and notes about 3.1.0 API change
1 parent 99cfe56 commit b7b32a8

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,17 @@
1212

1313
## ⚠️ Breaking change
1414

15-
With version 3.x.x we have dropped support for Node v0.10. This means that future releases under this major version might contain code changes that are incompatible with Node.js v0.10 to an extent of crashing your application. Please consider updating to a newer runtime, especially that the [maintenance of v0.10 has already ended](node-lts). See our compatibility table below.
16-
15+
With version 3.x.x we have dropped support for Node v0.10. This means that
16+
future releases under this major version might contain code changes that are
17+
incompatible with Node.js v0.10 to an extent of crashing your application.
18+
Please consider updating to a newer runtime, especially that the
19+
[maintenance of v0.10 has already ended](node-lts). See our compatibility table
20+
below.
21+
22+
Also, since 3.1.0 we switched to a different API backend for collecting traces
23+
which is incompatible with the old one. The old endpoint is still supported, but
24+
we would like it to be phased out eventually. Please update your agents to
25+
3.1.0 or newer.
1726

1827
## Installation and usage
1928

@@ -79,10 +88,13 @@ module.exports = {
7988
disableInstrumentations: [
8089
'mongodb'
8190
],
82-
proxy: 'http://168.63.76.32:3128'
91+
proxy: 'http://168.63.76.32:3128',
92+
keepQueryParams: true
8393
}
8494
```
8595

96+
For the complete set of configuration options, visit the [docs](https://trace-docs.risingstack.com/docs/advanced-usage#section-available-options).
97+
8698
*Note: Custom reporters are no longer supported in trace 2.x*
8799

88100
*Note: If you are running your app with NODE_ENV=test, Trace won't start*

0 commit comments

Comments
 (0)