elastic / elastic/beats

[docs-patrol] Document `use_minimal_state` for Filebeat entityanalytics `azure-ad` provider

Open Beginner friendly
#51,010 1 comment 0 reactions 0 assignees View on GitHub
docs needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 15m
Merged PRs (30d)
385

Description

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

## Changes Requiring Documentation Updates

### 1. `azure-ad` provider gained `use_minimal_state` but reference docs do not describe it

**Commit(s):**
- `e72da884de80e24dd7d5eb11de82a6ff65a17445` — https://github.com/elastic/beats/commit/e72da884de80e24dd7d5eb11de82a6ff65a17445

**What changed:**
- The Entra ID (`azure-ad`) entity analytics provider now supports minimal-state mode.
- Code evidence:
- `x-pack/filebeat/input/entityanalytics/provider/azuread/minimal.go:17-21` registers a minimal-state provider for `azure-ad`.
- `x-pack/filebeat/input/entityanalytics/conf.go:18-26` exposes and validates `use_minimal_state` in input config.
- `changelog/fragments/1779159472-entityanalytics-entraid-minimal-state.yaml:13-18` explicitly announces support for `use_minimal_state: true`.

**Documentation impact:**
- `docs/reference/filebeat/filebeat-input-entity-analytics.md:634-723` lists supported `azure-ad` configuration keys but does not document `use_minimal_state` or its behavior.
- Users relying on the provider reference cannot discover this new config mode from docs.

## Suggested Actions

- [ ] Update `docs/reference/filebeat/filebeat-input-entity-analytics.md` (`azure-ad` section) to document `use_minimal_state`.
- [ ] Add a short behavior note describing minimal-state mode semantics and any compatibility/operational caveats.
- [ ] Include a minimal YAML example showing `provider: azure-ad` with `use_minimal_state: true`.

> [!NOTE]
>
> 🔒 Integrity filter blocked 14 items
>
> The following items were blocked because they don't meet the GitHub integrity level.
>
> - [#50774](https://github.com/elastic/beats/issues/50774) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49159](https://github.com/elastic/beats/issues/49159) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49459](https://github.com/elastic/beats/issues/49459) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#41492](https://github.com/elastic/beats/issues/41492) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49091](https://github.com/elastic/beats/issues/49091) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49092](https://github.com/elastic/beats/issues/49092) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49090](https://github.com/elastic/beats/issues/49090) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49035](https://github.com/elastic/beats/issues/49035) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#44889](https://github.com/elastic/beats/issues/44889) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#40748](https://github.com/elastic/beats/issues/40748) `search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#51000](https://github.com/elastic/beats/pull/51000) `search_pull_requests`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#50581](https://github.com/elastic/beats/pull/50581) `search_pull_requests`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#49416](https://github.com/elastic/beats/pull/49416) `search_pull_requests`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
> - [#50774](https://github.com/elastic/beats/issues/50774) `issue_read`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
>
> To allow these resources, lower `min-integrity` in your GitHub frontmatter:
>
> ```yaml
> tools:
> github:
> min-integrity: approved # merged | approved | unapproved | none
> ```
>
>

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

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Jun 5, 2026, 3:18 PM UTC

Contributor guide

Open the contributing guide

Research direction

Start with docs/reference/filebeat/filebeat-input-entity-analytics.md lines 634-723, then compare the azure-ad implementation in x-pack/filebeat/input/entityanalytics/provider/azuread/minimal.go and config handling in x-pack/filebeat/input/entityanalytics/conf.go. Check changelog/fragments/1779159472-entityanalytics-entraid-minimal-state.yaml for the announced behavior. Done means the azure-ad section documents use_minimal_state, explains minimal-state behavior and caveats, and includes a minimal YAML example.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.