Skip to content

Commit

Permalink
[apm] Apply APM IA changes to serverless docs (#4593)
Browse files Browse the repository at this point in the history
* apply apm ia changes to serverless docs

* apply suggestions from code review

Co-authored-by: DeDe Morton <[email protected]>

* remove commented out content

* update link

---------

Co-authored-by: DeDe Morton <[email protected]>
  • Loading branch information
colleenmcginnis and dedemorton authored Dec 9, 2024
1 parent 6b14b0c commit 21943eb
Show file tree
Hide file tree
Showing 69 changed files with 477 additions and 301 deletions.
42 changes: 42 additions & 0 deletions docs/en/serverless/apm/act-on-data/alerts.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[[observability-apm-alerts]]
= Create APM rules and alerts

++++
<titleabbrev>Create rules and alerts</titleabbrev>
++++

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.

[discrete]
== APM rules

The following APM rules are supported:

[cols="1,1"]
|===
| *APM Anomaly*
a| Alert when either the latency, throughput, or failed transaction rate of a service is anomalous.
Anomaly rules can be set at the environment level, service level, and/or transaction type level.

Read more in <<observability-create-anomaly-alert-rule,APM Anomaly rule →>>

| *Error count threshold*
a| 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.

Read more in <<observability-create-error-count-threshold-alert-rule,Error count threshold rule →>>

| *Failed transaction rate threshold*
a| Alert when the rate of transaction errors in a service exceeds a defined threshold.

Read more in <<observability-create-failed-transaction-rate-threshold-alert-rule,Failed transaction rate threshold rule →>>

| *Latency threshold*
a| Alert when the latency or failed transaction rate is abnormal.
Threshold rules can be as broad or as granular as you'd like, enabling you to define exactly when you want to be alerted--whether that's at the environment level, service name level, transaction type level, and/or transaction name level.

Read more in <<observability-create-latency-threshold-alert-rule,Latency threshold rule →>>

|===

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

:role: Editor
:goal: create and manage custom links
include::../partials/roles.asciidoc[]
include::../../partials/roles.asciidoc[]
:role!:

:goal!:
Expand Down
28 changes: 28 additions & 0 deletions docs/en/serverless/apm/act-on-data/index.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[[observability-apm-act-on-data]]
= Act on application data

++++
<titleabbrev>Act on data</titleabbrev>
++++

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

[cols="1,1"]
|===
| <<observability-apm-alerts,Rules and alerts>>
| 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.

| <<observability-apm-create-custom-links,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 Applications UI (for example, by transaction details).
|===


/////////////////
// Subsections //
/////////////////
include::./alerts.asciidoc[leveloffset=+1]
include::./custom-links.asciidoc[leveloffset=+1]
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,52 +8,52 @@
This API is exclusively for APM agent developers. The vast majority of users should have no reason to interact with this API.
====

include::./apm-server-api/api.asciidoc[]
include::./api.asciidoc[]

[discrete]
[[observability-apm-server-api-server-information-api]]
== Server information API

include::./apm-server-api/api-info.asciidoc[]
include::./api-info.asciidoc[]

[discrete]
[[observability-apm-server-api-events-intake-api]]
== Events intake API

include::./apm-server-api/api-events.asciidoc[]
include::./api-events.asciidoc[]

[discrete]
[[observability-apm-server-api-metadata]]
=== Metadata

include::./apm-server-api/api-metadata.asciidoc[]
include::./api-metadata.asciidoc[]

[discrete]
[[observability-apm-server-api-transactions]]
=== Transactions

include::./apm-server-api/api-transaction.asciidoc[]
include::./api-transaction.asciidoc[]

[discrete]
[[observability-apm-server-api-spans]]
=== Spans

include::./apm-server-api/api-span.asciidoc[]
include::./api-span.asciidoc[]

[discrete]
[[observability-apm-server-api-errors]]
=== Errors

include::./apm-server-api/api-error.asciidoc[]
include::./api-error.asciidoc[]

[discrete]
[[observability-apm-server-api-metrics]]
=== Metrics

include::./apm-server-api/api-metricset.asciidoc[]
include::./api-metricset.asciidoc[]

[discrete]
[[observability-apm-server-api-opentelemetry-api]]
== OpenTelemetry API

include::./apm-server-api/otel-api.asciidoc[]
include::./otel-api.asciidoc[]
18 changes: 0 additions & 18 deletions docs/en/serverless/apm/apm-data-types.asciidoc

This file was deleted.

17 changes: 0 additions & 17 deletions docs/en/serverless/apm/apm-reduce-your-data-usage.asciidoc

This file was deleted.

13 changes: 0 additions & 13 deletions docs/en/serverless/apm/apm-reference.asciidoc

This file was deleted.

11 changes: 0 additions & 11 deletions docs/en/serverless/apm/apm-stacktrace-collection.asciidoc

This file was deleted.

50 changes: 0 additions & 50 deletions docs/en/serverless/apm/apm-troubleshooting.asciidoc

This file was deleted.

This file was deleted.

This file was deleted.

23 changes: 0 additions & 23 deletions docs/en/serverless/apm/apm-view-and-analyze-traces.asciidoc

This file was deleted.

13 changes: 13 additions & 0 deletions docs/en/serverless/apm/apm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,16 @@ like JVM metrics in the Java Agent, and Go runtime metrics in the Go Agent.
== Give Elastic APM a try

Ready to give Elastic APM a try? See <<observability-apm-get-started,Get started with traces and APM>>.

/////////////////
// Subsections //
/////////////////
include::./getting-started-apm/index.asciidoc[leveloffset=+1]
include::./data-model/index.asciidoc[leveloffset=+1]
include::./collect-application-data/index.asciidoc[leveloffset=+1]
include::./view-and-analyze/index.asciidoc[leveloffset=+1]
include::./act-on-data/index.asciidoc[leveloffset=+1]
include::./security/index.asciidoc[leveloffset=+1]
include::./manage-storage/index.asciidoc[leveloffset=+1]
include::./api/index.asciidoc[leveloffset=+1]
include::./troubleshooting/index.asciidoc[leveloffset=+1]
Loading

0 comments on commit 21943eb

Please sign in to comment.