Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[APM] Documentation updates #160951

Merged
merged 5 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/apm/agent-explorer.asciidoc
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yngrdyn — you were listed as the contact for Agent explorer. Do you have anything to add here?

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[[agent-explorer]]
=== APM Agent explorer

++++
<titleabbrev>Identify deployment details for APM agents</titleabbrev>
++++

beta::[]

APM agent explorer provides a centralized panel to identify APM agent deployment details, like service name, environment, instances, and agent name, version, and documentation.

[role="screenshot"]
image::apm/images/apm-agent-explorer.png[APM agent explorer]

Select an APM agent to expand it and view the details of each agent instance.

[role="screenshot"]
image::apm/images/apm-agent-explorer-flyout.png[APM agent explorer flyout]
16 changes: 16 additions & 0 deletions docs/apm/dependencies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,19 @@ If your usage pattern _has_ changed, the dependency view can quickly show you wh
that pattern change exists in all upstream services, or just a subset of your services.
You might then start digging into traces coming from
impacted services to determine why that pattern change has occurred.

[float]
[[dependencies-operations]]
==== Operations

beta::[]

**Dependency operations** provides a granular breakdown of the operations/queries a dependency is executing.

[role="screenshot"]
image::apm/images/operations.png[operations view in the APM app in Kibana]

Selecting an operation displays the operation's impact and performance trends over time, via key metrics like latency, throughput, and failed transaction rate. In addition, the <<spans,**Trace sample timeline**>> provides a visual drill-down into an end-to-end trace sample.

[role="screenshot"]
image::apm/images/operations-detail.png[operations detail view in the APM app in Kibana]
3 changes: 3 additions & 0 deletions docs/apm/how-to-guides.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Learn how to perform common APM app tasks.
* <<custom-links>>
* <<filters>>
* <<correlations>>
* <<agent-explorer>>
* <<machine-learning-integration>>
* <<apm-lambda>>
* <<advanced-queries>>
Expand All @@ -30,6 +31,8 @@ include::filters.asciidoc[]

include::correlations.asciidoc[]

include::agent-explorer.asciidoc[]

include::machine-learning.asciidoc[]

include::lambda.asciidoc[]
Expand Down
Binary file added docs/apm/images/apm-agent-explorer-flyout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apm/images/apm-agent-explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apm/images/operations-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apm/images/operations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apm/images/trace-explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/apm/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,14 @@ include::./../settings/apm-settings.asciidoc[tag=apm-indices-settings]
=== General APM settings

include::./../settings/apm-settings.asciidoc[tag=general-apm-settings]

[float]
[[apm-labs]]
=== APM Labs

**APM Labs** allows you to easily try out new features that are technical preview.

To enable APM labs, navigate to **APM** > **Settings** > **General settings** and toggle **Enable labs button in APM**.
Select **Save changes** and refresh the page.

After enabling **APM Labs** select **Labs** in the toolbar to see the technical preview features available to try out.
15 changes: 15 additions & 0 deletions docs/apm/traces.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,18 @@ If there's a particular endpoint you're worried about, select it to view its

[role="screenshot"]
image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in Kibana]

[float]
[[trace-explorer]]
==== Trace explorer
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dgieselaar there's not really any substance in the docs I've added here. Can you help me understand what trace explorer adds—why would someone want to use this feature and how can they benefit from it?


preview::[]

**Trace explorer** is an experimental top-level search tool that allows you to query your traces using <<kuery-query,Kibana Query Language (KQL)>> or {ref}/eql.html[Event Query Language (EQL)].

Curate your own custom queries, or use the <<service-maps,**Service map**>> to find and select edges to automatically generate queries based on your selection:

[role="screenshot"]
image::apm/images/trace-explorer.png[Trace explorer]

Enable **Trace explorer** in <<apm-labs,APM Labs>> or in <<observability-apm-trace-explorer-tab,{kib} advanced settings>>.
14 changes: 14 additions & 0 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -393,9 +393,20 @@ value is 10000.
[[apm-enable-service-overview]]`apm:enableServiceOverview`::
When enabled, displays the *Overview* tab for services in *APM*.

[[observability-apm-critical-path]]`observability:apmEnableCriticalPath`::
When enabled, displays the critical path of a trace.

[[observability-enable-progressive-loading]]`observability:apmProgressiveLoading`::
preview:[] When enabled, uses progressive loading of some APM views.
Data may be requested with a lower sampling rate first, with lower accuracy but faster response times,
while the unsampled data loads in the background.

[[observability-apm-optimized-sort]]`observability:apmServiceInventoryOptimizedSorting`::
preview:[] Sorts services without anomaly detection rules on the APM Service inventory page by service name.

[[observability-enable-aws-lambda-metrics]]`observability:enableAwsLambdaMetrics`::
preview:[] Display Amazon Lambda metrics in the service metrics tab.

[[observability-apm-enable-comparison]]`observability:enableComparisonByDefault`::
Enables the comparison feature in the APM app.

Expand All @@ -408,6 +419,9 @@ When enabled, allows you to inspect {es} queries in API responses.
[[observability-apm-enable-service-groups]]`observability:enableServiceGroups`::
preview:[] When enabled, allows users to create Service Groups from the APM Service Inventory page.

[[observability-apm-trace-explorer-tab]]`observability:apmTraceExplorerTab`::
preview:[] Enable the APM Trace Explorer feature, that allows you to search and inspect traces with KQL or EQL.

[float]
[[kibana-reporting-settings]]
==== Reporting
Expand Down