forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into elastic#17576
- Loading branch information
Showing
2,688 changed files
with
139,213 additions
and
83,702 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
[[errors]] | ||
=== Errors overview | ||
|
||
TIP: {apm-overview-ref-v}/errors.html[Errors] are defined as groups of exceptions with matching exception or log messages. | ||
|
||
The *Errors* overview provides a high-level view of the error message and culprit, | ||
the number of occurrences, and the most recent occurrence. | ||
Just like the transaction overview, you'll notice we group together like errors. | ||
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] | ||
|
||
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] | ||
|
||
Here, you'll see the error message, culprit, and the number of occurrences over time. | ||
|
||
Further down, you'll see the Error occurrence table. | ||
This is where you can see the details of a sampled error within this group. | ||
The error shown is always the most recent to occur. | ||
|
||
Each error occurrence features a breakdown of the exception, including the stack trace from when the error occurred, | ||
and additional contextual information to help debug the issue. | ||
In some cases, you might also see a Transaction sample ID. | ||
This feature allows you to make a connection between the errors and transactions, | ||
by linking you to the specific transaction where the error occurred. | ||
This allows you to see the whole trace, including which services the request went through. | ||
|
||
[float] | ||
[[errors-alerts-with-watcher]] | ||
==== Error reports with Watcher | ||
|
||
You can use the power of the alerting features with Watcher to get reports on error occurrences. | ||
The Watcher assistant, which is available on the errors overview, can help you set up a watch per service. | ||
|
||
Configure the watch with an occurrences threshold, time interval, and the desired actions, such as email or Slack notifications. | ||
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
[[metrics]] | ||
=== Metrics overview | ||
|
||
The *Metrics* overview shows a combination of transaction, error, CPU, and memory data. | ||
|
||
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] | ||
|
||
[[machine-learning-integration]] | ||
=== Machine Learning integration | ||
|
||
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*. | ||
It might take some time for results to appear on the graph. | ||
|
||
Machine learning is a platinum feature. For a comparison of the Elastic license levels, | ||
see https://www.elastic.co/subscriptions[the subscription page]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
[[query-bar]] | ||
=== Advanced queries | ||
|
||
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. | ||
You can select the query bar and hit the down arrow on your keyboard to begin seeing recommendations. | ||
|
||
When querying, you're simply searching and selecting data from fields in Elasticsearch documents. | ||
It may be helpful to view some of your documents in {kibana-ref}/discover.html[Discover] to better understand how APM data is stored in Elasticsearch. | ||
|
||
The query bar is available in the Services, Transactions, Errors, Metrics, and Traces views, | ||
and any input will persist as you move between pages. | ||
|
||
TIP: Interactions with the query bar change the URL of the page you're on. | ||
This means you can simply copy and paste the URL of your page 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] | ||
|
||
==== Example queries | ||
|
||
* Exclude response times slower 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` | ||
* View _all_ transactions for an endpoint, instead of just a sample - `processor.event: "transaction" AND transaction.name: "<TRANSACTION_NAME_HERE>"` | ||
|
||
TIP: Read the {kibana-ref}/kuery-query.html[Kibana Query Language Enhancements] documentation to learn more about the capabilities of the {kib} query language. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[[services]] | ||
=== Services overview | ||
|
||
The *Services* overview gives you quick insights into the health and general performance of each service. | ||
The <<set-time-filter,global time range filter>> in {kib} defines which services are available. | ||
|
||
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
[[spans]] | ||
=== Span timeline | ||
|
||
TIP: A {apm-overview-ref-v}/transaction-spans.html[span] is defined as the duration of a single event. | ||
Spans are automatically captured by APM agents, and you can also define custom spans. | ||
Each span has a type and is defined by a different color in the timeline/waterfall visualization. | ||
|
||
The span timeline visualization is a bird's-eye view of what your application was doing while it was trying to respond to the request that came in. | ||
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] | ||
|
||
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. | ||
The information displayed includes the actual SQL that was executed, how long it took, | ||
and the percentage of the trace's total time. | ||
You also get a stack trace, which shows the SQL query in your code. | ||
Finally, APM knows which files are your code and which are just modules or libraries that you've installed. | ||
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] | ||
|
||
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] | ||
|
||
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, | ||
which indicates the next transaction in the trace. | ||
These transactions can be expanded and viewed in detail by clicking on them. | ||
|
||
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-view-full-trace.png[Example of distributed trace colors in the APM UI in Kibana] |
Oops, something went wrong.