Skip to content

Commit

Permalink
replace apm app with apm ui
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Jul 22, 2024
1 parent 653204d commit 80425b5
Show file tree
Hide file tree
Showing 48 changed files with 150 additions and 150 deletions.
22 changes: 11 additions & 11 deletions docs/en/observability/apm-ui/advanced-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ You can select the query bar and hit the down arrow on your keyboard to begin sc

[float]
[[apm-app-advanced-queries]]
=== Querying in the APM app
=== Querying in the APM UI

When querying in the APM app, you’re merely searching and selecting data from fields in {es} documents. Queries entered
When querying in the APM UI, you’re merely searching and selecting data from fields in {es} documents. Queries entered
into the query bar are also added as parameters to the URL, so it’s easy to share a specific query or view with others.

When you type, you can begin to see some of the transaction fields available for filtering:

[role="screenshot"]
image::./images/apm-query-bar.png[Example of the Kibana Query bar in APM app in Kibana]
image::./images/apm-query-bar.png[Example of the Kibana Query bar in APM UI in Kibana]

[TIP]
=====
Expand All @@ -28,7 +28,7 @@ To learn more about the {kib} query language capabilities, see the {kibana-ref}/

[float]
[[apm-app-queries]]
==== APM app queries
==== APM UI queries

APM queries can be handy for removing noise from your data in the <<apm-services,Services>>, <<apm-transactions,Transactions>>,
<<apm-errors,Errors>>, <<apm-metrics,Metrics>>, and <<apm-traces,Traces>> views.
Expand All @@ -49,8 +49,8 @@ Or filter the list by including the service version and the Kubernetes pod it's
=== Querying in Discover

Alternatively, you can query your APM documents in {kibana-ref}/discover.html[*Discover*].
Querying documents in *Discover* works the same way as queries in the APM app,
and *Discover* supports all of the example APM app queries shown on this page.
Querying documents in *Discover* works the same way as queries in the APM UI,
and *Discover* supports all of the example APM UI queries shown on this page.

[float]
[[discover-queries]]
Expand All @@ -59,9 +59,9 @@ and *Discover* supports all of the example APM app queries shown on this page.
One example where you may want to make use of *Discover*
is to view _all_ transactions for an endpoint instead of just a sample.

TIP: Starting in v7.6, you can view ten samples per bucket in the APM app, instead of just one.
TIP: Starting in v7.6, you can view ten samples per bucket in the APM UI, instead of just one.

Use the APM app to find a transaction name and time bucket that you're interested in learning more about.
Use the APM UI to find a transaction name and time bucket that you're interested in learning more about.
Then, switch to *Discover* and make a search:

["source","sh"]
Expand All @@ -76,9 +76,9 @@ that took between 13 and 14 milliseconds. Here's what Discover returns:
image::./images/advanced-discover.png[View all transactions in bucket]

You can now explore the data until you find a specific transaction that you're interested in.
Copy that transaction's `transaction.id` and paste it into the APM app to view the data in the context of the APM app:
Copy that transaction's `transaction.id` and paste it into the APM UI to view the data in the context of the APM UI:

[role="screenshot"]
image::./images/specific-transaction-search.png[View specific transaction in apm app]
image::./images/specific-transaction-search.png[View specific transaction in APM UI]
[role="screenshot"]
image::./images/specific-transaction.png[View specific transaction in apm app]
image::./images/specific-transaction.png[View specific transaction in APM UI]
8 changes: 4 additions & 4 deletions docs/en/observability/apm-ui/agent-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
<titleabbrev>Configure APM agents with central config</titleabbrev>
++++

APM Agent configuration allows you to fine-tune your APM agent configuration from within the APM app.
APM Agent configuration allows you to fine-tune your APM agent configuration from within the APM UI.
Changes are automatically propagated to your APM agents, so there's no need to redeploy.

To get started, choose the services and environments you wish to configure.
The APM app will let you know when your APM agents have applied your configurations.
The APM UI will let you know when your APM agents have applied your configurations.

[role="screenshot"]
image::./images/apm-agent-configuration.png[APM Agent configuration in Kibana]

[float]
==== Precedence

