-
Notifications
You must be signed in to change notification settings - Fork 184
Relocate APM Server getting started content #2410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
9224c88
relocate apm server getting started content
colleenmcginnis 39132b9
update title
colleenmcginnis a04ed02
Merge branch 'main' into move-apm-get-started-guides
colleenmcginnis 66d9316
fix image paths, address feedback
colleenmcginnis ba997e1
more clean up
colleenmcginnis 5c52506
Merge branch 'main' into move-apm-get-started-guides
colleenmcginnis fa7d999
apply suggestions from code review
colleenmcginnis 0e9bee6
Merge branch 'main' into move-apm-get-started-guides
colleenmcginnis b2c9f8d
update diagram
colleenmcginnis 9bfdeb0
Merge branch 'main' into move-apm-get-started-guides
colleenmcginnis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| navigation_title: Set up | ||
| applies_to: | ||
| stack: ga | ||
| serverless: unavailable | ||
| --- | ||
|
|
||
| # Set up APM Server | ||
|
|
||
| :::{tip} | ||
| Just getting started? | ||
| The fastest way to get started with Elastic APM is with Elastic Cloud Serverless. | ||
| Read more in [](/solutions/observability/apm/get-started.md). | ||
| ::: | ||
|
|
||
| APM Server receives performance data from your APM agents and Elastic Distribution of OpenTelemetry (EDOT) SDKs, validates and processes it, and then transforms the data into {{es}} documents. If you’re on this page, then you’ve chosen to self-manage the Elastic Stack, and you now must decide how to run and configure the APM Server. There are two options, and the components required are different for each: | ||
colleenmcginnis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| * [Fleet-managed APM Server](#apm-setup-fleet-managed-apm) | ||
| * [APM Server binary](#apm-setup-apm-server-binary) | ||
|
|
||
| ## Fleet-managed APM Server [apm-setup-fleet-managed-apm] | ||
|
|
||
| Fleet is a web-based UI in {{kib}} that is used to centrally manage {{agent}}s. In this deployment model, use {{agent}} to spin up APM Server instances that can be centrally-managed in a custom-curated user interface. | ||
|
|
||
| :::{image} /solutions/images/observability-fm-ov.png | ||
| :alt: APM Server fleet overview | ||
| ::: | ||
|
|
||
| **Pros**: | ||
|
|
||
| * Conveniently manage one, some, or many different integrations from one central {{fleet}} UI. | ||
| * Centrally manage multiple APM Servers running on edge machines. | ||
|
|
||
| **Supported outputs**: | ||
|
|
||
| * {{es}} | ||
| * {{ech}} | ||
|
|
||
| ::::{note} | ||
| Fleet-managed APM Server does *not* support all the outputs that are supported by the APM Server binary method of running Elastic APM. | ||
| :::: | ||
|
|
||
| **Required components**: | ||
|
|
||
| * EDOT SDKs or APM agents | ||
| * {{agent}} (which runs multiple subprocesses including APM Server, Fleet Server, and {{stack}}) | ||
|
|
||
| **Configuration method**: {{kib}} UI | ||
|
|
||
| ## APM Server binary [apm-setup-apm-server-binary] | ||
|
|
||
| Install, configure, and run the APM Server binary wherever you need it. | ||
|
|
||
| :::{image} /solutions/images/observability-bin-ov.png | ||
| :alt: APM Server binary overview | ||
| ::: | ||
|
|
||
| **Pros**: | ||
|
|
||
| * Simplest self-managed option | ||
| * No addition component knowledge required | ||
| * YAML configuration simplifies automation | ||
|
|
||
| **Supported outputs**: | ||
|
|
||
| * {{es}} | ||
| * {{ech}} | ||
| * {{ls}} | ||
| * Kafka | ||
| * Redis | ||
| * File | ||
| * Console | ||
|
|
||
| **Required components**: | ||
|
|
||
| * EDOT SDKs or APM agents | ||
| * APM Server | ||
| * {{stack}} | ||
|
|
||
| **Configuration method**: YAML | ||
|
|
||
| ## Help me decide [_help_me_decide] | ||
|
|
||
| This decision tree highlights key factors to help you make an informed decision about implementing Elastic APM. It provides practical guidance and is not intended to serve as a comprehensive reference of all possible implementations and capabilities. | ||
|
|
||
| :::{image} /solutions/images/observability-apm-help-me-decide.png | ||
| :alt: APM decision tree | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| applies_to: | ||
| stack: ga | ||
| serverless: unavailable | ||
| --- | ||
|
|
||
| # Work with APM Server | ||
|
|
||
| When self-managing the Elastic Stack, APM Server receives performance data from APM agents, | ||
| validates and processes it, and transforms the data into {{es}} documents. | ||
|
|
||
| This section contains information on working with APM Server including: | ||
|
|
||
| * Learning how to [set up APM Server](/solutions/observability/apm/apm-server-setup.md) | ||
| * Browsing all available [APM Server configuration options](/solutions/observability/apm/configure-apm-server.md) | ||
| * [Monitoring the real-time health and performance](/solutions/observability/apm/monitor-apm-server.md) of your APM Server | ||
|
|
||
| :::{tip} | ||
| If you're using {{serverless-full}}, there is no APM Server running. Instead the _managed intake service_ receives and transforms data. Read more in [](/solutions/observability/apm/get-started.md). | ||
| ::: | ||
colleenmcginnis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is ## Step 4: Install APM agents [apm-next-steps] still something that we want to show in this level of detail for the
apm-serverchoice? Asking as there is also https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/elastic-apm-agentsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to leave that section as is for now so we can at least get these guides back into the observability docs. Let's discuss this in a follow-up issue.