Skip to content
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a9ee976
apm fun
bmorelli25 Mar 30, 2023
0677582
feedback
bmorelli25 Apr 6, 2023
4668dcc
delete old images; fix doc build
bmorelli25 Apr 6, 2023
b92dd15
add Elastic Cloud quick start
bmorelli25 Apr 6, 2023
c2e6d0a
Update fleet-managed instructions
bmorelli25 Apr 6, 2023
de40873
feedback
bmorelli25 May 2, 2023
bf8853f
Merge branch 'main' into ft-new-apm-start
bmorelli25 May 4, 2023
90a4427
Update docs/_quickstart.asciidoc
bmorelli25 May 2, 2023
d22bd03
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 May 10, 2023
a9c2547
remove keystore
bmorelli25 May 11, 2023
db9f7cb
update quick start and get started
bmorelli25 May 11, 2023
58242ab
add advanced setup
bmorelli25 May 11, 2023
ba4fb4d
delete temp files for QS and GS
bmorelli25 May 11, 2023
e22f80f
fix doc build
bmorelli25 May 11, 2023
d7c1560
Revert "add advanced setup"
bmorelli25 May 11, 2023
069449b
Revert "remove keystore"
bmorelli25 May 11, 2023
86cf862
fix decision tree
bmorelli25 May 17, 2023
c944953
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 May 17, 2023
9df088d
fix
bmorelli25 May 17, 2023
865eb2c
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 May 21, 2023
c7a4313
remove accidental commits
bmorelli25 May 22, 2023
42921b2
add fleet self-managed instructions
bmorelli25 May 22, 2023
b1d286e
update fleet-managed diagram
bmorelli25 May 22, 2023
4df41cc
clean up index file
bmorelli25 May 22, 2023
96911aa
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 May 22, 2023
320942a
Update docs/legacy/getting-started-apm-server.asciidoc
bmorelli25 May 22, 2023
93b3933
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 May 22, 2023
9f32f9c
feedback from @simitt
bmorelli25 May 22, 2023
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
2 changes: 1 addition & 1 deletion changelogs/7.15.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ https://github.com/elastic/apm-server/compare/v7.14.2\...v7.15.0[View commits]
- `network.connection_type` is now `network.connection.type` {pull}5671[5671]
- `transaction.page` and `error.page` no longer recorded {pull}5872[5872]
- experimental:["This breaking change applies to the experimental tail-based sampling feature."] `apm-server.sampling.tail` now requires `apm-server.data_streams.enabled` {pull}5952[5952]
- beta:["This breaking change applies to the beta <<apm-integration>>."] The `traces-sampled-*` data stream is now `traces-apm.sampled-*` {pull}5952[5952]
- beta:["This breaking change applies to the beta APM integration."] The `traces-sampled-*` data stream is now `traces-apm.sampled-*` {pull}5952[5952]

[float]
==== Bug fixes
Expand Down
2 changes: 1 addition & 1 deletion changelogs/8.0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ No significant changes.
==== Breaking Changes
* APM Server now responds with 403 (HTTP) and PermissionDenied (gRPC) for authenticated but unauthorized requests {pull}5545[5545]
* `sourcemap.error` and `sourcemap.updated` are no longer set due to failing to find a matching source map {pull}5631[5631]
* experimental:["This breaking change applies to the experimental <<apm-integration>>."] Removed `service.name` from dataset {pull}5451[5451]
* experimental:["This breaking change applies to the experimental APM integration."] Removed `service.name` from dataset {pull}5451[5451]

// [float]
// ==== Bug fixes
Expand Down
91 changes: 50 additions & 41 deletions docs/apm-components.asciidoc
Original file line number Diff line number Diff line change
@@ -1,34 +1,16 @@
[[apm-components]]
== Components and documentation
== APM components

****
There are two ways to install, run, and manage Elastic APM:

* With the Elastic APM integration
* With the standalone (legacy) APM Server binary

This documentation focuses on option one: the **Elastic APM integration**.
****

Elastic APM consists of four components: *APM agents*, the *Elastic APM integration*, *{es}*, and *{kib}*.
Generally, there are two ways that these four components can work together:

APM agents on edge machines send data to a centrally hosted APM integration:

[subs=attributes+]
include::./diagrams/apm-architecture-central.asciidoc[Elastic APM architecture with edge APM integrations]

Or, APM agents and the APM integration live on edge machines and enroll via a centrally hosted {agent}:

[subs=attributes+]
include::./diagrams/apm-architecture-edge.asciidoc[Elastic APM architecture with central APM integration]

In addition, Elastic supports OpenTelemetry:
[float]
=== APM Server

