Skip to content

Commit 54f39d9

Browse files
author
Christoph Büscher
authored
[Docs] Add Profile API limitations (#36252)
Adding some of the limitations mentioned in #29275. Closes #29275
1 parent 7563525 commit 54f39d9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/reference/search/profile.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ WARNING: The Profile API is a debugging tool and adds significant overhead to s
66
The Profile API provides detailed timing information about the execution of individual components
77
in a search request. It gives the user insight into how search requests are executed at a low level so that
88
the user can understand why certain requests are slow, and take steps to improve them.
9+
Note that the Profile API, <<profile-limitations, amongst other things>>, doesn't measure
10+
network latency, time spent in the search fetch phase, time spent while the requests spends
11+
in queues or while merging shard responses on the coordinating node.
912

1013
The output from the Profile API is *very* verbose, especially for complicated requests executed across
1114
many shards. Pretty-printing the response is recommended to help understand the output
@@ -861,8 +864,12 @@ There are also cases where special Lucene optimizations are disabled, since they
861864
could cause some queries to report larger relative times than their non-profiled counterparts, but in general should
862865
not have a drastic effect compared to other components in the profiled query.
863866

867+
[[profile-limitations]]
864868
==== Limitations
865869

870+
- Profiling currently does not measure the search fetch phase nor the network overhead
871+
- Profiling also does not account for time spent in the queue, merging shard responses on the coordinating node or
872+
additional work like e.g. building global ordinals (an internal data structure used to speed up search)
866873
- Profiling statistics are currently not available for suggestions, highlighting, `dfs_query_then_fetch`
867874
- Profiling of the reduce phase of aggregation is currently not available
868875
- The Profiler is still highly experimental. The Profiler is instrumenting parts of Lucene that were

0 commit comments

Comments
 (0)