Skip to content

Commit

Permalink
docs: update APM quick start guide (#1359)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Dec 14, 2021
1 parent a3da628 commit 03da39d
Show file tree
Hide file tree
Showing 18 changed files with 123 additions and 47 deletions.
59 changes: 12 additions & 47 deletions docs/en/observability/ingest-traces.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,19 @@ For more information, refer to {fleet-guide}/fleet-server.html[{fleet-server}].
[[add-agent-to-fleet-traces]]
== Step 2: Add an {agent} to {fleet}

[TIP]
====
Don't confuse {agent} with APM agents–they are different components.
In a later step, you'll instrument your code with APM agents and send the data
to an APM Server instance that {agent} spins up.
====
****
This step is optional for {ess} users as {ecloud} spins up an {agent} instance automatically.
Unless you want to run a separate {agent} on an edge machine, {ess} users should skip this step.
****

{agent} is a single, unified agent that you can deploy to hosts or containers to
collect data and send it to the {stack}. Behind the scenes, {agent} runs the
{beats} shippers or Elastic Endpoint required for your configuration.

Don't confuse {agent} with APM agents–they are different components.
In a later step, you'll instrument your code with APM agents and send the data
to an APM Server instance that {agent} spins up.

If you plan on enabling Real User Monitoring (RUM), you must run {agent} centrally.
If RUM is disabled, you should run {agent} on edge machines.

Expand All @@ -77,48 +79,11 @@ include::../ingest-management/elastic-agent/install-fleet-managed-elastic-agent.
[[add-apm-integration]]
== Step 3: Add the APM integration

Next, you'll browse a catalog of integrations, then add an APM integration to
the default policy used by your agent. You use policies to manage settings
across a group of agents. An agent policy may contain any number of integrations
for collecting observability data from the various services running on your
host.
Next, add the APM integration to the default policy used by your {agent}.
Policies manage settings across a group of {agent}s and may contain any number of integrations
for collecting observability data from the various services running on your host.

. In {kib}, select **Add integrations**.
+
[role="screenshot"]
image::images/kibana-fleet-integrations-apm.png[{fleet} showing APM integration]
. Click the **Elastic APM** integration to see more details about it, then click
**Add Elastic APM**.
+
[role="screenshot"]
image::images/kibana-fleet-integrations-apm-overview.png[{fleet} showing APM integration overview]

. On the **Add Elastic APM integration** page,
define the host and port where APM Server will listen.
If you're using our hosted **Elastic Cloud** offering, the URL where APM Server listens will be predefined.
Inspect or change other settings.

. Under **Apply to agent policy**, select the default policy.
Click **Save and continue**.
+
****
In this guide, you add integrations to the default policy created by
{kib}. After you learn the basics, you can create your own policies and assign
them to agents.
****
+
[role="screenshot"]
image::images/add-integration-apm.png[{fleet} Add APM integration page]

. To see the updated policy, click the *Default policy* link.
+
The newly added APM integration should appear under **Fleet** > **Agent policies** > **Default policy**,
along with the default System integration.
+
[role="screenshot"]
image::images/kibana-fleet-policies-default-with-apm.png[{fleet} showing default agent policy with apm-1 datasource]
+
All {agent}s that use this policy will collect APM data from your instrumented services.
include::./tab-widgets/add-apm-integration/widget.asciidoc[]

[discrete]
[[add-apm-integration-agents]]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// tag::ess[]
. In {kib}, select **Add integrations** > **Elastic APM**.
+
[role="screenshot"]
image::./images/kibana-fleet-integrations-apm.png[{fleet} showing APM integration]

. Click **APM integration**.
+
[role="screenshot"]
image::./images/cloud-add-apm.png[Add APM integration]

. Click **Switch to {agent}**.
+
[role="screenshot"]
image::./images/cloud-switch-to-apm.png[Switch to Elastic APM]

. Confirm that you wish to switch to {agent}. Some `apm-server.yml` are incompatible
with {agent} and will be removed when {agent} is enabled. Click **Switch to {agent}**.
+
[role="screenshot"]
image::./images/cloud-switch-to-ea.png[Switch to Elastic Agent]

. When the APM integration finishes setting up, click **View the APM integration in Fleet**.

. As you can see, the APM integration has been added to the Elastic Cloud Agent policy.
This is the default policy for {agent}s hosted on {ecloud}.
Select **Actions** > **Edit integration** to configure the APM integration.
+
[role="screenshot"]
image::./images/cloud-edit-apm.png[Edit the APM integration]

. Make a note of the predefined Host and URL that the APM Server is listening on--you'll
need these in the next step.
If you made any changes to your configuration, click **save and continue**.

// end::ess[]

// tag::self-managed[]
. In {kib}, select **Add integrations** > **Elastic APM**.
+
[role="screenshot"]
image::./images/kibana-fleet-integrations-apm.png[{fleet} showing APM integration]

. Click **Add Elastic APM**.
+
[role="screenshot"]
image::./images/kibana-fleet-integrations-apm-overview.png[{fleet} showing APM integration overview]

. On the **Add Elastic APM integration** page,
define the host and port where APM Server will listen.

. Under **Apply to agent policy**, select the default policy.
Click **Save and continue**.
+
In this guide, you add integrations to the default policy created by
{kib}. After you learn the basics, you can create your own policies and assign
them to agents.
+
[role="screenshot"]
image::./images/add-integration-apm.png[{fleet} Add APM integration page]

. To see the updated policy, click the *Default policy* link.
+
The newly added APM integration should appear under **Fleet** > **Agent policies** > **Default policy**,
along with the default System integration.
+
[role="screenshot"]
image::./images/kibana-fleet-policies-default-with-apm.png[{fleet} showing default agent policy with apm-1 datasource]
+
All {agent}s that use this policy will collect APM data from your instrumented services.
// end::self-managed[]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
++++
<div class="tabs" data-tab-group="add-apm-integration">
<div role="tablist" aria-label="Add APM integration">
<button role="tab"
aria-selected="true"
aria-controls="cloud-add-apm"
id="cloud-apm">
Elasticsearch Service
</button>
<button role="tab"
aria-selected="false"
aria-controls="self-managed-add-apm"
id="self-managed-apm"
tabindex="-1">
Self-managed
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="cloud-add-apm"
aria-labelledby="cloud-apm">
++++

include::content.asciidoc[tag=ess]

++++
</div>
<div tabindex="0"
role="tabpanel"
id="self-managed-add-apm"
aria-labelledby="self-managed-apm"
hidden="">
++++

include::content.asciidoc[tag=self-managed]

++++
</div>
</div>
++++
Binary file added observability/images/add-integration-apm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added observability/images/cloud-add-apm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added observability/images/cloud-edit-apm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added observability/images/cloud-switch-to-apm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added observability/images/cloud-switch-to-ea.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 03da39d

Please sign in to comment.