Skip to content

Commit

Permalink
[apm] Update APM section information architecture (#4230) (#4353)
Browse files Browse the repository at this point in the history
* move source files

* update get started section

* update data model section

* create collect application data section

* create view and analyze data section

* create act on data section

* update manage storage section

* update configure section

* create use apm securely section

* update advanced setup section

* update monitor apm server section

* update troubleshooting section

* update api section

* clean up

* update index files

* fix apm guide redirects

* fix more apm guide redirects

* fix more apm guide redirects

* adjust some headings

* address feedback on data types section

* address feedback on collect data section

* address feedback on configure section

* address feedback on get started section

* address feedback on act on data section

* fix apm guide redirect

* fix diagrams

* clean up some to dos

* clean up

* address feedback from @lahsivjar

(cherry picked from commit 265db9a)

Co-authored-by: Colleen McGinnis <[email protected]>
  • Loading branch information
mergify[bot] and colleenmcginnis authored Oct 7, 2024
1 parent eff95f8 commit 7f6d0b0
Show file tree
Hide file tree
Showing 234 changed files with 3,106 additions and 2,859 deletions.
88 changes: 44 additions & 44 deletions docs/en/apm-server/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The error endpoint has been deprecated. Please see {observability-guide}/apm-api
[role="exclude",id="error-schema-definition"]
=== Error schema definition

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="error-api-examples"]
=== Error API examples
Expand All @@ -45,42 +45,42 @@ The error API examples have moved. Please see {observability-guide}/apm-api-even
[role="exclude",id="error-payload-schema"]
=== Error payload schema

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="error-service-schema"]
=== Error service schema

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="error-system-schema"]
=== Error system schema

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="error-context-schema"]
=== Error context schema

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="error-stacktraceframe-schema"]
=== Error stack trace frame schema

The error schema has moved. Please see {observability-guide}/apm-api-error.html[Error Schema].
The error schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="payload-with-error"]
=== Payload with error

This is no longer helpful. Please see {observability-guide}/apm-api-error.html[Error Schema].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="payload-with-minimal-exception"]
=== Payload with minimal exception

This is no longer helpful. Please see {observability-guide}/apm-api-error.html[Error Schema].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

[role="exclude",id="payload-with-minimal-log"]
=== Payload with minimal log

This is no longer helpful. Please see {observability-guide}/apm-api-error.html[Error Schema].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-error[Error Schema].

// Transaction API

Expand All @@ -92,7 +92,7 @@ The transaction endpoint has been deprecated. Please see {observability-guide}/a
[role="exclude",id="transaction-schema-definition"]
=== Transaction schema definition

The transaction schema has moved. Please see {observability-guide}/apm-api-transaction.html#apm-api-transaction-schema[Transaction Schema].
The transaction schema has moved. Please see {observability-guide}/apm-api-events.html#apm-api-transaction-schema[Transaction Schema].

[role="exclude",id="transaction-api-examples"]
=== Transaction API examples
Expand All @@ -102,62 +102,62 @@ The transaction API examples have moved. Please see {observability-guide}/apm-ap
[role="exclude",id="transaction-span-schema"]
=== Transaction span schema

This schema has changed. Please see {observability-guide}/apm-api-span.html[Spans].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-span[Spans].

[role="exclude",id="transaction-payload-schema"]
=== Transaction payload schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-service-schema"]
=== Transaction service schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-system-schema"]
=== Transaction system schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-context-schema"]
=== Transaction context schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-stacktraceframe-schema"]
=== Transaction stack trace frame schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-request-schema"]
=== Transaction request schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="transaction-user-schema"]
=== Transaction user schema

This schema has changed. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This schema has changed. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="payload-with-transactions"]
=== Payload with transactions

This is no longer helpful. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="payload-with-minimal-transaction"]
=== Payload with minimal transaction

This is no longer helpful. Please see {observability-guide}/apm-api-transaction.html[Transactions].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="payload-with-minimal-span"]
=== Payload with minimal span

This is no longer helpful. Please see {observability-guide}/apm-api-span.html[Spans].
This is no longer helpful. Please see {observability-guide}/apm-api-events.html#apm-api-span[Spans].

[role="exclude",id="example-intakev2-events"]
=== Example Request Body

Refer to {observability-guide}/apm-api-event-example.html[Example request body].
Refer to {observability-guide}/apm-api-events.html#apm-api-event-example[Example request body].

// V1 intake API

