Skip to content
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

[Filebeat] aws-s3 - Document _id generation behavior #42127

Merged

Conversation

andrewkroh
Copy link
Member

@andrewkroh andrewkroh commented Dec 19, 2024

Preview link: https://beats_bk_42127.docs-preview.app.elstc.co/guide/en/beats/filebeat/master/filebeat-input-aws-s3.html

Proposed commit message

Document the details about how the Filebeat aws-s3 input generates
Elasticsearch document _id values.

Add a subsection for the configuration examples.

Move "Common configuration" section immediately after the input
configuration options.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

Screenshots

Before After
Screenshot 2024-12-19 at 16 46 10 Screenshot 2024-12-19 at 17 45 07

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Dec 19, 2024
@botelastic
Copy link

botelastic bot commented Dec 19, 2024

This pull request doesn't have a Team:<team> label.

Copy link
Contributor

mergify bot commented Dec 19, 2024

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @andrewkroh? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

Copy link
Contributor

mergify bot commented Dec 19, 2024

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Dec 19, 2024
@andrewkroh andrewkroh changed the title filebeat aws s3 input docs - Add doc _id generation details [Filebeat] aws-s3 - Document _id generation behavior Dec 19, 2024
Document the details about how the input generates Elasticsearch
document _id values.
Metrics are commonly placed at end of each input's documentation page.
@andrewkroh andrewkroh force-pushed the filebeat/docs/s3-input-doc-id-generation branch from 11e049b to fc42fbe Compare December 19, 2024 21:30
@andrewkroh andrewkroh force-pushed the filebeat/docs/s3-input-doc-id-generation branch from fc42fbe to 9f086da Compare December 19, 2024 22:07
@andrewkroh andrewkroh requested a review from a team December 19, 2024 22:48
@andrewkroh andrewkroh marked this pull request as ready for review December 19, 2024 22:49
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🎸

@andrewkroh andrewkroh merged commit 20a1776 into elastic:main Dec 19, 2024
22 checks passed
mergify bot pushed a commit that referenced this pull request Dec 19, 2024
Document the details about how the Filebeat aws-s3 input generates
Elasticsearch document _id values.

Add a subsection for the configuration examples.

Move "Common configuration" section immediately after the input
configuration options.

(cherry picked from commit 20a1776)
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 docs enhancement Filebeat Filebeat needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants