honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Adds missing anchors for profile API

This commit is contained in:
lcawl 2018-12-18 15:20:19 -08:00
parent 20b58f0b0f
commit 504cfb2fb1
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/java-rest/high-level/search/search.asciidoc
View File

@ -430,8 +430,8 @@ include-tagged::{doc-tests-file}[{api}-request-profiling-queries-results]
<3> Retrieve the time in millis spent executing the Lucene query
<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]
The Rest API documentation contains more information about {ref}/search-profile-queries.html[Profiling Queries] with
a description of the query profiling information.
The `QueryProfileShardResult` also gives access to the profiling information for the Lucene collectors:
@ -445,7 +445,7 @@ include-tagged::{doc-tests-file}[{api}-request-profiling-queries-collectors]
<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].
for Lucene collectors. See {ref}/search-profile-queries.html[Profiling queries].
In a very similar manner to the query tree execution, the `QueryProfileShardResult` objects gives access
to the detailed aggregations tree execution:

3
docs/reference/search/profile.asciidoc
View File

@ -221,6 +221,7 @@ NOTE: As with other statistics apis, the Profile API supports human readable out
`?human=true` to the query string. In this case, the output contains the additional `time` field containing rounded,
human readable timing information (e.g. `"time": "391,9ms"`, `"time": "123.3micros"`).
[[search-profile-queries]]
=== Profiling Queries
[NOTE]
@ -678,6 +679,7 @@ ignore its children if you find the details too tricky to interpret.
Hopefully this will be fixed in future iterations, but it is a tricky problem to solve and still in-progress :)
[[search-profile-aggregations]]
=== Profiling Aggregations
==== `aggregations` Section
@ -851,6 +853,7 @@ The meaning of the stats are as follows:
Records the number of invocations of the particular method. For example, `"collect_count": 2,`
means the `collect()` method was called on two different documents.
[[search-profile-considerations]]
=== Profiling Considerations
==== Performance Notes