docs(azure_blob sink, gcp_cloud_storage sink): Note transparent decom…

…pression (#21814) Copy note from AWS S3 sink. Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
vectordotdev · Nov 15, 2024 · 983a993 · 983a993
1 parent 9e97385
commit 983a993
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/src/sinks/azure_blob/config.rs b/src/sinks/azure_blob/config.rs
@@ -143,6 +143,12 @@ pub struct AzureBlobSinkConfig {
     #[serde(flatten)]
     pub encoding: EncodingConfigWithFraming,
 
+    /// Compression configuration.
+    ///
+    /// All compression algorithms use the default compression level unless otherwise specified.
+    ///
+    /// Some cloud storage API clients and browsers handle decompression transparently, so
+    /// depending on how they are accessed, files may not always appear to be compressed.
     #[configurable(derived)]
     #[serde(default = "Compression::gzip_default")]
     pub compression: Compression,

diff --git a/src/sinks/gcp/cloud_storage.rs b/src/sinks/gcp/cloud_storage.rs
@@ -148,6 +148,12 @@ pub struct GcsSinkConfig {
     #[serde(flatten)]
     encoding: EncodingConfigWithFraming,
 
+    /// Compression configuration.
+    ///
+    /// All compression algorithms use the default compression level unless otherwise specified.
+    ///
+    /// Some cloud storage API clients and browsers handle decompression transparently, so
+    /// depending on how they are accessed, files may not always appear to be compressed.
     #[configurable(derived)]
     #[serde(default)]
     compression: Compression,

diff --git a/website/cue/reference/components/sinks/base/azure_blob.cue b/website/cue/reference/components/sinks/base/azure_blob.cue
@@ -116,6 +116,9 @@ base: components: sinks: azure_blob: configuration: {
 			Compression configuration.
 
 			All compression algorithms use the default compression level unless otherwise specified.
+
+			Some cloud storage API clients and browsers handle decompression transparently, so
+			depending on how they are accessed, files may not always appear to be compressed.
 			"""
 		required: false
 		type: string: {

diff --git a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue
@@ -140,6 +140,9 @@ base: components: sinks: gcp_cloud_storage: configuration: {
 			Compression configuration.
 
 			All compression algorithms use the default compression level unless otherwise specified.
+
+			Some cloud storage API clients and browsers handle decompression transparently, so
+			depending on how they are accessed, files may not always appear to be compressed.
 			"""
 		required: false
 		type: string: {