github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.14] [DOCS] Adjusts log rate analysis docs (#185008) (#186070)

Browse source 
# Backport

This will backport the following commits from `main` to `8.14`:
- [[DOCS] Adjusts log rate analysis docs
(#185008)](https://github.com/elastic/kibana/pull/185008)

<!--- Backport version: 9.4.3 -->

### 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":"2024-06-12T09:19:14Z","message":"[DOCS]
Adjusts log rate analysis docs (#185008)\n\n## Summary\r\n\r\nThis PR
slightly adjusts the Log rate analysis docs to:\r\n\r\n* separate the
conceptual info more distinctively from the Kibana\r\nrelevant
parts,\r\n* highlight that the component is embedded in other
UIs.","sha":"3ae7ba5ad9c82c51d38448fe07d6dba6c6b2627c","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.13.0","v8.14.0","v8.15.0"],"title":"[DOCS]
Adjusts log rate analysis
docs","number":185008,"url":"https://github.com/elastic/kibana/pull/185008","mergeCommit":{"message":"[DOCS]
Adjusts log rate analysis docs (#185008)\n\n## Summary\r\n\r\nThis PR
slightly adjusts the Log rate analysis docs to:\r\n\r\n* separate the
conceptual info more distinctively from the Kibana\r\nrelevant
parts,\r\n* highlight that the component is embedded in other
UIs.","sha":"3ae7ba5ad9c82c51d38448fe07d6dba6c6b2627c"}},"sourceBranch":"main","suggestedTargetBranches":["8.13","8.14"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/185008","number":185008,"mergeCommit":{"message":"[DOCS]
Adjusts log rate analysis docs (#185008)\n\n## Summary\r\n\r\nThis PR
slightly adjusts the Log rate analysis docs to:\r\n\r\n* separate the
conceptual info more distinctively from the Kibana\r\nrelevant
parts,\r\n* highlight that the component is embedded in other
UIs.","sha":"3ae7ba5ad9c82c51d38448fe07d6dba6c6b2627c"}}]}] BACKPORT-->

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
This commit is contained in:
Kibana Machine 2024-06-12 11:50:01 +02:00 • committed by GitHub
parent 38e6017190
commit 0c1378b7c0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/user/ml/index.asciidoc
View file

@ -148,35 +148,27 @@ advanced statistical methods to help you interpret your data and its behavior.
[[log-rate-analysis]]
=== Log rate analysis
Log rate analysis is a feature that uses advanced statistical methods to
identify reasons for increases or decreases in log rates. It makes it easy to
find and investigate causes of unusual spikes or drops by using the analysis
workflow view. Examine the histogram chart of the log rates for a given
{data-source}, and find the reason behind a particular change possibly in
millions of log events across multiple fields and values.
Log rate analysis uses advanced statistical methods to identify reasons for increases or decreases in log rates and displays the statistically significant data in a tabular format.
It makes it easy to find and investigate causes of unusual spikes or drops by using the analysis workflow view.
Examine the histogram chart of the log rates for a given {data-source}, and find the reason behind a particular change possibly in millions of log events across multiple fields and values.
You can find log rate analysis under **{ml-app}** > **AIOps Labs** where
you can select the {data-source} or saved search that you want to analyze.
You can find log rate analysis embedded in multiple applications.
In {kib}, you can find it under **{ml-app}** > **AIOps Labs** where you can select the {data-source} or saved search that you want to analyze.
[role="screenshot"]
image::user/ml/images/ml-log-rate-analysis-before.png[Log event histogram chart]
Select a spike or drop in the log event histogram chart to start the analysis. It
identifies statistically significant field-value combinations that contribute to
the spike or drop and displays them in a table. You can optionally choose to summarize
the results into groups. The table also shows an indicator of the level of
impact and a sparkline showing the shape of the impact in the chart. Hovering
over a row displays the impact on the histogram chart in more detail. You can
inspect a field in **Discover**, further investigate in **Log pattern analysis**,
or copy the table row information as a query filter to the clipboard by
selecting the corresponding option under the **Actions** column. You can also
pin a table row by clicking on it then move the cursor to the histogram chart.
It displays a tooltip with exact count values for the pinned field which enables
closer investigation.
Select a spike or drop in the log event histogram chart to start the analysis.
It identifies statistically significant field-value combinations that contribute to the spike or drop and displays them in a table.
You can optionally choose to summarize the results into groups.
The table also shows an indicator of the level of impact and a sparkline showing the shape of the impact in the chart.
Hovering over a row displays the impact on the histogram chart in more detail.
You can inspect a field in **Discover**, further investigate in **Log pattern analysis**, or copy the table row information as a query filter to the clipboard by selecting the corresponding option under the **Actions** column.
You can also pin a table row by clicking on it then move the cursor to the histogram chart.
It displays a tooltip with exact count values for the pinned field which enables closer investigation.
Brushes in the chart show the baseline time range and the deviation in the
analyzed data. You can move the brushes to redefine both the baseline and the
deviation and rerun the analysis with the modified values.
Brushes in the chart show the baseline time range and the deviation in the analyzed data.
You can move the brushes to redefine both the baseline and the deviation and rerun the analysis with the modified values.
[role="screenshot"]
image::user/ml/images/ml-log-rate-analysis.png[Log rate spike explained]