Configurations set from the APM app take precedence over configurations set locally in each APM agent.
Configurations set from the APM UI take precedence over configurations set locally in each APM agent.
However, if APM Server is slow to respond, is offline, reports an error, etc.,
APM agents will use local defaults until they're able to update the configuration.
For this reason, it is still essential to set custom default configurations locally in each of your APM agents.
Expand All @@ -26,7 +26,7 @@ For this reason, it is still essential to set custom default configurations loca
==== Supported configurations

Each APM agent has a list of supported configurations.
After selecting a Service name and environment in the APM app,
After selecting a Service name and environment in the APM UI,
a list of all supported configuration options,
including descriptions and default values, will be displayed.

Expand Down
6 changes: 3 additions & 3 deletions docs/en/observability/apm-ui/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ users interacting with APM APIs must have <<apm-app-api-user,sufficient privileg
Typically, if you include the `kbn-xsrf` header, you must also include the `Content-Type` header.
// end::using-the-APIs[]

Here's an example CURL request that adds an annotation to the APM app:
Here's an example CURL request that adds an annotation to the APM UI:

[source,curl]
----
Expand Down Expand Up @@ -350,7 +350,7 @@ POST /api/apm/settings/agent-configuration/search
[[apm-annotation-api]]
=== Annotation API

The Annotation API allows you to annotate visualizations in the APM app with significant events, like deployments,
The Annotation API allows you to annotate visualizations in the APM UI with significant events, like deployments,
allowing you to easily see how these events are impacting the performance of your existing applications.

By default, annotations are stored in a newly created `observability-annotations` index.
Expand Down Expand Up @@ -410,7 +410,7 @@ include::api.asciidoc[tag=using-the-APIs]
(optional, string) The message displayed in the annotation. Defaults to `service.version`.

`tags`::
(optional, array) Tags are used by the APM app to distinguish APM annotations from other annotations.
(optional, array) Tags are used by the APM UI to distinguish APM annotations from other annotations.
Tags may have additional functionality in future releases. Defaults to `[apm]`.
While you can add additional tags, you cannot remove the `apm` tag.

Expand Down
14 changes: 7 additions & 7 deletions docs/en/observability/apm-ui/apm-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<titleabbrev>Create an alert</titleabbrev>
++++

The APM app allows you to define **rules** to detect complex conditions within your APM data
The APM UI allows you to define **rules** to detect complex conditions within your APM data
and trigger built-in **actions** when those conditions are met.

The following **rules** are supported:
Expand All @@ -19,7 +19,7 @@ Alert when either the latency of a service is anomalous. Anomaly rules can be se
Alert when the number of errors in a service exceeds a defined threshold. Error count rules can be set at the environment level, service level, and error group level.

[role="screenshot"]
image::./images/apm-alert.png[Create an alert in the APM app]
image::./images/apm-alert.png[Create an alert in the APM UI]

Below, we'll walk through the creation of two APM rules.

Expand All @@ -44,7 +44,7 @@ This guide will create an alert for all services based on the following criteria
* Check every five minutes
* Send an alert to a Slack channel when the rule status changes

From any page in the APM app, select **Alerts and rules** > **Create anomaly rule**.
From any page in the APM UI, select **Alerts and rules** > **Create anomaly rule**.
Change the name of the rule, but do not edit the tags.

Based on the criteria above, define the following rule details:
Expand Down Expand Up @@ -89,7 +89,7 @@ This guide will create an alert for an error group ID based on the following cri
* Check every 1 minute
* Send the alert via email to the site reliability team

From any page in the APM app, select **Alerts and rules** > **Create error count rule**.
From any page in the APM UI, select **Alerts and rules** > **Create error count rule**.
Change the name of the alert, but do not edit the tags.

Based on the criteria above, define the following rule details:
Expand Down Expand Up @@ -133,7 +133,7 @@ Click **Save**. The alert has been created and is now active!
[[apm-alert-view-active]]
=== View active alerts

Active alerts are displayed and grouped in multiple ways in the APM app.
Active alerts are displayed and grouped in multiple ways in the APM UI.

[float]
[[apm-alert-view-group]]
Expand All @@ -143,7 +143,7 @@ If you're using the <<service-groups,service groups>> feature, you can view aler
From the service group overview page, click the red alert indicator to open the **Alerts** tab with a predefined filter that matches the filter used when creating the service group.