Expand Down Expand Up @@ -442,49 +442,49 @@ Refer to {observability-guide}/apm-getting-started-apm-server.html[Self manage A

{move-notice}

Refer to {observability-guide}/_apm_server_binary.html[APM Server binary].
Refer to {observability-guide}/get-started-with-apm-server-binary.html[APM Server binary].

[role="exclude",id="installing"]
=== Step 1: Install

{move-notice}

Refer to {observability-guide}/apm-installing.html[Step 1: Install].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-installing[Step 1: Install].

[role="exclude",id="apm-server-configuration"]
=== Step 2: Set up and configure

{move-notice}

Refer to {observability-guide}/apm-server-configuration.html[Step 2: Set up and configure].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-server-configuration[Step 2: Set up and configure].

[role="exclude",id="apm-server-starting"]
=== Step 3: Start

{move-notice}

Refer to {observability-guide}/apm-server-starting.html[Step 3: Start].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-server-starting[Step 3: Start].

[role="exclude",id="next-steps"]
=== Step 4: Next steps

{move-notice}

Refer to {observability-guide}/apm-next-steps.html[Step 4: Next steps].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-next-steps[Step 4: Next steps].

[role="exclude",id="setup-repositories"]
=== Repositories for APT and YUM

{move-notice}

Refer to {observability-guide}/apm-setup-repositories.html[Repositories for APT and YUM].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-setup-repositories[Repositories for APT and YUM].

[role="exclude",id="running-on-docker"]
=== Run APM Server on Docker

{move-notice}

Refer to {observability-guide}/apm-running-on-docker.html[Run APM Server on Docker].
Refer to {observability-guide}/get-started-with-apm-server-binary.html#apm-running-on-docker[Run APM Server on Docker].

[role="exclude",id="_fleet_managed_apm_server"]
=== Fleet-managed APM Server
Expand All @@ -498,28 +498,28 @@ Refer to {observability-guide}/get-started-with-fleet-apm-server.html[Fleet-mana

{move-notice}

Refer to {observability-guide}/_step_1_set_up_fleet.html[Step 1: Set up Fleet].
Refer to {observability-guide}/get-started-with-fleet-apm-server.html#_step_1_set_up_fleet[Step 1: Set up Fleet].

[role="exclude",id="_step_2_add_and_configure_the_apm_integration"]
=== Step 2: Add and configure the APM integration

{move-notice}

Refer to {observability-guide}/add-apm-integration.html[Step 2: Add and configure the APM integration].
Refer to {observability-guide}/get-started-with-fleet-apm-server.html#add-apm-integration[Step 2: Add and configure the APM integration].

[role="exclude",id="_step_3_install_apm_agents"]
=== Step 3: Install APM agents

{move-notice}

Refer to {observability-guide}/_step_3_install_apm_agents.html[Step 3: Install APM agents].
Refer to {observability-guide}/get-started-with-fleet-apm-server.html#_step_3_install_apm_agents[Step 3: Install APM agents].

[role="exclude",id="_step_4_view_your_data"]
=== Step 4: View your data

{move-notice}

Refer to {observability-guide}/_step_4_view_your_data.html[Step 4: View your data].
Refer to {observability-guide}/get-started-with-fleet-apm-server.html#_step_4_view_your_data[Step 4: View your data].

[role="exclude",id="data-model"]
=== Data Model
Expand Down Expand Up @@ -621,7 +621,7 @@ Refer to {observability-guide}/apm-data-security-delete.html[Delete sensitive da

{move-notice}

Refer to {observability-guide}/apm-distributed-tracing.html[Distributed tracing].
Refer to {observability-guide}/apm-data-model-traces.html#apm-distributed-tracing[Distributed tracing].

[role="exclude",id="apm-rum"]
=== Real User Monitoring (RUM)
Expand All @@ -642,14 +642,14 @@ Refer to {observability-guide}/apm-sampling.html[Transaction sampling].

{move-notice}

Refer to {observability-guide}/apm-configure-head-based-sampling.html[Configure head-based sampling].
Refer to {observability-guide}/apm-sampling.html#apm-configure-head-based-sampling[Configure head-based sampling].

[role="exclude",id="configure-tail-based-sampling"]
=== Configure tail-based sampling

{move-notice}

Refer to {observability-guide}/apm-configure-tail-based-sampling.html[Configure tail-based sampling].
Refer to {observability-guide}/apm-sampling.html#apm-configure-tail-based-sampling[Configure tail-based sampling].

[role="exclude",id="log-correlation"]
=== Logging integration
Expand Down Expand Up @@ -1191,7 +1191,7 @@ Refer to {observability-guide}/apm-monitoring-local-collection.html[Use local co

{move-notice}

Refer to {observability-guide}/apm-select-metrics.html[The select metrics].
Refer to {observability-guide}/apm-monitoring-local-collection.html#apm-select-metrics[The select metrics].

[role="exclude",id="monitoring-metricbeat-collection"]
=== Use Metricbeat collection
Expand Down Expand Up @@ -1226,45 +1226,45 @@ Refer to {observability-guide}/apm-api-events.html[Elastic APM events intake API

{move-notice}

Refer to {observability-guide}/apm-api-metadata.html[Metadata].
Refer to {observability-guide}/apm-api-events.html#apm-api-metadata[Metadata].

[discrete]
[[api-metadata-schema]]
==== Metadata scheme

Refer to {observability-guide}/apm-api-metadata.html#apm-api-metadata-schema[Metadata scheme].
Refer to {observability-guide}/apm-api-events.html#apm-api-metadata-schema[Metadata scheme].

[role="exclude",id="api-transaction"]
=== Transactions

{move-notice}

Refer to {observability-guide}/apm-api-transaction.html[Transactions].
Refer to {observability-guide}/apm-api-events.html#apm-api-transaction[Transactions].

[role="exclude",id="api-span"]
=== Spans

{move-notice}

Refer to {observability-guide}/apm-api-span.html[Spans].
Refer to {observability-guide}/apm-api-events.html#apm-api-span[Spans].

[role="exclude",id="api-error"]
=== Errors

{move-notice}

Refer to {observability-guide}/apm-api-error.html[Errors].
Refer to {observability-guide}/apm-api-events.html#apm-api-error[Errors].

[role="exclude",id="api-metricset"]
=== Metrics
Refer to {observability-guide}/apm-api-metricset.html[Metrics]
Refer to {observability-guide}/apm-api-events.html#apm-api-metricset[Metrics]

[role="exclude",id="api-event-example"]
=== Example request body

{move-notice}

Refer to {observability-guide}/apm-api-event-example.html[Example request body].
Refer to {observability-guide}/apm-api-events.html#apm-api-event-example[Example request body].

[role="exclude",id="api-config"]
=== Elastic APM agent configuration API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
[[apm-alerts]]
=== Alerts and rules

++++
<titleabbrev>Create an alert</titleabbrev>
++++
= APM alerts and rules

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.
Expand All @@ -28,7 +24,7 @@ see Kibana's {kibana-ref}/create-and-manage-rules.html[Create and manage rules].

[float]
[[apm-create-transaction-alert]]
=== Example: create a latency anomaly rule
== Example: create a latency anomaly rule

Latency anomaly rules trigger when the latency of a service is abnormal.
Because some parts of an application are more important than others, and have a different
Expand Down Expand Up @@ -71,7 +67,7 @@ Click **Save**. Your rule has been created and is now active!

[float]
[[apm-create-error-alert]]
=== Example: create an error count threshold alert
== Example: create an error count threshold alert

The error count threshold alert triggers when the number of errors in a service exceeds a defined threshold.
Because some errors are more important than others, this guide will focus a specific error group ID.
Expand Down Expand Up @@ -131,13 +127,13 @@ Click **Save**. The alert has been created and is now active!

[float]
[[apm-alert-view-active]]
=== View active alerts
== View active alerts

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

[float]
[[apm-alert-view-group]]
==== View alerts by service group
=== View alerts by service group

If you're using the <<service-groups,service groups>> feature, you can view alerts by service group.
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.
Expand All @@ -147,7 +143,7 @@ image::./images/apm-service-group.png[Example view of service group in the APM U

[float]
[[apm-alert-view-service]]
==== View alerts by service
=== View alerts by service

Alerts can be viewed within the context of any service.
After selecting a service, go to the **Alerts** tab to view any alerts that are active for the selected service.
Expand All @@ -157,15 +153,15 @@ image::./images/active-alert-service.png[View active alerts by service]

[float]
[[apm-alert-manage]]
=== Manage alerts and rules
== Manage alerts and rules

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.

[float]
[[apm-alert-more-info]]
=== More information
== More information

See {kibana-ref}/alerting-getting-started.html[Alerting] for more information.

Expand Down
Loading

0 comments on commit 7f6d0b0

Please sign in to comment.