Skip to content

[backport-aws-7.1] (backport #21462) [aws] Wrap www.amazon.com:app_id examples in backticks to prevent doc-build autolink failures - #21491

Merged
theletterf merged 3 commits into
backport-aws-7.1from
mergify/bp/backport-aws-7.1/pr-21462
Sep 22, 2026
Merged

[backport-aws-7.1] (backport #21462) [aws] Wrap www.amazon.com:app_id examples in backticks to prevent doc-build autolink failures#21491
theletterf merged 3 commits into
backport-aws-7.1from
mergify/bp/backport-aws-7.1/pr-21462

Conversation

@mergify

@mergify mergify Bot commented Sep 21, 2026 •
edited by theletterf
Loading

Copy link
Copy Markdown
Contributor

Proposed commit message

The user_identity.session_context.web_id_federation_data.attributes field in the cloudtrail data stream describes its value with the illustrative examples www.amazon.com:app_id and www.amazon.com:user_id.

When elastic/integration-docs regenerates docs/reference/aws/cloudtrail.md from this description, its Markdown renderer autolinks these bare strings into [www.amazon.com:app_id](http://www.amazon.com:app_id). Since app_id/user_id aren't valid port numbers, the docs-builder link validator can't parse the result as an absolute URL, falls back to treating it as a relative file path, and fails the build.

This blocked the automated docs-update PR elastic/integration-docs#1412 and elastic/integration-docs#1416 until a temporary workaround was pushed directly to that PR's branch — a patch that would be overwritten on the next docs regeneration since it wasn't fixed at the source.

WHAT: Wrap the two example strings in backticks in packages/aws/data_stream/cloudtrail/fields/fields.yml so they render as inline code instead of being autolinked. Regenerated packages/aws/docs/cloudtrail.md with elastic-package build to reflect the change, and bumped the package version (7.1.3 → 7.1.4) with a changelog entry.

WHY: Fix the underlying field description at the source so future doc regenerations (in this repo and in elastic/integration-docs) don't hit the autolink/port-number parsing failure, instead of relying on a downstream workaround.

The sibling field web_id_federation_data.federated_provider uses a single bare www.amazon.com (no port-like suffix) and autolinks fine, so it was left unchanged.

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

How to test this PR locally

Run elastic-package build in packages/aws and confirm docs/cloudtrail.md regenerates with the web_id_federation_data.attributes example values wrapped in backticks. elastic-package lint passes with only a pre-existing, unrelated warning about the cloudtrail ingest pipeline's on_failure message.

Related issues

  • Relates elastic/integration-docs#1412 and elastic/integration-docs#1416

🤖 Generated with Claude Code

https://claude.ai/code/session_017HKrxUZosBcTRHMBR6o7Fy

Generated by Claude Code

This is an automatic backport of pull request #21462 done by Mergify.

@theletterf @mergify
[aws] Wrap www.amazon.com:app_id examples in backticks to prevent doc…
b271796 
…-build autolink failures (#21462)

* [aws] Prevent autolinking of www.amazon.com:app_id examples in cloudtrail fields

The web_id_federation_data.attributes field description used bare
www.amazon.com:app_id and www.amazon.com:user_id as illustrative
examples. Markdown renderers autolink these into
http://www.amazon.com:app_id, and since app_id/user_id aren't valid
port numbers, downstream docs-builder link validation fails when it
falls back to treating them as relative paths. Wrap the examples in
backticks so they render as inline code instead.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017HKrxUZosBcTRHMBR6o7Fy

* [aws] Fix changelog link to point at the actual PR number

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017HKrxUZosBcTRHMBR6o7Fy

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
(cherry picked from commit 3c8ac0a)

# Conflicts:
#	packages/aws/changelog.yml
#	packages/aws/manifest.yml
@mergify mergify Bot added backport conflicts There is a conflict in the backported pull request labels Sep 21, 2026
@mergify
mergify Bot requested review from a team as code owners September 21, 2026 11:21
@mergify mergify Bot added conflicts There is a conflict in the backported pull request backport labels Sep 21, 2026
@mergify

mergify Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor Author

Cherry-pick of 3c8ac0a has failed:

On branch mergify/bp/backport-aws-7.1/pr-21462
Your branch is up to date with 'origin/backport-aws-7.1'.

You are currently cherry-picking commit 3c8ac0a8.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   packages/aws/data_stream/cloudtrail/fields/fields.yml
	modified:   packages/aws/docs/cloudtrail.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   packages/aws/changelog.yml
	both modified:   packages/aws/manifest.yml

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@theletterf
theletterf enabled auto-merge (squash) September 21, 2026 11:21
@github-actions

github-actions Bot commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

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.

@mergify mergify Bot mentioned this pull request Sep 21, 2026
Merged
4 of 5 tasks
@theletterf
[aws] Resolve 7.1 backport conflicts
b260c68 
Remove cherry-pick conflict markers and unrelated changelog entries, and release the CloudTrail documentation fix as AWS 7.1.4.\n\nCo-Authored-By: GPT-5.6 Sol <noreply@openai.com>
@qcorporation qcorporation added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:aws AWS Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] bugfix Pull request that fixes a bug issue labels Sep 21, 2026
@infra-vault-gh-plugin-prod

infra-vault-gh-plugin-prod Bot commented Sep 21, 2026

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@vera-review-bot

vera-review-bot Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

🟢 No issues across the latest commits b260c68.

Since this is a community PR, a new commit triggers another review — at most once every 30 minutes. I skip the PR while it's approved or has merge conflicts.

🤖 AI-Generated Review | Vera Review Bot - v0.4.2 | 📚 Knowledge base: integration-skills

⚠️ Automated review — verify suggestions before applying.

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

Package aws 👍(8) 💚(7) 💔(7)

Expand to view
Data stream Previous EPS New EPS Diff (%) Result
inspector 1390.82 871.84 -518.98 (-37.31%) 💔
route53_resolver_logs 9259.26 7142.86 -2116.4 (-22.86%) 💔
apigateway_logs 31250 14705.88 -16544.12 (-52.94%) 💔
vpcflow 7142.86 5555.56 -1587.3 (-22.22%) 💔
cloudfront_logs 3257.33 2469.14 -788.19 (-24.2%) 💔
cloudwatch_logs 250000 200000 -50000 (-20%) 💔
config 5714.29 3436.43 -2277.86 (-39.86%) 💔

To see the full report comment with /test benchmark fullreport

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

✅ All changelog entries have the correct PR link.

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

✅ Package owners are in sync with main.

@infra-vault-gh-plugin-prod

infra-vault-gh-plugin-prod Bot commented Sep 22, 2026

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @theletterf

@theletterf
theletterf merged commit f470d8d into backport-aws-7.1 Sep 22, 2026
10 checks passed
@theletterf
theletterf deleted the mergify/bp/backport-aws-7.1/pr-21462 branch September 22, 2026 14:22
@github-actions github-actions Bot mentioned this pull request Sep 22, 2026
Open
@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Changelog sync PR created: #21566

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Package aws - 7.1.4 containing this change is available at https://epr.elastic.co/package/aws/7.1.4/

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

Reviewers

@kcreddy kcreddy kcreddy approved these changes

Assignees

@theletterf theletterf

Labels

backport bugfix Pull request that fixes a bug issue conflicts There is a conflict in the backported pull request documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:aws AWS Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kcreddy @theletterf @qcorporation