elastic / elastic/integrations

[docs-patrol] Update AWS CloudTrail docs for host/entity target classification change

Open
#17,897 0 comments 0 reactions 1 assignee Claimed by @alexreal1314 View on GitHub
bug documentation Integration:aws
Dominant language
Handlebars
Stars
333
Forks
647
Avg merge
3d 4h
Merged PRs (30d)
209

Description

Recent code changes in the repository have introduced documentation drift. The following change needs a corresponding documentation update.

## Changes Requiring Documentation Updates

### 1. CloudTrail target entity routing changed, but exported-fields docs still describe old behavior

**Commit(s):** [`7d3b60b1ce81caf1121f360d71717179d8fff521`](https://github.com/elastic/integrations/commit/7d3b60b1ce81caf1121f360d71717179d8fff521)

**What changed:**
- In `packages/aws/data_stream/cloudtrail/elasticsearch/ingest_pipeline/default.yml`, host classification now only treats EC2 instances as host targets:
- `hostResourceTypes` now only includes `instance` (lines 72-74).
- `hostIdPrefixes` now only includes `i-` (lines 112-114).
- Non-host targets now flow to generic target storage (`entity.target.id`) (lines 926-945).
- `host.id` is now set when host targets are present (lines 936-939).

**Documentation impact:**
- `packages/aws/docs/cloudtrail.md` still states that `host.target.entity.id` includes EBS volume, snapshot, and AMI IDs (line 142), which no longer matches ingest behavior.
- The same exported-fields table does not document `host.id`.

This is concretely user-impacting: queries or detections built from docs will look for snapshot/AMI/volume identifiers in `host.target.entity.id`, but those identifiers are now emitted under `entity.target.id`.

## Suggested Actions

- [ ] Update `packages/aws/docs/cloudtrail.md` exported-fields entry for `host.target.entity.id` to reflect EC2-instance-only host target classification.
- [ ] Add exported-fields documentation for `host.id` in `packages/aws/docs/cloudtrail.md`.
- [ ] Regenerate/update built docs under `packages/aws/_dev/build/docs/cloudtrail.md` to stay aligned.

---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Docs Patrol](https://github.com/elastic/integrations/actions/runs/23289902763)

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Mar 26, 2026, 10:19 AM UTC

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.