Skip to content

Commit

Permalink
x-pack/filebeat/docs/ - document gzip S3 object handling (#42306)
Browse files Browse the repository at this point in the history
Document how compressed objects are handled by the aws-s3 input.

(cherry picked from commit 7fd2d46)
  • Loading branch information
andrewkroh authored and mergify[bot] committed Jan 17, 2025
1 parent 63bc269 commit 88da666
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 88da666

Please sign in to comment.