Skip to content

Commit

Permalink
Change "APM" to "Applications" when referencing the UI (#4373) (#4404)
Browse files Browse the repository at this point in the history
* update text

* update images

(cherry picked from commit b8b3674)

Co-authored-by: Colleen McGinnis <[email protected]>
  • Loading branch information
mergify[bot] and colleenmcginnis authored Oct 18, 2024
1 parent e941d24 commit 2aa0f20
Show file tree
Hide file tree
Showing 69 changed files with 214 additions and 214 deletions.
14 changes: 7 additions & 7 deletions docs/en/observability/apm-alerts.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[apm-alerts]]
= APM alerts and rules

The APM UI allows you to define **rules** to detect complex conditions within your APM data
The Applications 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 @@ -15,7 +15,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 UI]
image::./images/apm-alert.png[Create an alert in the Applications UI]

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

Expand All @@ -40,7 +40,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 UI, select **Alerts and rules** > **Create anomaly rule**.
From any page in the Applications 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 @@ -85,7 +85,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 UI, select **Alerts and rules** > **Create error count rule**.
From any page in the Applications 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 @@ -129,7 +129,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 UI.
Active alerts are displayed and grouped in multiple ways in the Applications UI.

[float]
[[apm-alert-view-group]]
Expand All @@ -139,7 +139,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 UI in Kibana]
image::./images/apm-service-group.png[Example view of service group in the Applications UI in Kibana]

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

From the APM UI, select **Alerts and rules** > **Manage rules** to be taken to
From the Applications 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
2 changes: 1 addition & 1 deletion docs/en/observability/apm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ database queries, calls to caches, external HTTP requests, and more.
This makes it easy to pinpoint and fix performance problems quickly.

[role="screenshot"]
image::images/apm-app-landing.png[APM UI in {kib}]
image::images/apm-app-landing.png[Applications UI in {kib}]

Elastic APM also automatically collects unhandled errors and exceptions.
Errors are grouped based primarily on the stack trace,
Expand Down
8 changes: 4 additions & 4 deletions docs/en/observability/apm/act-on-data/custom-links.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[[apm-custom-links]]
= Custom links in the APM UI
= Custom links in the Applications UI

++++
<titleabbrev>Create custom links</titleabbrev>
++++

Elastic's custom link feature allows you to easily create up to 500 dynamic links
based on your specific APM data.
Custom links can be filtered to only appear in the APM UI for relevant services,
Custom links can be filtered to only appear in the Applications UI for relevant services,
environments, transaction types, or transaction names.

Ready to dive in? Jump straight to the <<custom-links-examples,examples>>.
Expand All @@ -21,7 +21,7 @@ The easiest way to create a custom link is from within the actions dropdown in t
This method will automatically apply filters, scoping the link to that specific service,
environment, transaction type, and transaction name.

Alternatively, you can create a custom link in the APM UI by navigating to **Settings** > **Customize UI**,
Alternatively, you can create a custom link in the Applications UI by navigating to **Settings** > **Customize UI**,
and selecting **Create custom link**.

[float]
Expand All @@ -43,7 +43,7 @@ These variables will be replaced with transaction metadata when the link is clic

Because everyone's data is different,
you'll need to examine your traces to see what metadata is available for use.
To do this, select a trace in the APM UI, and click **Metadata** in the **Trace Sample** table.
To do this, select a trace in the Applications UI, and click **Metadata** in the **Trace Sample** table.

[role="screenshot"]
image::./images/example-metadata.png[Example metadata]
Expand Down
6 changes: 3 additions & 3 deletions docs/en/observability/apm/act-on-data/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
<titleabbrev>Act on data</titleabbrev>
++++

In addition to exploring visualizations in the APM UI in {kib}, you can make your application data
In addition to exploring visualizations in the Applications UI in {kib}, you can make your application data
more actionable with:

* *Alerts and rules*: The APM UI allows you to define rules to detect complex
* *Alerts and rules*: The Applications UI allows you to define rules to detect complex
conditions within your APM data and trigger built-in actions when those conditions are met.
Read more about alerts and rules in the <<apm-alerts,Incident management section>>.
* *Custom links*: Build URLs that contain relevant metadata from a specific trace.
For example, you can create a link that will take you to a page where you can open a new GitHub issue
with context already auto-populated in the issue body.
These links will be shown in the _Actions_ context menu in selected areas of the APM UI (for example, by transaction details).
These links will be shown in the _Actions_ context menu in selected areas of the Applications UI (for example, by transaction details).
Read more in <<apm-custom-links,Custom links>>.

:leveloffset: +1
Expand Down
8 changes: 4 additions & 4 deletions docs/en/observability/apm/api/api-ui.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[apm-app-api]]
= APM UI API

Some APM UI features are provided via a REST API:
Some Applications UI features are provided via a REST API:

* <<apm-agent-config-api>>
* <<apm-annotation-api>>
Expand Down 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 UI:
Here's an example CURL request that adds an annotation to the Applications UI:

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

