github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[APM][docs] Updates to documentation for 7.5 (#50988)

Browse source
This commit is contained in:
Brandon Morelli 2019-11-20 07:36:59 -08:00 • committed by GitHub
parent ddb3c678dd
commit 063a4f2935
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 49 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/apm/advanced-queries.asciidoc
View file

@ -10,7 +10,7 @@ so it's easy to share a specific query or view with others.
In the screenshot below, you can begin to see some of the transaction fields available for filtering on:
[role="screenshot"]
image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM UI in Kibana]
image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM app in Kibana]
[float]
==== Example queries

29
docs/apm/agent-configuration.asciidoc
View file

@ -2,18 +2,15 @@
[[agent-configuration]]
=== APM Agent configuration
beta[] APM Agent configuration allows you to fine-tune your agent configuration directly in Kibana.
APM Agent configuration allows you to fine-tune your agent configuration directly in Kibana.
Best of all, changes are automatically propagated to your APM agents so there's no need to redeploy.
To get started, simply choose the service and environment you wish to configure.
To get started, simply choose the services and environments you wish to configure.
The APM app will let you know when your configurations have been applied by your agents.
[role="screenshot"]
image::apm/images/apm-agent-configuration.png[APM Agent configuration in Kibana]
IMPORTANT: As this feature is in Beta, a limited number of configuration settings are supported.
We recommend you watch your agent logs to confirm that configuration has been applied.
If you have feedback, please reach out in our https://discuss.elastic.co/c/apm[Discuss forum].
[float]
==== Precedence
@ -34,6 +31,26 @@ Kibana communicates any changed settings to APM Server so that your agents only
[float]
==== Supported configurations
[float]
===== `CAPTURE_BODY`
added[7.5.0] Can be `"off"`, `"errors"`, `"transactions"`, or `"all"`. Defaults to `"off"`.
For transactions that are HTTP requests, the Agent can optionally capture the request body, e.g., POST variables.
Remember, request bodies often contain sensitive values like passwords, credit card numbers, etc.
If your service handles sensitive data, enable this feature with care.
Turning on body capturing can also significantly increase the overhead the overhead of the Agent,
and the Elasticsearch index size.
[float]
===== `TRANSACTION_MAX_SPANS`
added[7.5.0] A number between `0` and `32000`. Defaults to `500`.
Limit the number of spans that are recorded per transaction.
This is helpful in cases where a transaction creates a very high amount of spans, e.g., thousands of SQL queries.
Setting an upper limit will help prevent the Agent and the APM Server from being overloaded.
[float]
===== `TRANSACTION_SAMPLE_RATE`

6
docs/apm/errors.asciidoc
View file

@ -10,12 +10,12 @@ This makes it very easy to quickly see which errors are affecting your services,
and to take actions to rectify them.
[role="screenshot"]
image::apm/images/apm-errors-overview.png[Example view of the errors overview in the APM UI in Kibana]
image::apm/images/apm-errors-overview.png[Example view of the errors overview in the APM app in Kibana]
Selecting an error group ID or error message brings you to the *Error group*.
[role="screenshot"]
image::apm/images/apm-error-group.png[Example view of the error group page in the APM UI in Kibana]
image::apm/images/apm-error-group.png[Example view of the error group page in the APM app in Kibana]
Here, you'll see the error message, culprit, and the number of occurrences over time.
@ -43,4 +43,4 @@ With Watcher, your team can set up reports within minutes.
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 app in Kibana]

2
docs/apm/getting-started.asciidoc
View file

@ -10,7 +10,7 @@ image::apm/images/apm-setup.png[Installation instructions on the APM page in Kib
Index patterns tell Kibana which Elasticsearch indices you want to explore.
An APM index pattern is necessary for certain features in the APM UI, like the query bar.
An APM index pattern is necessary for certain features in the APM app, like the query bar.
To set up the correct index pattern,
simply click *Load Kibana objects* at the bottom of the Setup Instructions.

BIN
docs/apm/images/apm-metrics.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 476 KiB

After

Width:  |  Height:  |  Size: 138 KiB

Before After
Before After

BIN
docs/apm/images/jvm-metrics.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 413 KiB

14
docs/apm/metrics.asciidoc
View file

@ -2,13 +2,21 @@
=== Metrics overview
The *Metrics* overview provides agent-specific metrics,
which lets you perform more in-depth root cause analysis investigations within the APM UI.
which lets you perform more in-depth root cause analysis investigations within the APM app.
If you're experiencing a problem with your service, you can use this page to attempt to find the underlying cause.
For example, you might be able to correlate a high number of errors with a long transaction duration, high CPU usage, or a memory leak.
[role="screenshot"]
image::apm/images/apm-metrics.png[Example view of the Metrics overview in APM UI in Kibana]
image::apm/images/apm-metrics.png[Example view of the Metrics overview in APM app in Kibana]
If you're using the Java Agent, the metrics view focuses on JVMs.
A detailed view of metrics per JVM makes it much easier to analyze the provided metrics:
CPU usage, memory usage, heap or non-heap memory,
thread count, garbage collection rate, and garbage collection time spent per minute.
[role="screenshot"]
image::apm/images/jvm-metrics.png[Example view of the Metrics overview for the Java Agent]
[[machine-learning-integration]]
=== Machine Learning integration
@ -17,7 +25,7 @@ The Machine Learning integration will initiate a new job predefined to calculate
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]
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in APM app 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*.

