Reframe 'Audit Elasticsearch search queries' now that query logging exists
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with the impacted page, https://www.elastic.co/docs/deploy-manage/security/logging-configuration/auditing-search-queries, and review the related query-logging PR #5039 for context. Rename the page generically, remove search-query-specific framing, and link query logging as the recommended way to trace search queries.
Written by the indexing model from the issue text.
Description
Context
Raised in https://github.com/elastic/docs-content/pull/5039#issuecomment-4341782933.
Impacted page: https://www.elastic.co/docs/deploy-manage/security/logging-configuration/auditing-search-queries
Related PR: https://github.com/elastic/docs-content/pull/5039 (query logging)
Problem
Now that query logging provides an official way to trace search queries and tie them to a user, the "Audit Elasticsearch search queries" page is misleading. The audit feature described on that page actually surfaces any request body, not only search query payloads. With query logging available, we should no longer position audit logging as the way to trace search queries.
Definition of done
- Rename the page to something more generic like "Audit Elasticsearch HTTP payloads"
- Remove search-query-specific framing from the content
- Point readers to query logging as the recommended approach for tracing search queries
- Dominant language
- No language data
- Stars
- 47
- Forks
- 262
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 127
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs-content
-
bug community triaged
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/docs-content#8393 · 1 comment · 1 reaction ·
-
documentation Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
elastic/docs-content#8375 · 1 comment · 1 reaction ·
-
documentation Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
elastic/docs-content#8374 · 1 comment · 1 reaction ·
-
documentation Serverless Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
elastic/docs-content#8352 · 1 comment · 1 reaction ·
-
documentation Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
elastic/docs-content#8342 · 1 comment · 1 reaction ·
All issues in elastic/docs-content
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100