node: Optional request body compression

[rhcarvalho]

Summary

Add option to enable compression of event payloads before sending them with @sentry/node.

Motivation

Sometimes it might be beneficial to compress request bodies before sending to Sentry. This would trade some CPU and extra dependencies for less bytes over the network.

Additional Context

This was an ask/observation from @thinkocapo.

---

The old raven-node SDK unconditionally compressed outgoing request bodies using the zlib package from Node.js' standard library:

https://github.com/getsentry/sentry-javascript/blob/7b664ff3a828fe59e32ccc182d5b4bb449dc9402/packages/raven-node/lib/client.js#L335

---

If this is ever implemented, the performance considerations discussed in the Node.js documentation and the care to limit concurrency as in raven-node should be taken into account:

• https://nodejs.org/api/zlib.html#zlib_threadpool_usage_and_performance_considerations
• https://nodejs.org/api/zlib.html#zlib_compressing_http_requests_and_responses
• https://nodejs.org/api/zlib.html#zlib_memory_usage_tuning

[jarektomanek]

Is this feature planned for implementation for sentry-javascript?

Transaction payload can easily grow to sizes of 100 KB or more when multiple extra spans are added (f.e. @Sentry.TraceMethodDecorator() added to ngOnChanges). This is suboptimal for UX. Having requests' compression would be appreciated.

[smeubank]

closing for now until we receive more demand for this feature