Skip to content

(Doc+) Flush out Slow Logs #118518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Dec 27, 2024
Merged

(Doc+) Flush out Slow Logs #118518

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6eacf4f
(Doc+) Slow Logs
stefnestor Dec 11, 2024
1a9ff1f
split default recommend per search+index
stefnestor Dec 11, 2024
fde0f43
fix link, style edit
shainaraskas Dec 23, 2024
c28cb8b
Merge branch 'main' into stef_slowLogs
shainaraskas Dec 23, 2024
515b722
feedback
stefnestor Dec 25, 2024
583012c
pipeline typo
stefnestor Dec 25, 2024
6882e87
tests try 1
stefnestor Dec 25, 2024
ce4f39f
Apply suggestions from code review
shainaraskas Dec 27, 2024
bfe6a7a
move note
shainaraskas Dec 27, 2024
1bf1df9
add indices to wildcard against
shainaraskas Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/index-modules/slowlog.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ The following is an example of a search event in the slow log:

TIP: If a call was initiated with an `X-Opaque-ID` header, then the ID is automatically included in Search slow logs in the **elasticsearch.slowlog.id** field. See <<x-opaque-id,X-Opaque-Id HTTP header>> for details and best practices.

TIP: You can use the `index.search.slowlog.include.user` or `index.indexing.slowlog.include.user` settings to append `user.*` and `auth.type` fields to slow log entries. These fields contain information about the user who triggered the request.

[source,js]
---------------------------
{
Expand Down Expand Up @@ -109,8 +111,6 @@ GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog

Search slow logs emit per shard. They must be enabled separately for the shard's link:https://www.elastic.co/blog/understanding-query-then-fetch-vs-dfs-query-then-fetch[query and fetch search phases].

You can use the `index.search.slowlog.include.user` or `index.indexing.slowlog.include.user` settings to append `user.*` and `auth.type` fields to slow log entries. These fields contain information about the user who triggered the request.

The following snippet adjusts all available search slow log settings across all indices using the
<<settings,`log4j2.properties` configuration file>>:

Expand Down