[role="screenshot"]
image::./images/apm-service-group.png[Example view of service group in the APM app in Kibana]
image::./images/apm-service-group.png[Example view of service group in the APM UI in Kibana]

[float]
[[apm-alert-view-service]]
Expand All @@ -159,7 +159,7 @@ image::./images/active-alert-service.png[View active alerts by service]
[[apm-alert-manage]]
=== Manage alerts and rules

From the APM app, select **Alerts and rules** > **Manage rules** to be taken to
From the APM UI, select **Alerts and rules** > **Manage rules** to be taken to
the {kib} *{rules-ui}* page.
From this page, you can disable, mute, and delete APM alerts.

Expand Down
24 changes: 12 additions & 12 deletions docs/en/observability/apm-ui/apm-app-users.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[apm-app-users]]
== APM app users and privileges
== APM UI users and privileges

:beat_default_index_prefix: apm
:annotation_index: observability-annotations
Expand Down Expand Up @@ -41,7 +41,7 @@ Select your use-case to get started:
<titleabbrev>Create an APM reader user</titleabbrev>
++++

APM reader users typically need to view the APM app and dashboards and visualizations that use APM data.
APM reader users typically need to view the APM UI and dashboards and visualizations that use APM data.
These users might also need to create and edit dashboards, visualizations, and machine learning jobs.

[[apm-app-reader-full]]
Expand Down Expand Up @@ -115,7 +115,7 @@ Here are two examples:
////

[[apm-app-annotation-user-create]]
=== APM app annotation user
=== APM UI annotation user

++++
<titleabbrev>Create an annotation user</titleabbrev>
Expand All @@ -128,7 +128,7 @@ You only need to create an annotation user to write to the annotations index
[[apm-app-annotation-user]]
==== Annotation user

View deployment annotations in the APM app.
View deployment annotations in the APM UI.

. Create a new role, named something like `annotation_user`,
and assign the following privileges:
Expand All @@ -150,7 +150,7 @@ and assign the following privileges:
{kibana-ref}/apm-settings-kb.html[`xpack.observability.annotations.index`].

. Assign the `annotation_user` created previously, and the roles and privileges necessary to create
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view annotations in the APM app
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view annotations in the APM UI

[[apm-app-annotation-api]]
==== Annotation API
Expand All @@ -162,7 +162,7 @@ See <<apm-app-api-user>>.
////

[[apm-app-central-config-user]]
=== APM app central config user
=== APM UI central config user

++++
<titleabbrev>Create a central config user</titleabbrev>
Expand Down Expand Up @@ -231,7 +231,7 @@ See <<apm-app-api-user>>.
////

[[apm-app-storage-explorer-user-create]]
=== APM app storage explorer user
=== APM UI storage explorer user

++++
<titleabbrev>Create a storage explorer user</titleabbrev>
Expand All @@ -240,7 +240,7 @@ See <<apm-app-api-user>>.
[[apm-app-storage-explorer-user]]
==== Storage Explorer user

View the **Storage Explorer** in the APM app.
View the **Storage Explorer** in the APM UI.

. Create a new role, named something like `storage-explorer_user`,
and assign the following privileges:
Expand All @@ -250,14 +250,14 @@ include::./tab-widgets/storage-explorer-user/widget.asciidoc[]
--

. Assign the `storage-explorer_user` created previously, and the roles and privileges necessary to create
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view **Storage Explorer** in the APM app.
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view **Storage Explorer** in the APM UI.

////
*********************************** ***********************************
////

[[apm-app-api-user]]
=== APM app API user
=== APM UI API user

++++
<titleabbrev>Create an API user</titleabbrev>
Expand All @@ -266,7 +266,7 @@ a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader
[[apm-app-api-config-manager]]
==== Central configuration API

Users can list, search, create, update, and delete central configurations via the APM app API.
Users can list, search, create, update, and delete central configurations via the APM UI API.

. Assign the following Kibana feature privileges:
+
Expand All @@ -282,7 +282,7 @@ Users can list, search, create, update, and delete central configurations via th
[[apm-app-api-config-reader]]
==== Central configuration API reader

Sometimes a user only needs to list and search central configurations via the APM app API.
Sometimes a user only needs to list and search central configurations via the APM UI API.

