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

[DOCS] APM UI docs for ML and query bar features (#21727)

Browse source 
Adding content for Machine Learning integration and query bar UI in the Using the APM UI docs.
This commit is contained in:
Casper Hübertz 2018-08-08 11:54:17 +02:00 • committed by GitHub
parent 42634bdc46
commit 92026c3db8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 39 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/apm/images/apm-ml-integration.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 73 KiB

BIN
docs/apm/images/apm-query-bar.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 201 KiB

40
docs/apm/using-the-apm-ui.asciidoc
View file

@ -9,6 +9,8 @@ The APM UI is designed to be as intuitive as possible, but you might come across
* <<spans>>
* <<errors>>
* <<errors-alerts-with-watcher>>
* <<machine-learning-integration>>
* <<query-bar>>
[[services]]
=== Services
@ -60,4 +62,40 @@ Configure the watch with occurrences threshold and time interval and set the des
Watches are managed separately in the dedicated Watcher UI available in Advanced Settings.
[role="screenshot"]
image::apm/images/apm-errors-watcher-assistant.png[Example view of the Watcher assistant for errors in APM UI in Kibana]
image::apm/images/apm-errors-watcher-assistant.png[Example view of the Watcher assistant for errors in APM UI in Kibana]
[[machine-learning-integration]]
=== Machine Learning integration (beta)
[NOTE]
============
Please note this feature is in beta. We kindly ask that you https://discuss.elastic.co/c/apm[provide feedback] if you experience any issues.
============
The Machine Learning integration will initiate a new job predefined to calculate anomaly scores on transaction response times. The response time graph will show the expected bounds and annotate the graph when the anomaly score is 75 or above.
[role="screenshot"]
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in APM UI in Kibana]
Jobs can be created per transaction type and based on the average response time. You can manage jobs in the Machine Learning jobs management page. It might take some time for results to appear on the graph.
[[query-bar]]
=== Query bar (beta)
[NOTE]
============
Please note this feature is in beta. We kindly ask that you https://discuss.elastic.co/c/apm[provide feedback] if you experience any issues.
============
The query bar is a powerful data query feature. Similar to the query bar in {kibana-ref}/discover.html[Discover] it enables you to pass advanced queries on your data to filter on particular pieces of information that you're interested in. It comes with a handy autocomplete that helps find the fields and even provides suggestions to the data they include. The query bar is available on Services, Transaction and Errors views, and any input will persist as you move between them.
[role="screenshot"]
image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM UI in Kibana]
==== Example queries
* Exclude response times faster than 2000 ms; `transaction.duration.us > 2000000`
* Filter by response status code; `context.response.status_code >= 400`
* Filter by single user ID; `context.user.id : 12`
Read the {kibana-ref}/kuery-query.html[Kibana Query Language Enhancements] documentation to learn more about the capabilities in the Kibana query language.