Skip to content

Commit

Permalink
Merge branch 'master' into job-import-and-export
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine committed Jul 21, 2021
2 parents 74bee14 + 3039db2 commit 6276a87
Show file tree
Hide file tree
Showing 525 changed files with 13,822 additions and 6,907 deletions.
34 changes: 18 additions & 16 deletions docs/dev-tools/console/console.asciidoc
@@ -1,7 +1,7 @@
[[console-kibana]]
== Console

Console enables you to interact with the REST API of {es}. You can:
*Console* enables you to interact with the REST API of {es}. You can:

* Send requests to {es} and view the responses
* View API documentation
Expand All @@ -12,13 +12,13 @@ To get started, open the main menu, click *Dev Tools*, then click *Console*.
[role="screenshot"]
image::dev-tools/console/images/console.png["Console"]

NOTE: You are unable to interact with the REST API of {kib} with the Console.
NOTE: You cannot to interact with the REST API of {kib} with the Console.

[float]
[[console-api]]
=== Write requests

Console understands commands in a cURL-like syntax.
*Console* understands commands in a cURL-like syntax.
For example, the following is a `GET` request to the {es} `_search` API.

[source,js]
Expand All @@ -43,8 +43,8 @@ curl -XGET "http://localhost:9200/_search" -d'
}'
----------------------------------

When you paste the command into Console, {kib} automatically converts it
to Console syntax. Alternatively, if you want to see Console syntax in cURL,
When you paste the command into *Console*, {kib} automatically converts it
to *Console* syntax. Alternatively, if you want to see *Console* syntax in cURL,
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
Once copied, the username and password will need to be provided
for the calls to work from external environments.
Expand All @@ -53,7 +53,7 @@ for the calls to work from external environments.
[[console-autocomplete]]
==== Autocomplete

When you're typing a command, Console makes context-sensitive suggestions.
When you're typing a command, *Console* makes context-sensitive suggestions.
These suggestions show you the parameters for each API and speed up your typing.
To configure your preferences for autocomplete, go to
<<configuring-console, Settings>>.
Expand All @@ -69,15 +69,16 @@ and then select *Auto indent*.
For example, you might have a request formatted like this:

[role="screenshot"]
image::dev-tools/console/images/copy-curl.png["Console close-up"]
image::dev-tools/console/images/copy-curl.png["Console close-up", width=75%]
]

Console adjusts the JSON body of the request to apply the indents.
*Console* adjusts the JSON body of the request to apply the indents.

[role="screenshot"]
image::dev-tools/console/images/request.png["Console close-up"]
image::dev-tools/console/images/request.png["Console close-up", width=75%]

If you select *Auto indent* on a request that is already well formatted,
Console collapses the request body to a single line per document.
*Console* collapses the request body to a single line per document.
This is helpful when working with the {es} {ref}/docs-bulk.html[bulk APIs].


Expand All @@ -90,8 +91,9 @@ When you're ready to submit the request to {es}, click the
green triangle.

You can select multiple requests and submit them together.
Console sends the requests to {es} one by one and shows the output
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
*Console* sends the requests to {es} one by one and shows the output
in the response pane. Submitting multiple requests is helpful
when you're debugging an issue or trying query
combinations in multiple scenarios.


Expand All @@ -107,19 +109,19 @@ the action icon (image:dev-tools/console/images/wrench.png[]) and select
[[console-history]]
=== Get your request history

Console maintains a list of the last 500 requests that {es} successfully executed.
*Console* maintains a list of the last 500 requests that {es} successfully executed.
To view your most recent requests, click *History*. If you select a request
and click *Apply*, {kib} adds it to the editor at the current cursor position.

[float]
[[configuring-console]]
=== Configure Console settings

You can configure the Console font size, JSON syntax,
You can configure the *Console* font size, JSON syntax,
and autocomplete suggestions in *Settings*.

[role="screenshot"]
image::dev-tools/console/images/console-settings.png["Console Settings"]
image::dev-tools/console/images/console-settings.png["Console Settings", width=60%]

[float]
[[keyboard-shortcuts]]
Expand All @@ -132,7 +134,7 @@ shortcuts, click *Help*.
[[console-settings]]
=== Disable Console