The Annotation API allows you to annotate visualizations in the APM UI with significant events, like deployments,
The Annotation API allows you to annotate visualizations in the Applications 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 @@ -425,7 +425,7 @@ include::api-ui.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 UI to distinguish APM annotations from other annotations.
(optional, array) Tags are used by the Applications 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
2 changes: 1 addition & 1 deletion docs/en/observability/apm/api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two kinds of APIs related to Elastic APM:
[cols="1,1"]
|===
| <<apm-app-api>>
| {kib} APIs specific to working with the APM UI including updating configuration options,
| {kib} APIs specific to working with the Applications UI including updating configuration options,
uploading real user monitoring (RUM) source maps, adding annotations, and more.
| <<apm-api>>
| APIs for working with APM Server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
<titleabbrev>Centrally configure APM agents in Kibana</titleabbrev>
++++

APM Agent configuration allows you to fine-tune your APM agent configuration from within the APM UI.
APM Agent configuration allows you to fine-tune your APM agent configuration from within the Applications 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 UI will let you know when your APM agents have applied your configurations.
The Applications 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 UI take precedence over configurations set locally in each APM agent.
Configurations set from the Applications 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 UI,
After selecting a Service name and environment in the Applications UI,
a list of all supported configuration options,
including descriptions and default values, will be displayed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ documentation to learn how to install the agent, configure it, and more:
== More APM agent resources

Though you should refer to each APM agent's documentation for information on using the agent,
there are some tasks you can complete in the APM UI:
there are some tasks you can complete in the Applications UI:

* <<apm-agent-configuration>>
* <<apm-source-map-how-to,Upload a RUM source map>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ and not something you only do when you see unhelpful errors.
That's because uploading source maps after errors happen won't make old errors magically readable —
errors must occur again for source mapping to occur.

Here's an example of an exception stack trace in the APM UI when using minified code.
Here's an example of an exception stack trace in the Applications UI when using minified code.
As you can see, it's not very helpful.

[role="screenshot"]
image::images/source-map-before.png[APM UI without source mapping]
image::images/source-map-before.png[Applications UI without source mapping]

With a source map, minified files are mapped back to the original source code,
allowing you to maintain the speed advantage of minified code,
without losing the ability to quickly and easily debug your application.
Here's the same example as before, but with a source map uploaded and applied:

[role="screenshot"]
image::images/source-map-after.png[APM UI with source mapping]
image::images/source-map-after.png[Applications UI with source mapping]

Follow the steps below to enable source mapping your error stack traces in the APM UI:
Follow the steps below to enable source mapping your error stack traces in the Applications UI:

* <<apm-source-map-rum-initialize>>
* <<apm-source-map-rum-generate>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ See <<apm-agent-configuration,Central configuration>> to learn more.
[[apm-configure-sampling-local-jaeger]]
==== Local sampling in each Jaeger client

If you don't have access to the APM UI,
If you don't have access to the Applications UI,
you'll need to change the Jaeger client's `sampler.type` and `sampler.param`.
This enables you to set the sampling configuration locally in each Jaeger client.
See the official https://www.jaegertracing.io/docs/1.27/sampling/[Jaeger sampling documentation]
Expand All @@ -87,7 +87,7 @@ for more information.
[[apm-configure-start-jaeger]]
=== Start sending data

That's it! Data sent from Jaeger clients to the APM Server can now be viewed in the APM UI.
That's it! Data sent from Jaeger clients to the APM Server can now be viewed in the Applications UI.

[float]
[[apm-caveats-jaeger]]
Expand All @@ -106,7 +106,7 @@ it is not possible to mix and match the use of Elastic's APM agents and Jaeger's
* Jaeger clients only sends trace data.
APM agents support a larger number of features, like
multiple types of metrics, and application breakdown charts.
When using Jaeger, features like this will not be available in the APM UI.
When using Jaeger, features like this will not be available in the Applications UI.
* Elastic APM's <<apm-data-model>> is different than Jaegers.
For Jaeger trace data to work with Elastic's data model, we rely on spans being tagged with the appropriate
https://github.com/opentracing/specification/blob/master/semantic_conventions.md[`span.kind`].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[[apm-open-telemetry-traces-limitations]]
== OpenTelemetry traces