. Assign the following Kibana feature privileges:
+
Expand Down
12 changes: 6 additions & 6 deletions docs/en/observability/apm-ui/apm-spaces.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[apm-spaces]]
=== Control access to APM data

Starting in version 8.2.0, the APM app is {kibana-ref}/xpack-spaces.html[Kibana space] aware.
Starting in version 8.2.0, the APM UI is {kibana-ref}/xpack-spaces.html[Kibana space] aware.
This allows you to separate your data--and access to that data--by team, use case, service environment,
or any other filter that you choose.

Expand Down Expand Up @@ -32,7 +32,7 @@ If this field is empty, see <<environment-selector,service environment filter>>
[float]
==== Step 1: Create filtered aliases

The APM app uses index patterns to query your APM data. An index pattern can match data streams, indices, and/or aliases.
The APM UI uses index patterns to query your APM data. An index pattern can match data streams, indices, and/or aliases.
The default values are:

[options="header"]
Expand All @@ -46,7 +46,7 @@ The default values are:
NOTE: The default index settings also query the `apm-*` data view.
This data view matches APM data shipped in earlier versions of APM (prior to v8.0).

Instead of querying the default APM data views, we can create filtered aliases for the APM app to query.
Instead of querying the default APM data views, we can create filtered aliases for the APM UI to query.
A filtered alias is a secondary name for a group of data streams that has a user-defined
filter to limit the documents that the alias can access.

Expand Down Expand Up @@ -255,9 +255,9 @@ See {kibana-ref}/xpack-spaces.html[Kibana spaces] for more information on creati
[float]
==== Step 3: Update APM index settings in each space

Now we can change the default data views that the APM app queries in each space.
Now we can change the default data views that the APM UI queries in each space.

Open the APM app and navigate to **Settings** > **Indices**.
Open the APM UI and navigate to **Settings** > **Indices**.
Use the table below to update your settings for each space.
The values in each column match the names of the filtered aliases we created in step one.

Expand Down Expand Up @@ -408,4 +408,4 @@ POST /_security/user/staging-apm-user
[float]
==== Step 6: Marvel

That's it! Head back to the APM app and marvel at your space-specific data.
That's it! Head back to the APM UI and marvel at your space-specific data.
12 changes: 6 additions & 6 deletions docs/en/observability/apm-ui/correlations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ point you toward the root cause. You may find a correlation with a particular
piece of hardware, like a host or pod. Or, perhaps a set of users, based on IP
address or region, is facing increased latency due to local data center issues.

To find correlations, select a service on the *Services* page in the {apm-app}
To find correlations, select a service on the *Services* page in the APM UI
then select a transaction group from the *Transactions* tab.

NOTE: Queries within the {apm-app} are also applied to the correlations.
NOTE: Queries within the APM UI are also applied to the correlations.

[discrete]
[[correlations-latency]]
Expand Down Expand Up @@ -41,9 +41,9 @@ for other attributes, select their row in the table.

If a correlated attribute seems noteworthy, use the **Filter** quick links:

* `+` creates a new query in the {apm-app} for filtering transactions containing
* `+` creates a new query in the APM UI for filtering transactions containing
the selected value.
* `-` creates a new query in the {apm-app} to filter out transactions containing
* `-` creates a new query in the APM UI to filter out transactions containing
the selected value.

You can also click the icon beside the field name to view and filter its most
Expand All @@ -52,7 +52,7 @@ popular values.
In this example screenshot, there are transactions that are skewed to the right
with slower response times than the overall latency distribution. If you select
the `+` filter in the appropriate row of the table, it creates a new query in
the {apm-app} for transactions with this attribute. With the "noise" now
the APM UI for transactions with this attribute. With the "noise" now
filtered out, you can begin viewing sample traces to continue your investigation.

[discrete]
Expand Down Expand Up @@ -81,7 +81,7 @@ node and pod name that have medium impact on the failed transactions.
[role="screenshot"]
image::./images/correlations-failed-transactions.png[Failed transaction correlations]

Select the `+` filter to create a new query in the {apm-app} for transactions
Select the `+` filter to create a new query in the APM UI for transactions
with one or more of these attributes. If you are unfamiliar with a field, click
the icon beside its name to view its most popular values and optionally filter
on those values too. Each time that you add another attribute, it is filtering
Expand Down
Loading

0 comments on commit 80425b5

Please sign in to comment.