Skip to content

Commit

Permalink
[DOCS] Specify IDs for Profile API sections (#41505)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Apr 24, 2019
1 parent e38fe8a commit 4cc23ab
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/java-rest/high-level/apis/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ include-tagged::{doc-tests}/SearchDocumentationIT.java[search-request-profiling-
<4> Retrieve the profile results for the sub-queries (if any)

The Rest API documentation contains more information about {ref}/_profiling_queries.html[Profiling Queries] with
a description of the {ref}/_profiling_queries.html#_literal_query_literal_section[query profiling information]
a description of the {ref}/_profiling_queries.html#profile-query-section[query profiling information]

The `QueryProfileShardResult` also gives access to the profiling information for the Lucene collectors:

Expand All @@ -476,7 +476,7 @@ include-tagged::{doc-tests}/SearchDocumentationIT.java[search-request-profiling-
<4> Retrieve the profile results for the sub-collectors (if any)

The Rest API documentation contains more information about profiling information
{ref}/_profiling_queries.html#_literal_collectors_literal_section[for Lucene collectors].
{ref}/_profiling_queries.html#profile-collectors-section[for Lucene collectors].

In a very similar manner to the query tree execution, the `QueryProfileShardResult` objects gives access
to the detailed aggregations tree execution:
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/profile.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ sufficient to see that a particular component of a query is slow, and not necess
the `advance` phase of that query is the cause, for example.
=======================================

[[profile-query-section]]
==== `query` Section

The `query` section contains detailed timing of the query tree executed by Lucene on a particular shard.
Expand Down Expand Up @@ -368,6 +369,7 @@ The meaning of the stats are as follows:
means the `nextDoc()` method was called on two different documents. This can be used to help judge
how selective queries are, by comparing counts between different query components.

[[profile-collectors-section]]
==== `collectors` Section

The Collectors portion of the response shows high-level execution details. Lucene works by defining a "Collector"
Expand Down

0 comments on commit 4cc23ab

Please sign in to comment.