-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[aws] [s3] Introduce ignore_older & start_timestamp for S3 input allowing better registry cleanups #41817
Merged
Kavindu-Dodan
merged 9 commits into
elastic:main
from
Kavindu-Dodan:feat/s3-input-start-time-and-ignore-old
Jan 7, 2025
Merged
[aws] [s3] Introduce ignore_older & start_timestamp for S3 input allowing better registry cleanups #41817
Kavindu-Dodan
merged 9 commits into
elastic:main
from
Kavindu-Dodan:feat/s3-input-start-time-and-ignore-old
Jan 7, 2025
+687
−35
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kavindu-Dodan
added
enhancement
Team:obs-ds-hosted-services
Label for the Observability Hosted Services team
backport-8.x
Automated backport to the 8.x branch with mergify
labels
Nov 27, 2024
botelastic
bot
added
needs_team
Indicates that the issue/PR needs a Team:* label
and removed
needs_team
Indicates that the issue/PR needs a Team:* label
labels
Nov 27, 2024
6 tasks
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
2 times, most recently
from
November 27, 2024 22:32
4924d70
to
79ae2c1
Compare
Kavindu-Dodan
commented
Nov 27, 2024
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
December 3, 2024 23:06
52fad61
to
6f5472c
Compare
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
December 6, 2024 16:58
6f5472c
to
ec00024
Compare
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
2 times, most recently
from
December 6, 2024 19:53
85f883e
to
fb4990b
Compare
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
December 6, 2024 20:48
fb4990b
to
dab88c6
Compare
leehinman
approved these changes
Dec 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but I'd like @faec to take a look.
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
December 31, 2024 15:37
dab88c6
to
459e3c9
Compare
constanca-m
reviewed
Jan 2, 2025
constanca-m
reviewed
Jan 2, 2025
constanca-m
reviewed
Jan 2, 2025
constanca-m
reviewed
Jan 2, 2025
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
January 2, 2025 20:49
ce2786a
to
d678713
Compare
constanca-m
approved these changes
Jan 3, 2025
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
January 3, 2025 14:17
d678713
to
3a4c0bd
Compare
bturquet
added
the
Team:Elastic-Agent-Data-Plane
Label for the Agent Data Plane team
label
Jan 6, 2025
Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane) |
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
…them Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> # Conflicts: # x-pack/filebeat/input/awss3/s3_test.go
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
…tation Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co>
Kavindu-Dodan
force-pushed
the
feat/s3-input-start-time-and-ignore-old
branch
from
January 7, 2025 15:13
3a4c0bd
to
82db670
Compare
mergify bot
pushed a commit
that referenced
this pull request
Jan 7, 2025
…wing better registry cleanups (#41817) * add changelog entry Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * sort config entries Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * introduce ignore old and start timestamp configurations and document them Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * add filtering logic Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * filter tests Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * add component test for filtering and fix lint issues Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> # Conflicts: # x-pack/filebeat/input/awss3/s3_test.go * add changelog entry Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * improve documentation Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * review changes - improve naming, change signature and improve documentation Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> --------- Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> (cherry picked from commit 4ba7d1c)
6 tasks
Kavindu-Dodan
added a commit
that referenced
this pull request
Jan 7, 2025
…wing better registry cleanups (#41817) (#42246) * add changelog entry Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * sort config entries Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * introduce ignore old and start timestamp configurations and document them Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * add filtering logic Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * filter tests Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * add component test for filtering and fix lint issues Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> # Conflicts: # x-pack/filebeat/input/awss3/s3_test.go * add changelog entry Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * improve documentation Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> * review changes - improve naming, change signature and improve documentation Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> --------- Signed-off-by: Kavindu Dodanduwa <kavindu.dodanduwa@elastic.co> (cherry picked from commit 4ba7d1c) Co-authored-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport-8.x
Automated backport to the 8.x branch with mergify
enhancement
Team:Elastic-Agent-Data-Plane
Label for the Agent Data Plane team
Team:obs-ds-hosted-services
Label for the Observability Hosted Services team
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed commit message
Introduce
ignore_older
andstart_timestamp
properties to AWS S3 input. This is a follow-up for #41694.The configurations introduced here act as input object filters. If the object fails to match derived filters, the entries will be cleaned up from the registry, reducing filebeat memory consumption.
Introduced configurations are,
For both inputs, the object's last modified timestamp is taken into comparison. See Use cases section for further explanation
Checklist
CHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.Disruptive User Impact
None as defaults are disabled. However, when configurations introduced here are used, the following can have an impact on the user,
start_timestamp
is defined, then objects with the last modified timestamps prior to the timestamp are ignored from processing (documented 1)ignore_older
is defined, then objects that do not fall within the look-back period when processing starts (polling run) are ignored (documented 1)start_timestamp
&ignore_older
are defined, the initial run will process all entries up tostart_timestamp
. The subsequent runs will not include entries that do not fall withinignore_older
even if processing failed for an object. (documented 1)How to test this PR locally
ignore_older
&start_timestamp
to see how data ingestion change with their values. See Use cases section for further explanationRelated issues
aws-s3
input's bucket polling accumulates state in the registry #39116Use cases
Consider below diagrams where there're 3 objects Object A, Object B and Object C with their last modified timestamps of t1, t2 and t3.
And consider how filebeat processes and tracks registry entries based on the following scenarios
Default behavior
If none of the configurations are used, then filebeat will process and the internal registry will track all objects continuously unless they are removed from the bucket.
Use start_timestamp
If
start_timestamp
is used, objects newer than the timestamp are accepted for processing. The registry will grow unless objects are removed from the bucket by other means (ex:- lifecycle policy).Use ignore_older
If
ignore_older
is defined, input will process objects within the provided duration, calculated from the current time. The registry will track objects within the current timeframe and others will get cleaned up eventually by subsequent runs.Use both ignore_older & start_timestamp
If both properties are defined,
ignore_older
duration).ignore_older
duration.Footnotes
https://github.com/elastic/beats/pull/41817/files#diff-422765b7341c5bbf6de7af38927e34e00a5073b188585a7af3c4fee1175b64a6 ↩ ↩2 ↩3
https://github.com/Kavindu-Dodan/data-gen ↩