[subs=attributes+]
include::./diagrams/apm-otel-architecture.asciidoc[Architecture of Elastic APM with OpenTelemetry]
APM Server is a free and open application that receives performance data from your APM agents.
It's a separate component by design,
which helps keep the APM agents light, prevents certain security risks, and improves compatibility across the {stack}.

// Not sure which to choose? See the [blog post]
After the APM Server has validated and processed events from the APM agents,
the APM server transforms the data into {es} documents and stores them in corresponding {es} indices.
In a matter of seconds, you can start viewing your application performance data in the {kib} {apm-app}.

[float]
=== APM Agents
Expand All @@ -51,20 +33,6 @@ Each agent has its own documentation:
* {apm-ruby-ref-v}/introduction.html[Ruby agent]
* {apm-rum-ref-v}/intro.html[JavaScript Real User Monitoring (RUM) agent]

[float]
[[apm-integration]]
=== Elastic APM integration

The APM integration receives performance data from your APM agents,
validates and processes it, and then transforms the data into {es} documents.
Removing this logic from APM agents help keeps them light, prevents certain security risks,
and improves compatibility across the {stack}.

The Elastic integration runs on {fleet-guide}[{agent}]. {agent} is a single, unified way to add monitoring for logs,
metrics, traces, and other types of data to each host.
A single agent makes it easier and faster to deploy monitoring across your infrastructure.
The agent's single, unified policy makes it easier to add integrations for new data sources.

[float]
=== {es}

Expand All @@ -89,3 +57,44 @@ The following sections will help you get started:
APM also has built-in integrations with {ml-cap}. To learn more about this feature,
or the {anomaly-detect} feature that's built on top of it,
refer to {kibana-ref}/machine-learning-integration.html[{ml-cap} integration].

// [float]
// === Self-managed

// If you've chosen to self-manage the Elastic Stack, there are some additional components to be aware of.



// ****
// There are two ways to install, run, and manage Elastic APM:

// * With the Elastic APM integration
// * With the standalone (legacy) APM Server binary

// This documentation focuses on option one: the **Elastic APM integration**.
// For standalone APM Server (legacy) documentation, please see the <<legacy-apm-overview>>
// and <<overview>>.
// ****

// Elastic APM consists of four components: *APM agents*, the *Elastic APM integration*, *{es}*, and *{kib}*.
// Generally, there are two ways that these four components can work together:

// APM agents on edge machines send data to a centrally hosted APM integration:

// [subs=attributes+]
// include::./diagrams/apm-architecture-central.asciidoc[Elastic APM architecture with edge APM integrations]

// Or, APM agents and the APM integration live on edge machines and enroll via a centrally hosted {agent}:

// [subs=attributes+]
// include::./diagrams/apm-architecture-edge.asciidoc[Elastic APM architecture with central APM integration]

// In addition, Elastic supports OpenTelemetry:

// [subs=attributes+]
// include::./diagrams/apm-otel-architecture.asciidoc[Architecture of Elastic APM with OpenTelemetry]

// The Elastic integration runs on {fleet-guide}[{agent}]. {agent} is a single, unified way to add monitoring for logs,
// metrics, traces, and other types of data to each host.
// A single agent makes it easier and faster to deploy monitoring across your infrastructure.
// The agent's single, unified policy makes it easier to add integrations for new data sources.
24 changes: 19 additions & 5 deletions docs/apm-quick-start.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
[[apm-quick-start]]
== Quick start
== Quick start with {ecloud}

// * Point to EA APT/YUM
// * Point to EA for running on Docker
// * Point to EA for directory layout
// * Point to EA for systemd
The easiest way to get started with Elastic APM is by using our
{ess-product}[hosted {es} Service] on {ecloud}.
The {es} Service is available on AWS, GCP, and Azure.
The {es} Service provisions the following components of the {stack}:

* *{es}* -- A highly scalable free and open full-text search and analytics engine.
* *{kib}* -- An analytics and visualization platform designed to work with {es}.
* *Integrations Server* -- A combined *APM Server* and *Fleet-managed {agent}*.
** *APM Server* -- An application that receives, processes, and validates performance data from your APM agents.
** *Fleet-managed {agent}* -- A server that runs Fleet Server and provides a control plane for easily configuring and updating APM and other integrations.

Don't worry--in order to get started,
you don't need to understand how all of these pieces work together!
When you use our hosted {es} Service,
simply spin-up your instance and point your *APM agents* towards it.

[float]
== What will I learn in this guide?

include::{obs-repo-dir}/observability/ingest-traces.asciidoc[tag=apm-quick-start]
Loading