ref(relay): Switch default envelope compression to zstd (#4531)

Relay supports accepting zstd for a while now, let's switch the default.
This makes sending envelopes much more CPU efficient.

Author: Dav1dde

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 **Features**:
 
+- Switch default envelope compression from gzip to zstd. ([#4531](https://github.com/getsentry/relay/pull/4531))
 - Update release to include an aarch64 binary. ([#4514](https://github.com/getsentry/relay/pull/4514))
 - Support span `category` inference from span attributes. ([#4509](https://github.com/getsentry/relay/pull/4509))
 - Add option to control ourlogs ingestion. ([#4518](https://github.com/getsentry/relay/pull/4518))

relay-config/src/config.rs

@@ -722,13 +722,14 @@ pub struct Routing {
 }
 
 /// Http content encoding for both incoming and outgoing web requests.
-#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
+#[derive(Clone, Copy, Debug, Default, Deserialize, Serialize)]
 #[serde(rename_all = "lowercase")]
 pub enum HttpEncoding {
     /// Identity function without no compression.
     ///
     /// This is the default encoding and does not require the presence of the `content-encoding`
     /// HTTP header.
+    #[default]
     Identity,
     /// Compression using a [zlib](https://en.wikipedia.org/wiki/Zlib) structure with
     /// [deflate](https://en.wikipedia.org/wiki/DEFLATE) encoding.
@@ -780,12 +781,6 @@ impl HttpEncoding {
     }
 }
 
-impl Default for HttpEncoding {
-    fn default() -> Self {
-        Self::Identity
-    }
-}
-
 /// Controls authentication with upstream.
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(default)]
@@ -830,7 +825,7 @@ pub struct Http {
     pub project_failure_interval: u64,
     /// Content encoding to apply to upstream store requests.
     ///
-    /// By default, Relay applies `gzip` content encoding to compress upstream requests. Compression
+    /// By default, Relay applies `zstd` content encoding to compress upstream requests. Compression
     /// can be disabled to reduce CPU consumption, but at the expense of increased network traffic.
     ///
     /// This setting applies to all store requests of SDK data, including events, transactions,
@@ -842,6 +837,7 @@ pub struct Http {
     ///  - `deflate`: Compression using a zlib header with deflate encoding.
     ///  - `gzip` (default): Compression using gzip.
     ///  - `br`: Compression using the brotli algorithm.
+    ///  - `zstd`: Compression using the zstd algorithm.
     pub encoding: HttpEncoding,
     /// Submit metrics globally through a shared endpoint.
     ///
@@ -863,7 +859,7 @@ impl Default for Http {
             outage_grace_period: DEFAULT_NETWORK_OUTAGE_GRACE_PERIOD,
             retry_delay: default_retry_delay(),
             project_failure_interval: default_project_failure_interval(),
-            encoding: HttpEncoding::Gzip,
+            encoding: HttpEncoding::Zstd,
             global_metrics: false,
         }
     }

tests/integration/fixtures/mini_sentry.py

@@ -1,6 +1,6 @@
 import datetime
 import copy
-import gzip
+import zstandard
 import json
 import os
 import re
@@ -318,9 +318,13 @@ def store_internal_error_event():
     @app.route("/api/42/envelope/", methods=["POST"])
     def store_event():
         assert (
-            flask_request.headers.get("Content-Encoding", "") == "gzip"
+            flask_request.headers.get("Content-Encoding", "") == "zstd"
         ), "Relay should always compress store requests"
-        data = gzip.decompress(flask_request.data)
+
+        with zstandard.ZstdDecompressor().stream_reader(
+            flask_request.data
+        ) as decompressor:
+            data = decompressor.read()
 
         assert (
             flask_request.headers.get("Content-Type") == "application/x-sentry-envelope"
@@ -454,8 +458,11 @@ def global_metrics():
             abort(403, "relay not registered")
 
         encoding = flask_request.headers.get("Content-Encoding", "")
-        assert encoding == "gzip", "Relay should always compress store requests"
-        data = gzip.decompress(flask_request.data)
+        assert encoding == "zstd", "Relay should always compress store requests"
+        with zstandard.ZstdDecompressor().stream_reader(
+            flask_request.data
+        ) as decompressor:
+            data = decompressor.read()
 
         metrics_batch = json.loads(data)["buckets"]
         sentry.captured_metrics.put(metrics_batch)