If you don’t want to use Console, you can disable it by setting `console.enabled`
If you don’t want to use *Console*, you can disable it by setting `console.enabled`
to `false` in your `kibana.yml` configuration file. Changing this setting
causes the server to regenerate assets on the next startup,
which might cause a delay before pages start being served.
Binary file modified docs/dev-tools/console/images/console.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/console/images/copy-curl.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/console/images/request.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/grokdebugger/images/grok-debugger-overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/dev-tools/grokdebugger/index.asciidoc
@@ -1,19 +1,19 @@
[role="xpack"]
[[xpack-grokdebugger]]
== Debugging grok expressions
== Debug grok expressions

You can build and debug grok patterns in the {kib} *Grok Debugger*
before you use them in your data processing pipelines. Grok is a pattern
before you use them in your data processing pipelines. Grok is a pattern
matching syntax that you can use to parse arbitrary text and
structure it. Grok is good for parsing syslog, apache, and other
webserver logs, mysql logs, and in general, any log format that is
written for human consumption.
written for human consumption.

Grok patterns are supported in the ingest node
{ref}/grok-processor.html[grok processor] and the Logstash
{logstash-ref}/plugins-filters-grok.html[grok filter]. See
{logstash-ref}/plugins-filters-grok.html[grok filter]. See
{logstash-ref}/plugins-filters-grok.html#_grok_basics[grok basics]
for more information on the syntax for a grok pattern.
for more information on the syntax for a grok pattern.

The Elastic Stack ships
with more than 120 reusable grok patterns. See
Expand All @@ -27,10 +27,10 @@ in ingest node and Logstash.

[float]
[[grokdebugger-getting-started]]
=== Getting started with the Grok Debugger
=== Get started

This example walks you through using the *Grok Debugger*. This tool
is automatically enabled in {kib}.
is automatically enabled in {kib}.

NOTE: If you're using {stack-security-features}, you must have the `manage_pipeline`
permission to use the Grok Debugger.
Expand Down Expand Up @@ -66,12 +66,12 @@ image::dev-tools/grokdebugger/images/grok-debugger-overview.png["Grok Debugger"]

[float]
[[grokdebugger-custom-patterns]]
=== Testing custom patterns
=== Test custom patterns

If the default grok pattern dictionary doesn't contain the patterns you need,
you can define, test, and debug custom patterns using the Grok Debugger.
you can define, test, and debug custom patterns using the *Grok Debugger*.

Custom patterns that you enter in the Grok Debugger are not saved. Custom patterns
Custom patterns that you enter in the *Grok Debugger* are not saved. Custom patterns
are only available for the current debugging session and have no side effects.

Follow this example to define a custom pattern.
Expand Down
Binary file modified docs/dev-tools/painlesslab/images/painless-lab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/dev-tools/painlesslab/index.asciidoc
Expand Up @@ -4,14 +4,15 @@

beta::[]

The Painless Lab is an interactive code editor that lets you test and
The *Painless Lab* is an interactive code editor that lets you test and
debug {ref}/modules-scripting-painless.html[Painless scripts] in real-time.
You can use the Painless scripting
language to create <<scripted-fields, {kib} scripted fields>>,
process {ref}/docs-reindex.html[reindexed data], define complex
<<watcher-create-advanced-watch, Watcher conditions>>,
and work with data in other contexts.

To get started, open the main menu, click *Dev Tools*, then click *Painless Lab*.
To get started, open the main menu, click *Dev Tools*, and then click *Painless Lab*.

[role="screenshot"]
image::dev-tools/painlesslab/images/painless-lab.png[Painless Lab]
49 changes: 0 additions & 49 deletions docs/dev-tools/searchprofiler/getting-started.asciidoc

This file was deleted.

20 changes: 0 additions & 20 deletions docs/dev-tools/searchprofiler/gs-index.asciidoc

This file was deleted.

Binary file modified docs/dev-tools/searchprofiler/images/filter.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/searchprofiler/images/gs10.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/searchprofiler/images/gs8.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/searchprofiler/images/overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/dev-tools/searchprofiler/images/pasting.png
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6276a87

Please sign in to comment.