* Traces of applications using `messaging` semantics might be wrongly displayed as `transactions` in the APM UI, while they should be considered `spans` (see issue https://github.com/elastic/apm-server/issues/7001[#7001]).
* Traces of applications using `messaging` semantics might be wrongly displayed as `transactions` in the Applications UI, while they should be considered `spans` (see issue https://github.com/elastic/apm-server/issues/7001[#7001]).
* Inability to see Stack traces in spans.
* Inability in APM views to view the "Time Spent by Span Type" (see issue https://github.com/elastic/apm-server/issues/5747[#5747]).

Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/apm/configure/agent-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ image:./binary-yes-fm-yes.svg[supported deployment methods]
APM agent configuration is supported by all APM Server deployment methods.
****

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

To learn more about this feature, see <<apm-agent-configuration,APM agent configuration>>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Defaults to `false`.
=== `environment`

Set the environment in which APM Server is running, for example, `staging`, `production`, `dev`, etc.
Environments can be filtered in the <<apm-ui,{kib} APM UI>>.
Environments can be filtered in the <<apm-ui,{kib} Applications UI>>.

[float]
=== `hosts`
Expand Down
12 changes: 6 additions & 6 deletions docs/en/observability/apm/data-model/data-model-metrics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
**Metrics** measure the state of a system by gathering information on a regular interval. There are two types of APM metrics:

* **System metrics**: Basic infrastructure and application metrics.
* **Calculated metrics**: Aggregated trace event metrics used to power visualizations in the APM UI.
* **Calculated metrics**: Aggregated trace event metrics used to power visualizations in the Applications UI.

[float]
== System metrics
Expand Down Expand Up @@ -54,7 +54,7 @@ include::{apm-server-root}/docs/data/elasticsearch/metricset.json[]
[float]
== Calculated metrics

APM agents and APM Server calculate metrics from trace events to power visualizations in the APM UI.
APM agents and APM Server calculate metrics from trace events to power visualizations in the Applications UI.

Calculated metrics are an implementation detail and while we aim for stability for these data models,
the dimensions and concrete limits for aggregations are subject to change within minor version updates.
Expand Down Expand Up @@ -104,7 +104,7 @@ include::{apm-server-root}/docs/data/elasticsearch/span_breakdown.json[]
[float]
=== Transaction metrics

To power <<apm-ui,{kib} APM UI>> visualizations,
To power <<apm-ui,{kib} Applications UI>> visualizations,
APM Server aggregates transaction events into latency distribution metrics.

*`transaction.duration.summary`* and *`transaction.duration.histogram`*::
Expand Down Expand Up @@ -175,7 +175,7 @@ include::{apm-server-root}/docs/data/elasticsearch/transaction_metric.json[]
[float]
=== Service-transaction metrics

To power <<apm-ui,{kib} APM UI>> visualizations,
To power <<apm-ui,{kib} Applications UI>> visualizations,
APM Server aggregates transaction events into service-transaction metrics.
Service-transaction metrics are similar to transaction metrics, but they usually
have a much lower cardinality as they have significantly fewer dimensions.
Expand Down Expand Up @@ -221,7 +221,7 @@ include::{apm-server-root}/docs/data/elasticsearch/service_transaction_metric.js
[float]
=== Service-destination metrics

To power <<apm-ui,{kib} APM UI>> visualizations,
To power <<apm-ui,{kib} Applications UI>> visualizations,
APM Server aggregates span events into service-destination metrics.

*`span.destination.service.response_time.count`* and *`span.destination.service.response_time.sum.us`*::
Expand Down Expand Up @@ -269,7 +269,7 @@ include::{apm-server-root}/docs/data/elasticsearch/service_destination_metric.js
[float]
=== Service-summary metrics

To power <<apm-ui,{kib} APM UI>> visualizations,
To power <<apm-ui,{kib} Applications UI>> visualizations,
APM Server aggregates transaction, error, log, and metric events into service-summary metrics.

These metric documents can be identified by searching for `metricset.name: service_summary`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ and non-keyword fields, like `span.start.us`, to 10,000 characters.
For performance reasons, APM agents can choose to sample or omit spans purposefully.
This can be useful in preventing edge cases, like long-running transactions with over 100 spans,
that would otherwise overload both the Agent and the APM Server.
When this occurs, the APM UI will display the number of spans dropped.
When this occurs, the Applications UI will display the number of spans dropped.

To configure the number of spans recorded per transaction, see the relevant Agent documentation:

Expand All @@ -52,7 +52,7 @@ Agents stream spans to the APM Server separately from their transactions.
Because of this, unforeseen errors may cause spans to go missing.
Agents know how many spans a transaction should have;
if the number of expected spans does not equal the number of spans received by the APM Server,
the APM UI will calculate the difference and display a message.
the Applications UI will calculate the difference and display a message.

[float]
== Data streams
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@ For backward-compatibility purposes, new versions of Elastic agents still suppor
[[apm-visualize-distributed-tracing]]
=== Visualize distributed tracing

The APM UI's timeline visualization provides a visual deep-dive into each of your application's traces:
The Applications UI's timeline visualization provides a visual deep-dive into each of your application's traces:

[role="screenshot"]
image::./images/apm-distributed-tracing.png[Distributed tracing in the APM UI]
image::./images/apm-distributed-tracing.png[Distributed tracing in the Applications UI]

[float]
[[apm-manual-distributed-tracing]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ which are points in time relative to the start of the transaction with some labe
In addition, agents provide options for users to capture custom <<apm-data-model-metadata, metadata>>.
Metadata can be indexed - <<apm-data-model-labels,`labels`>>, or not-indexed - <<apm-data-model-custom,`custom`>>.

Transactions are grouped by their `type` and `name` in the APM UI's
Transactions are grouped by their `type` and `name` in the Applications UI's
<<apm-transactions,Transaction overview>>.
If you're using a supported framework, APM agents will automatically handle the naming for you.
If you're not, or if you wish to override the default,
Expand Down
Loading

0 comments on commit 2aa0f20

Please sign in to comment.