Skip to content

Adds performance saving recommendations to Cloudtrail docs#18887

Open
jmikell821 wants to merge 4 commits intomainfrom
docs-enhancement/issue-5687
Open

Adds performance saving recommendations to Cloudtrail docs#18887
jmikell821 wants to merge 4 commits intomainfrom
docs-enhancement/issue-5687

Conversation

@jmikell821
Copy link
Copy Markdown
Member

@jmikell821 jmikell821 commented May 7, 2026

Proposed commit message

Adds info to the Cloudtrail integration docs to make it clear that pulling data from S3 Buckets without ignore_older and start_timestamp settings can cause performance issues.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Related issues

Resolves elastic/docs-content#5687.

@jmikell821 jmikell821 self-assigned this May 7, 2026
@jmikell821 jmikell821 added the enhancement New feature or request label May 7, 2026
@jmikell821 jmikell821 requested review from a team as code owners May 7, 2026 22:41
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026 •
edited
Loading

✅ Vale Linting Results

No issues found on modified lines!

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

efd6
efd6 reviewed May 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

You will need to run elastic-package build to generate the package README.md. Also I think we probably want a changelog entry and manifest version bump so that the docs get rendered on the web page.

Suggest the following commit message:

aws: add performance saving recommendations to Cloudtrail docs

@github-actions

This comment has been minimized.

Sign in to view
@jmikell821
Copy link
Copy Markdown
Member Author

jmikell821 commented May 8, 2026

You will need to run elastic-package build to generate the package README.md. Also I think we probably want a changelog entry and manifest version bump so that the docs get rendered on the web page.

Suggest the following commit message:

aws: add performance saving recommendations to Cloudtrail docs

You will need to run elastic-package build to generate the package README.md. Also I think we probably want a changelog entry and manifest version bump so that the docs get rendered on the web page.

Suggest the following commit message:

aws: add performance saving recommendations to Cloudtrail docs

Thanks @efd6, I was waiting for our documentation edit helper to generate the commands which I would then run and push in a second commit, but I just did it manually in this commit here.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

TL;DR

Buildkite failed before running test steps because the PR branch cannot be auto-merged with main. Resolve merge conflicts in packages/aws/changelog.yml and packages/aws/manifest.yml, push the conflict-resolution commit, and rerun CI.

Remediation

  • Rebase or merge main into docs-enhancement/issue-5687, then resolve conflicts in:
    • packages/aws/changelog.yml
    • packages/aws/manifest.yml
  • Keep the AWS package version/changelog consistent with the intended release entry, commit the resolution, and rerun Buildkite.
Investigation details

Root Cause

This is a configuration/integration mergeability failure, not a runtime or unit-test failure. The Buildkite repository post-checkout hook creates a synthetic merge branch (pr_merge_18887) and fails with merge conflicts in AWS package metadata files.

Evidence

133. Auto-merging packages/aws/changelog.yml
135. CONFLICT (content): Merge conflict in packages/aws/changelog.yml
137. Auto-merging packages/aws/manifest.yml
139. CONFLICT (content): Merge conflict in packages/aws/manifest.yml
141. Automatic merge failed; fix conflicts and then commit the result.
145. Error: running "repository post-checkout" shell hook exited with status 1
  • PR metadata also indicates merge issues (mergeable_state: dirty), which aligns with the checkout hook failure.

Verification

  • Not run in this detective workflow (read-only analysis).

Follow-up

  • After resolving conflicts, rerun CI; if a later step fails, that would be a separate issue from this mergeability blocker.

What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@alaudazzi
Copy link
Copy Markdown
Member

alaudazzi commented May 8, 2026

Checking with @shmsr offline:
For some packages -- like aws, azure, and possibly more -- where the docs format differs, the documentation edit helper doesn't work. Subham, feel free to expand more on this.

@shmsr
Copy link
Copy Markdown
Member

shmsr commented May 8, 2026 •
edited
Loading

Checking with @shmsr offline: For some packages -- like aws, azure, and possibly more -- where the docs format differs, the documentation edit helper doesn't work. Subham, feel free to expand more on this.

I have created a PR to add support for special packages like aws, azure, etc. Reason why it did not work:

packages/aws/_dev/build/docs/cloudtrail.md

This is because special packages like aws, azure have 2 or more documentations. Here's the PR that potentially addresses it: #18894

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented May 8, 2026 •
edited
Loading

💔 Build Failed

Failed CI Steps

History

cc @jmikell821

@jmikell821
Copy link
Copy Markdown
Member Author

jmikell821 commented May 8, 2026

@elastic/security-service-integrations - the build is continuously failing and I'm not sure why, could you advise? cc: @efd6.

efd6
efd6 reviewed May 10, 2026
View reviewed changes
Comment thread packages/aws/changelog.yml
Comment on lines +2 to +6
- version: "6.15.0"
changes:
- description: Fix NextToken invalidation in Security Hub, GuardDuty, and Inspector by removing the upper time bound from paginated queries.
type: bugfix
link: https://github.com/elastic/integrations/pull/18830
- description: Add S3 polling mode performance recommendations to CloudTrail docs
type: enhancement
link: https://github.com/elastic/integrations/pull/18887
Copy link
Copy Markdown
Contributor

@efd6 efd6 May 10, 2026

Choose a reason for hiding this comment

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

Suggested change
- version: "6.15.0"
changes:
- description: Fix NextToken invalidation in Security Hub, GuardDuty, and Inspector by removing the upper time bound from paginated queries.
type: bugfix
link: https://github.com/elastic/integrations/pull/18830
- description: Add S3 polling mode performance recommendations to CloudTrail docs
type: enhancement
link: https://github.com/elastic/integrations/pull/18887
- version: "6.15.0"
changes:
- description: Add S3 polling mode performance recommendations to CloudTrail docs
type: enhancement
link: https://github.com/elastic/integrations/pull/18887
- version: "6.14.2"
changes:
- description: Fix NextToken invalidation in Security Hub, GuardDuty, and Inspector by removing the upper time bound from paginated queries.
type: bugfix
link: https://github.com/elastic/integrations/pull/18830

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@efd6 efd6 efd6 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@jmikell821 jmikell821

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Website]: AWS CloudTrail Integration

5 participants

@jmikell821 @alaudazzi @shmsr @elasticmachine @efd6