[DOCS] Creates dev-tools folder (#19528)
|
@ -8,4 +8,8 @@ The *Dev Tools* page contains development tools that you can use to interact
|
|||
with your data in Kibana.
|
||||
--
|
||||
|
||||
include::console.asciidoc[]
|
||||
include::dev-tools/console/console.asciidoc[]
|
||||
|
||||
include::dev-tools/searchprofiler/index.asciidoc[]
|
||||
|
||||
include::dev-tools/grokdebugger/index.asciidoc[]
|
||||
|
|
|
@ -5,7 +5,7 @@ The Console plugin provides a UI to interact with the REST API of Elasticsearch.
|
|||
where you compose requests to Elasticsearch, and the *response* pane, which displays the responses to the request.
|
||||
|
||||
.The Console UI
|
||||
image::images/introduction_screen.png[Screenshot]
|
||||
image::dev-tools/console/images/introduction_screen.png[Screenshot]
|
||||
|
||||
Console understands commands in a cURL-like syntax. For example the following Console command
|
||||
|
||||
|
@ -39,7 +39,7 @@ names.
|
|||
|
||||
[[suggestions]]
|
||||
.API suggestions
|
||||
image::images/introduction_suggestion.png["Suggestions",width=400,align="center"]
|
||||
image::dev-tools/console/images/introduction_suggestion.png["Suggestions",width=400,align="center"]
|
||||
|
||||
Once you have typed a command in to the left pane, you can submit it to Elasticsearch by clicking the little green
|
||||
triangle that appears next to the URL line of the request. Notice that as you move the cursor around, the little
|
||||
|
@ -48,12 +48,12 @@ triangle that appears next to the URL line of the request. Notice that as you mo
|
|||
|
||||
[[action_menu]]
|
||||
.The Action Menu
|
||||
image::images/introduction_action_menu.png["The Action Menu",width=400,align="center"]
|
||||
image::dev-tools/console/images/introduction_action_menu.png["The Action Menu",width=400,align="center"]
|
||||
|
||||
When the response come back, you should see it in the left hand panel:
|
||||
|
||||
.The Output Pane
|
||||
image::images/introduction_output.png[Screenshot]
|
||||
image::dev-tools/console/images/introduction_output.png[Screenshot]
|
||||
|
||||
[float]
|
||||
[[console-ui]]
|
||||
|
@ -63,14 +63,14 @@ In this section you will find a more detailed description of UI of Console. The
|
|||
in the <<console-kibana>> section.
|
||||
|
||||
|
||||
include::console/multi-requests.asciidoc[]
|
||||
include::multi-requests.asciidoc[]
|
||||
|
||||
include::console/auto-formatting.asciidoc[]
|
||||
include::auto-formatting.asciidoc[]
|
||||
|
||||
include::console/keyboard-shortcuts.asciidoc[]
|
||||
include::keyboard-shortcuts.asciidoc[]
|
||||
|
||||
include::console/history.asciidoc[]
|
||||
include::history.asciidoc[]
|
||||
|
||||
include::console/settings.asciidoc[]
|
||||
include::settings.asciidoc[]
|
||||
|
||||
include::console/configuring-console.asciidoc[]
|
||||
include::configuring-console.asciidoc[]
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
@ -26,7 +26,7 @@ locally, go to `http://localhost:5601/`.
|
|||
. Click **DevTools** in the side navigation and then click **Grok Debugger**
|
||||
on the top navigation bar.
|
||||
+
|
||||
image::grokdebugger/images/grok-debugger.png["Grok Debugger UI"]
|
||||
image::dev-tools/grokdebugger/images/grok-debugger.png["Grok Debugger UI"]
|
||||
|
||||
. Under Sample Data, enter a sample message that is representative of the data you
|
||||
want to parse. For example:
|
||||
|
@ -50,13 +50,13 @@ For example, to parse the log line in the example, you use:
|
|||
Under Structured Data, you'll see the simulated event that results from applying the grok
|
||||
pattern:
|
||||
+
|
||||
image::grokdebugger/images/grok-debugger-output.png["Viewing Grok Debugger Output"]
|
||||
image::dev-tools/grokdebugger/images/grok-debugger-output.png["Viewing Grok Debugger Output"]
|
||||
+
|
||||
Any errors in the pattern will appear at the top of the page. For example,
|
||||
here you see a parse exception because the pattern name is misspelled as `WORDD`
|
||||
and therefore can't be found in the pattern dictionary:
|
||||
+
|
||||
image::grokdebugger/images/grok-debugger-error.png["Viewing Grok Debugger Errors"]
|
||||
image::dev-tools/grokdebugger/images/grok-debugger-error.png["Viewing Grok Debugger Errors"]
|
||||
+
|
||||
You can click the **More** link to see more detail about the message.
|
||||
+
|
||||
|
@ -114,7 +114,7 @@ MSG message-id=<%{GREEDYDATA}>
|
|||
Under Output, you'll see the simulated output event that results from applying
|
||||
the grok pattern that contains the custom pattern:
|
||||
+
|
||||
image::grokdebugger/images/grok-debugger-custom-pattern.png["Debugging a custom pattern"]
|
||||
image::dev-tools/grokdebugger/images/grok-debugger-custom-pattern.png["Debugging a custom pattern"]
|
||||
+
|
||||
If an error occurs, you can view the error message and continue iterating over
|
||||
the custom pattern until there are no errors and the output matches the event
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
Before Width: | Height: | Size: 211 KiB After Width: | Height: | Size: 211 KiB |
Before Width: | Height: | Size: 280 KiB After Width: | Height: | Size: 280 KiB |
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 138 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 208 KiB After Width: | Height: | Size: 208 KiB |
|
@ -20,6 +20,6 @@ ingest node and Logstash share the same grok implementation and pattern
|
|||
libraries, any grok pattern that you create in the Grok Debugger will work
|
||||
in ingest node and Logstash.
|
||||
|
||||
image::grokdebugger/images/grok-debugger-overview.png["Grok Debugger"]
|
||||
image::dev-tools/grokdebugger/images/grok-debugger-overview.png["Grok Debugger"]
|
||||
|
||||
include::getting-started.asciidoc[]
|
|
@ -21,19 +21,19 @@ locally, go to `http://localhost:5601/`.
|
|||
. Click **DevTools** in the side navigation to open the Search Profiler.
|
||||
Console is the default tool to open when first accessing DevTools.
|
||||
+
|
||||
image::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*
|
||||
+
|
||||
image::searchprofiler/images/gs2.png["Opening the Search Profiler"]
|
||||
image::dev-tools/searchprofiler/images/gs2.png["Opening the Search Profiler"]
|
||||
|
||||
. This opens the Search Profiler interface.
|
||||
+
|
||||
image::searchprofiler/images/gs3.png["Search Profiler Interface"]
|
||||
image::dev-tools/searchprofiler/images/gs3.png["Search Profiler Interface"]
|
||||
|
||||
. Replace the default `match_all` query with the query you want to profile and click *Profile*.
|
||||
+
|
||||
image::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,
|
||||
and how long the query took. The following example shows the results of profiling
|
||||
|
@ -45,7 +45,7 @@ Cumulative Time that the query took 0.132ms to execute. Of the five shards in th
|
|||
index (`DWZD0iosQNeJMTvb4q1JDw` 0 through 5), shard 3 was the slowest (0.053ms), followed by shard 2 (0.038ms). Shards are
|
||||
sorted by their time in descending order.
|
||||
+
|
||||
image::searchprofiler/images/gs5.png["Profile details for the test index"]
|
||||
image::dev-tools/searchprofiler/images/gs5.png["Profile details for the test index"]
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
|
@ -66,7 +66,7 @@ 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
|
||||
a row, the Search Profiler displays additional information about the query component."
|
||||
+
|
||||
image::searchprofiler/images/gs6.png["Profile details for the first shard"]
|
||||
image::dev-tools/searchprofiler/images/gs6.png["Profile details for the first shard"]
|
||||
+
|
||||
This panel shows the timing breakdown of low-level Lucene methods. For more information,
|
||||
see the reference docs for {ref}/_profiling_queries.html#_timing_breakdown[Timing Breakdown].
|
|
@ -12,7 +12,7 @@ into a visualization that is easy to navigate, allowing you to diagnose and debu
|
|||
poorly performing queries much faster.
|
||||
|
||||
|
||||
image::images/overview.png["Search Profiler Visualization"]
|
||||
image::dev-tools/searchprofile/images/overview.png["Search Profiler Visualization"]
|
||||
|
||||
--
|
||||
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.8 KiB |
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 143 KiB |
|
@ -11,7 +11,7 @@ into a visualization that is easy to navigate, allowing you to diagnose and debu
|
|||
poorly performing queries much faster.
|
||||
|
||||
|
||||
image::searchprofiler/images/overview.png["Search Profiler Visualization"]
|
||||
image::dev-tools/searchprofiler/images/overview.png["Search Profiler Visualization"]
|
||||
|
||||
include::getting-started.asciidoc[]
|
||||
|
|
@ -11,6 +11,6 @@ and Type filters at the top-left of the UI
|
|||
In the following example, the query is executed against the indices `my_index` and `my_index1`
|
||||
and the type `my_type`:
|
||||
|
||||
image::searchprofiler/images/filter.png["Filtering by index and type"]
|
||||
image::dev-tools/searchprofiler/images/filter.png["Filtering by index and type"]
|
||||
|
||||
This is equivalent to `GET /my_index,my_index2/my_type/_search`.
|
|
@ -29,7 +29,7 @@ POST test/test/_bulk
|
|||
grayed-out `_all`). This restricts profiled queries to the `test` index.
|
||||
+
|
||||
--
|
||||
image::searchprofiler/images/gs7.png["Using the index filter"]
|
||||
image::dev-tools/searchprofiler/images/gs7.png["Using the index filter"]
|
||||
--
|
||||
|
||||
. Replace the default `match_all` query with a query that has two sub-query
|
||||
|
@ -74,7 +74,7 @@ the following query into the query editor.
|
|||
. Click *Profile* to profile the query and visualize the results.
|
||||
+
|
||||
--
|
||||
image::searchprofiler/images/gs8.png["Profiling the more complicated query"]
|
||||
image::dev-tools/searchprofiler/images/gs8.png["Profiling the more complicated query"]
|
||||
|
||||
As before, you'll see a list of shards appear in the center panel. You'll notice
|
||||
that the query was slightly slower (15ms vs 0.13ms) because it actually had to do
|
||||
|
@ -84,7 +84,7 @@ a bit of work this time, unlike the `match_all` query.
|
|||
. Click the first shard's Expand button to view the query details.
|
||||
+
|
||||
--
|
||||
image::searchprofiler/images/gs9.png["Drilling into the first shard's details"]
|
||||
image::dev-tools/searchprofiler/images/gs9.png["Drilling into the first shard's details"]
|
||||
|
||||
--
|
||||
|
||||
|
@ -113,7 +113,7 @@ This particular query also includes a aggregation (a `stats` agg on the `"age"`
|
|||
To view Aggregation profiling statistics, click the *Aggregation Profile* tab. This tab
|
||||
is only enabled if the query being profiled contains an aggregation.
|
||||
|
||||
image::searchprofiler/images/gs10.png["Drilling into the first shard's details"]
|
||||
image::dev-tools/searchprofiler/images/gs10.png["Drilling into the first shard's details"]
|
||||
|
||||
Click a shard's Expand button to view the aggregation details. Hover over an
|
||||
aggregation row to view the timing breakdown.
|
|
@ -157,4 +157,4 @@ query editor and click *Profile*:
|
|||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
||||
image::searchprofiler/images/pasting.png["Visualizing pre-collected responses"]
|
||||
image::dev-tools/searchprofiler/images/pasting.png["Visualizing pre-collected responses"]
|
|
@ -55,10 +55,6 @@ include::graph/index.asciidoc[]
|
|||
|
||||
include::dev-tools.asciidoc[]
|
||||
|
||||
include::{xkb-repo-dir}/searchprofiler/index.asciidoc[]
|
||||
|
||||
include::{xkb-repo-dir}/grokdebugger/index.asciidoc[]
|
||||
|
||||
include::{xkb-repo-dir}/monitoring/index.asciidoc[]
|
||||
|
||||
include::management.asciidoc[]
|
||||
|
|