From 88da666cd033c91662ce7b34b9604a675547d5ef Mon Sep 17 00:00:00 2001 From: Andrew Kroh Date: Fri, 17 Jan 2025 09:59:01 -0500 Subject: [PATCH] x-pack/filebeat/docs/ - document gzip S3 object handling (#42306) Document how compressed objects are handled by the aws-s3 input. (cherry picked from commit 7fd2d46de08af303eec645c28150ae47565bca0c) --- x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc b/x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc index 1e4d61b3f53..5474f03547a 100644 --- a/x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc +++ b/x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc @@ -172,13 +172,22 @@ Node pipeline. } ---- +[float] +=== Handling Compressed Objects + +S3 objects that use the gzip format +(https://rfc-editor.org/rfc/rfc1952.html[RFC 1952]) with the DEFLATE compression +algorithm are automatically decompressed during processing. This is achieved by +checking for the gzip file magic header. + [float] === Configuration The `aws-s3` input supports the following configuration options plus the <<{beatname_lc}-input-{type}-common-options>> described later. -NOTE: For time durations, valid time units are - "ns", "us" (or "µs"), "ms", "s", "m", "h". For example, "2h" +NOTE: For time durations, valid time units are - "ns", "us" (or "µs"), "ms", +"s", "m", "h". For example, "2h" [float] ==== `api_timeout`