2
docs/apm/services.asciidoc
View file

@ -6,4 +6,4 @@ The *Services* overview gives you quick insights into the health and general per
You can add services by setting the `service.name` configuration in each of the {apm-agents-ref}[APM agents] you’re instrumenting.
[role="screenshot"]
image::apm/images/apm-services-overview.png[Example view of services table the APM UI in Kibana]
image::apm/images/apm-services-overview.png[Example view of services table the APM app in Kibana]

8
docs/apm/spans.asciidoc
View file

@ -9,7 +9,7 @@ The span timeline visualization is a bird's-eye view of what your application wa
This makes it useful for visualizing where the selected transaction spent most of its time.
[role="screenshot"]
image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM UI in Kibana]
image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM app in Kibana]
View a span in detail by clicking on it in the timeline waterfall.
For example, in the below screenshot we've clicked on an SQL Select database query.
@ -20,13 +20,13 @@ Finally, APM knows which files are your code and which are just modules or libra
These library frames will be minimized by default in order to show you the most relevant stack trace.
[role="screenshot"]
image::apm/images/apm-span-detail.png[Example view of a span detail in the APM UI in Kibana]
image::apm/images/apm-span-detail.png[Example view of a span detail in the APM app in Kibana]
If your span timeline is colorful, it's indicative of a <<distributed-tracing,distributed trace>>.
Services in a distributed trace are separated by color and listed in the order they occur.
[role="screenshot"]
image::apm/images/apm-services-trace.png[Example of distributed trace colors in the APM UI in Kibana]
image::apm/images/apm-services-trace.png[Example of distributed trace colors in the APM app in Kibana]
Don't forget, a distributed trace includes more than one transaction.
When viewing these distributed traces in the timeline waterfall, you'll see this image:apm/images/transaction-icon.png[APM icon] icon,
@ -37,4 +37,4 @@ After exploring these traces,
you can return to the full trace by clicking *View full trace* in the upper right hand corner of the page.
[role="screenshot"]
image::apm/images/apm-transaction-sample.png[Example of distributed trace colors in the APM UI in Kibana]
image::apm/images/apm-transaction-sample.png[Example of distributed trace colors in the APM app in Kibana]

6
docs/apm/traces.asciidoc
View file

@ -11,7 +11,7 @@ it's the collective amount of pain a specific endpoint is causing your users.
If there's a particular endpoint you're worried about, you can click on it to view the <<transaction-details, transaction details>>.
[role="screenshot"]
image::apm/images/apm-traces.png[Example view of the Traces overview in APM UI in Kibana]
image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in Kibana]
[float]
[[distributed-tracing]]
@ -22,7 +22,7 @@ Distributed tracing is a key feature of modern application performance monitorin
service-based architectures.
Distributed tracing allows APM users to automatically trace requests all the way through the service architecture,
and visualize those traces in one single view in the APM UI.
and visualize those traces in one single view in the APM app.
This is accomplished by tracing all of the requests, from the initial web request to your front-end service,
to queries made to your back-end services.
This makes finding possible bottlenecks throughout your application much easier and faster.
@ -31,6 +31,6 @@ By definition, a distributed trace includes more than one transaction.
You can use the <<spans,span timeline visualization>> to view a waterfall display of all of the transactions from individual services that are connected in a trace.
[role="screenshot"]
image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM UI in Kibana]
image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM app in Kibana]
TIP: Distributed tracing is supported by all APM agents and there’s no additional configuration needed.

6
docs/apm/transactions.asciidoc
View file

@ -10,9 +10,9 @@ The *Transactions* table, however, provides only a list of _transaction groups_
In other words, this view groups all transactions of the same name together, and only displays one transaction for each group.
[role="screenshot"]
image::apm/images/apm-transactions-overview.png[Example view of transactions table in the APM UI in Kibana]
image::apm/images/apm-transactions-overview.png[Example view of transactions table in the APM app in Kibana]
*Time spent by span type* -- beta[] Certain agents support breakdown graphs in the APM UI.
*Time spent by span type* -- Most agents support breakdown graphs in the APM app.
This graph is an easy way to visualize where your application is spending most of its time.
For example, is your app spending time in external calls, database processing, or application code execution?
@ -22,8 +22,6 @@ This could be a sign that the agent does not have auto-instrumentation for whate
It's important to note that if you have asynchronous spans, the sum of all span times may exceed the duration of the transaction.
TIP: If the *Time spent by span type* chart is missing in the APM UI, it means your agent does not support this feature yet.
*Transaction duration* shows the response times for this service and is broken down into average, 95th, and 99th percentile.
If there's a weird spike that you'd like to investigate,
you can simply zoom in on the graph - this will adjust the specific time range,