[DOCS] Fix inconsistent formatting for fieldnames in profile.asciidoc
This commit is contained in:
parent
e415170989
commit
9ed867ea83
|
@ -217,7 +217,7 @@ a `query` array and a `collector` array. Alongside the `search` object is an `a
|
|||
There will also be a `rewrite` metric showing the total time spent rewriting the query (in nanoseconds).
|
||||
|
||||
NOTE: As with other statistics apis, the Profile API supports human readable outputs. This can be turned on by adding
|
||||
`?human=true` to the query string. In this case, the output contains the additional `"time"` field containing rounded,
|
||||
`?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"`).
|
||||
|
||||
=== Profiling Queries
|
||||
|
@ -275,22 +275,22 @@ The overall structure of this query tree will resemble your original Elasticsear
|
|||
<1> The breakdown timings are omitted for simplicity
|
||||
|
||||
Based on the profile structure, we can see that our `match` query was rewritten by Lucene into a BooleanQuery with two
|
||||
clauses (both holding a TermQuery). The `"type"` field displays the Lucene class name, and often aligns with
|
||||
the equivalent name in Elasticsearch. The `"description"` field displays the Lucene explanation text for the query, and
|
||||
is made available to help differentiating between parts of your query (e.g. both `"message:search"` and `"message:test"`
|
||||
clauses (both holding a TermQuery). The `type` field displays the Lucene class name, and often aligns with
|
||||
the equivalent name in Elasticsearch. The `description` field displays the Lucene explanation text for the query, and
|
||||
is made available to help differentiating between parts of your query (e.g. both `message:search` and `message:test`
|
||||
are TermQuery's and would appear identical otherwise.
|
||||
|
||||
The `"time_in_nanos"` field shows that this query took ~1.8ms for the entire BooleanQuery to execute. The recorded time is inclusive
|
||||
The `time_in_nanos` field shows that this query took ~1.8ms for the entire BooleanQuery to execute. The recorded time is inclusive
|
||||
of all children.
|
||||
|
||||
The `"breakdown"` field will give detailed stats about how the time was spent, we'll look at
|
||||
that in a moment. Finally, the `"children"` array lists any sub-queries that may be present. Because we searched for two
|
||||
The `breakdown` field will give detailed stats about how the time was spent, we'll look at
|
||||
that in a moment. Finally, the `children` array lists any sub-queries that may be present. Because we searched for two
|
||||
values ("search test"), our BooleanQuery holds two children TermQueries. They have identical information (type, time,
|
||||
breakdown, etc). Children are allowed to have their own children.
|
||||
|
||||
===== Timing Breakdown
|
||||
|
||||
The `"breakdown"` component lists detailed timing statistics about low-level Lucene execution:
|
||||
The `breakdown` component lists detailed timing statistics about low-level Lucene execution:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
@ -318,7 +318,7 @@ The `"breakdown"` component lists detailed timing statistics about low-level Luc
|
|||
// TESTRESPONSE[s/"next_doc": 53876/"next_doc": $body.profile.shards.0.searches.0.query.0.breakdown.next_doc/]
|
||||
|
||||
Timings are listed in wall-clock nanoseconds and are not normalized at all. All caveats about the overall
|
||||
`"time_in_nanos"` apply here. The intention of the breakdown is to give you a feel for A) what machinery in Lucene is
|
||||
`time_in_nanos` apply here. The intention of the breakdown is to give you a feel for A) what machinery in Lucene is
|
||||
actually eating time, and B) the magnitude of differences in times between the various components. Like the overall time,
|
||||
the breakdown is inclusive of all children times.
|
||||
|
||||
|
@ -422,8 +422,8 @@ Looking at the previous example:
|
|||
// TESTRESPONSE[s/"time_in_nanos": "32273"/"time_in_nanos": $body.profile.shards.0.searches.0.collector.0.children.0.time_in_nanos/]
|
||||
|
||||
We see a single collector named `SimpleTopScoreDocCollector` wrapped into `CancellableCollector`. `SimpleTopScoreDocCollector` is the default "scoring and sorting"
|
||||
`Collector` used by Elasticsearch. The `"reason"` field attempts to give a plain english description of the class name. The
|
||||
`"time_in_nanos"` is similar to the time in the Query tree: a wall-clock time inclusive of all children. Similarly, `children` lists
|
||||
`Collector` used by Elasticsearch. The `reason` field attempts to give a plain english description of the class name. The
|
||||
`time_in_nanos` is similar to the time in the Query tree: a wall-clock time inclusive of all children. Similarly, `children` lists
|
||||
all sub-collectors. The `CancellableCollector` that wraps `SimpleTopScoreDocCollector` is used by elasticsearch to detect if the current
|
||||
search was cancelled and stop collecting documents as soon as it occurs.
|
||||
|
||||
|
@ -777,16 +777,16 @@ Which yields the following aggregation profile output
|
|||
From the profile structure we can see our `property_type` terms aggregation which is internally represented by the
|
||||
`GlobalOrdinalsStringTermsAggregator` class and the sub aggregator `avg_price` which is internally represented by the `AvgAggregator` class. The `type` field displays the class used internally to represent the aggregation. The `description` field displays the name of the aggregation.
|
||||
|
||||
The `"time_in_nanos"` field shows that it took ~4 seconds for the entire aggregation to execute. The recorded time is inclusive
|
||||
The `time_in_nanos` field shows that it took ~4 seconds for the entire aggregation to execute. The recorded time is inclusive
|
||||
of all children.
|
||||
|
||||
The `"breakdown"` field will give detailed stats about how the time was spent, we'll look at
|
||||
that in a moment. Finally, the `"children"` array lists any sub-aggregations that may be present. Because we have an `avg_price` aggregation as a sub-aggregation to the `property_type` aggregation we see it listed as a child of the `property_type` aggregation. the two aggregation outputs have identical information (type, time,
|
||||
The `breakdown` field will give detailed stats about how the time was spent, we'll look at
|
||||
that in a moment. Finally, the `children` array lists any sub-aggregations that may be present. Because we have an `avg_price` aggregation as a sub-aggregation to the `property_type` aggregation we see it listed as a child of the `property_type` aggregation. the two aggregation outputs have identical information (type, time,
|
||||
breakdown, etc). Children are allowed to have their own children.
|
||||
|
||||
===== Timing Breakdown
|
||||
|
||||
The `"breakdown"` component lists detailed timing statistics about low-level Lucene execution:
|
||||
The `breakdown` component lists detailed timing statistics about low-level Lucene execution:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
Loading…
Reference in New Issue