[8.8] [DOCS] Adds log pattern analysis in Discover docs (#158059) (#158169)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Adds log pattern analysis in Discover docs
(#158059)](https://github.com/elastic/kibana/pull/158059)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"István Zoltán
Szabó","email":"szabosteve@gmail.com"},"sourceCommit":{"committedDate":"2023-05-22T10:34:15Z","message":"[DOCS]
Adds log pattern analysis in Discover docs (#158059)\n\nCo-authored-by:
gchaps
<33642766+gchaps@users.noreply.github.com>","sha":"a3c940f0cdcdfec46eb5a916be67e557d36a4b59","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":[":ml","release_note:skip","docs","v8.8.0","v8.9.0"],"number":158059,"url":"https://github.com/elastic/kibana/pull/158059","mergeCommit":{"message":"[DOCS]
Adds log pattern analysis in Discover docs (#158059)\n\nCo-authored-by:
gchaps
<33642766+gchaps@users.noreply.github.com>","sha":"a3c940f0cdcdfec46eb5a916be67e557d36a4b59"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158059","number":158059,"mergeCommit":{"message":"[DOCS]
Adds log pattern analysis in Discover docs (#158059)\n\nCo-authored-by:
gchaps
<33642766+gchaps@users.noreply.github.com>","sha":"a3c940f0cdcdfec46eb5a916be67e557d36a4b59"}}]}]
BACKPORT-->

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
This commit is contained in:
Kibana Machine 2023-05-22 07:00:19 -04:00 committed by GitHub
parent acba2cd62c
commit 5a2df61000
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 44 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 563 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

View file

@ -0,0 +1,38 @@
[[run-pattern-analysis-discover]]
== Run a pattern analysis on your log data
preview::[]
include::../user/ml/index.asciidoc[tag=log-pattern-analysis-intro]
Log pattern analysis works on every text field.
This example uses the <<gs-get-data-into-kibana, sample web logs data>>, or you
can use your own data.
. Open the main menu, and click *Discover*.
. Expand the {data-source} dropdown, and select *Kibana Sample Data Logs*.
. If you don't see any results, expand the time range, for example, to
*Last 15 days*.
. Click the `message` field in the **Available fields** list sidebar and click
**Run pattern analysis**.
+
--
[role="screenshot"]
image::images/log-pattern-analysis-available-fields.png["Available fields view in Discover showing the message field selected."]
The pattern analysis starts. The results are displayed in a flyout when the
analysis is complete.
[role="screenshot"]
image::images/log-pattern-analysis-results.png["Log pattern analysis results in Discover."]
--
. (optional) Apply filters to one or more patterns. *Discover* only displays
documents that match the selected patterns. Additionally, you can remove
selected patterns from *Discover*, resulting in the display of only those
documents that don't match the selected pattern. These options enable you to
remove unimportant messages and focus on the more important, actionable data
during troubleshooting.

View file

@ -344,4 +344,6 @@ include::{kib-repo-dir}/discover/save-search.asciidoc[]
include::{kib-repo-dir}/discover/field-statistics.asciidoc[]
include::{kib-repo-dir}/discover/search-sessions.asciidoc[]
include::{kib-repo-dir}/discover/log-pattern-analysis.asciidoc[]
include::{kib-repo-dir}/discover/search-sessions.asciidoc[]

View file

@ -151,11 +151,14 @@ image::user/ml/images/ml-explain-log-rate.png[Log rate spike explained]
preview::[]
// The following intro is used on the `run-pattern-analysis-discover` page.
//tag::log-pattern-analysis-intro[]
Log pattern analysis helps you to find patterns in unstructured log messages and
makes it easier to examine your data. It performs categorization analysis on a
selected field of a {data-source}, creates categories based on the data and
displays them together with a chart that shows the distribution of each category
and an example document that matches the category.
//end::log-pattern-analysis-intro[]
You can find log pattern analysis under **{ml-app}** > **AIOps Labs** where you
can select the {data-source} or saved search that you want to analyze, or in