[DOCS] Use search profiler attribute (#28209)
This commit is contained in:
parent
3aab350727
commit
ed07e23e5c
|
@ -18,24 +18,24 @@ To start profiling queries:
|
||||||
. Open Kibana in your web browser and log in. If you are running Kibana
|
. Open Kibana in your web browser and log in. If you are running Kibana
|
||||||
locally, go to `http://localhost:5601/`.
|
locally, go to `http://localhost:5601/`.
|
||||||
|
|
||||||
. Click **DevTools** in the side navigation to open the Search Profiler.
|
. Click **DevTools** in the side navigation to open the {searchprofiler}.
|
||||||
Console is the default tool to open when first accessing DevTools.
|
Console is the default tool to open when first accessing DevTools.
|
||||||
+
|
+
|
||||||
image::dev-tools/searchprofiler/images/gs1.png["Opening DevTools"]
|
image::dev-tools/searchprofiler/images/gs1.png["Opening DevTools"]
|
||||||
+
|
+
|
||||||
On the top navigation bar, click the second item: *Search Profiler*
|
On the top navigation bar, click the second item: *Search Profiler*
|
||||||
+
|
+
|
||||||
image::dev-tools/searchprofiler/images/gs2.png["Opening the Search Profiler"]
|
image::dev-tools/searchprofiler/images/gs2.png["Opening the {searchprofiler}"]
|
||||||
|
|
||||||
. This opens the Search Profiler interface.
|
. This opens the {searchprofiler} interface.
|
||||||
+
|
+
|
||||||
image::dev-tools/searchprofiler/images/gs3.png["Search Profiler Interface"]
|
image::dev-tools/searchprofiler/images/gs3.png["{searchprofiler} Interface"]
|
||||||
|
|
||||||
. Replace the default `match_all` query with the query you want to profile and click *Profile*.
|
. Replace the default `match_all` query with the query you want to profile and click *Profile*.
|
||||||
+
|
+
|
||||||
image::dev-tools/searchprofiler/images/gs4.png["Profiling the match_all query"]
|
image::dev-tools/searchprofiler/images/gs4.png["Profiling the match_all query"]
|
||||||
+
|
+
|
||||||
Search Profiler displays the names of the indices searched, the shards in each index,
|
{searchprofiler} displays the names of the indices searched, the shards in each index,
|
||||||
and how long the query took. The following example shows the results of profiling
|
and how long the query took. The following example shows the results of profiling
|
||||||
the match_all query. Three indices were searched: `.monitoring-kibana-2-2016.11.30`,
|
the match_all query. Three indices were searched: `.monitoring-kibana-2-2016.11.30`,
|
||||||
`.monitoring-data-2` and `test`.
|
`.monitoring-data-2` and `test`.
|
||||||
|
@ -64,7 +64,7 @@ This displays details about the query component(s) that ran on the shard.
|
||||||
+
|
+
|
||||||
In this example, there is a single `"MatchAllDocsQuery"` that ran on the shard.
|
In this example, there is a single `"MatchAllDocsQuery"` that ran on the shard.
|
||||||
Since it was the only query run, it took 100% of the time. When you mouse over
|
Since it was the only query run, it took 100% of the time. When you mouse over
|
||||||
a row, the Search Profiler displays additional information about the query component."
|
a row, the {searchprofiler} displays additional information about the query component."
|
||||||
+
|
+
|
||||||
image::dev-tools/searchprofiler/images/gs6.png["Profile details for the first shard"]
|
image::dev-tools/searchprofiler/images/gs6.png["Profile details for the first shard"]
|
||||||
+
|
+
|
||||||
|
|
|
@ -13,7 +13,7 @@ into a visualization that is easy to navigate, allowing you to diagnose and debu
|
||||||
poorly performing queries much faster.
|
poorly performing queries much faster.
|
||||||
|
|
||||||
|
|
||||||
image::dev-tools/searchprofile/images/overview.png["Search Profiler Visualization"]
|
image::dev-tools/searchprofile/images/overview.png["{searchprofiler} Visualization"]
|
||||||
|
|
||||||
--
|
--
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ into a visualization that is easy to navigate, allowing you to diagnose and debu
|
||||||
poorly performing queries much faster.
|
poorly performing queries much faster.
|
||||||
|
|
||||||
|
|
||||||
image::dev-tools/searchprofiler/images/overview.png["Search Profiler Visualization"]
|
image::dev-tools/searchprofiler/images/overview.png["{searchprofiler} Visualization"]
|
||||||
|
|
||||||
include::getting-started.asciidoc[]
|
include::getting-started.asciidoc[]
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
[[profiler-index]]
|
[[profiler-index]]
|
||||||
=== Index and Type filtering
|
=== Index and Type filtering
|
||||||
|
|
||||||
By default, all queries executed by the Search Profiler are sent
|
By default, all queries executed by the {searchprofiler} are sent
|
||||||
to `GET /_search`. It searches across your entire cluster (all indices, all types).
|
to `GET /_search`. It searches across your entire cluster (all indices, all types).
|
||||||
|
|
||||||
If you need to query a specific index or type (or several), you can use the Index
|
If you need to query a specific index or type (or several), you can use the Index
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
[[profiler-complicated]]
|
[[profiler-complicated]]
|
||||||
=== Profiling a more complicated query
|
=== Profiling a more complicated query
|
||||||
|
|
||||||
To understand how the query trees are displayed inside the Search Profiler,
|
To understand how the query trees are displayed inside the {searchprofiler},
|
||||||
let's look at a more complicated query.
|
let's look at a more complicated query.
|
||||||
|
|
||||||
. Index the following data:
|
. Index the following data:
|
||||||
|
@ -118,6 +118,6 @@ image::dev-tools/searchprofiler/images/gs10.png["Drilling into the first shard's
|
||||||
Click a shard's Expand button to view the aggregation details. Hover over an
|
Click a shard's Expand button to view the aggregation details. Hover over an
|
||||||
aggregation row to view the timing breakdown.
|
aggregation row to view the timing breakdown.
|
||||||
|
|
||||||
For more information about how the Search Profiler works, how timings are calculated, and
|
For more information about how the {searchprofiler} works, how timings are calculated, and
|
||||||
how to interpret various results, see
|
how to interpret various results, see
|
||||||
{ref}/search-profile-queries.html[Profiling queries].
|
{ref}/search-profile-queries.html[Profiling queries].
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
[[profiler-render]]
|
[[profiler-render]]
|
||||||
=== Rendering pre-captured profiler JSON
|
=== Rendering pre-captured profiler JSON
|
||||||
|
|
||||||
The Search Profiler queries the cluster that the Kibana node is attached to.
|
The {searchprofiler} queries the cluster that the Kibana node is attached to.
|
||||||
It does this by executing the query against the cluster and collecting the results.
|
It does this by executing the query against the cluster and collecting the results.
|
||||||
|
|
||||||
This is convenient, but sometimes performance problems are temporal in nature. For example,
|
This is convenient, but sometimes performance problems are temporal in nature. For example,
|
||||||
|
@ -10,7 +10,7 @@ a query might only be slow at certain time of day when many customers are using
|
||||||
You can setup a process to automatically profile slow queries when they occur and then
|
You can setup a process to automatically profile slow queries when they occur and then
|
||||||
save those profile responses for later analysis.
|
save those profile responses for later analysis.
|
||||||
|
|
||||||
The Search Profiler supports this workflow by enabling you to paste the
|
The {searchprofiler} supports this workflow by enabling you to paste the
|
||||||
pre-captured JSON. The tool will detect that this is a profiler response JSON
|
pre-captured JSON. The tool will detect that this is a profiler response JSON
|
||||||
rather than a query, and render the visualization rather than querying the cluster.
|
rather than a query, and render the visualization rather than querying the cluster.
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ Set to `true` (default) to enable the <<xpack-grokdebugger,Grok Debugger>>.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
[[profiler-settings]]
|
[[profiler-settings]]
|
||||||
==== Search Profiler Settings
|
==== {searchprofiler} Settings
|
||||||
|
|
||||||
`xpack.searchprofiler.enabled`::
|
`xpack.searchprofiler.enabled`::
|
||||||
Set to `true` (default) to enable the <<xpack-profiler,Search Profiler>>.
|
Set to `true` (default) to enable the <<xpack-profiler,{searchprofiler}>>.
|
||||||
|
|
Loading…
Reference in a new issue