Skip to content
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

Rename ingest-traces #3309

Merged
merged 1 commit into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ include::observability-get-started.asciidoc[leveloffset=+1]

include::logs-metrics-get-started.asciidoc[leveloffset=+2]

//TOOD: Rename this file to traces-get-started in a follow-on PR
include::ingest-traces.asciidoc[leveloffset=+2]
include::traces-get-started.asciidoc[leveloffset=+2]

include::splunk-get-started.asciidoc[leveloffset=+2]

Expand Down
8 changes: 0 additions & 8 deletions docs/en/observability/ingest-traces.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
[[ingest-traces]]
= Get started with application traces and APM

++++
<titleabbrev>Traces and APM</titleabbrev>
++++

// THIS CONTENT IS ALSO USED IN THE APM GUIDE
// tag::apm-quick-start[]

This guide describes how to:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
{
"title": "Monitor your application performance",
"description": "Learn how to collect and visualize Application Performance Monitoring (APM) data with the Elastic Stack.",
"link": "ingest-traces.html",
"image": "ingest-traces.png"
"link": "traces-get-started.html",
"image": "traces-get-started.png"
},
{
"title": "Monitor your application logs",
Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/landing-page/page.asciidoc

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/en/observability/observability-get-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ detection.
Follow the steps in these guides to get started:

* <<logs-metrics-get-started,Get started with logs and metrics>>
* <<ingest-traces,Get started with application traces and APM>>
* <<traces-get-started,Get started with application traces and APM>>
* <<splunk-get-started,Get started with data from Splunk>>

[discrete]
Expand Down
5 changes: 5 additions & 0 deletions docs/en/observability/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ Refer to <<synthetics-get-started-project>>.

Refer to <<synthetics-analyze-journeys>>.

[role="exclude" id="ingest-traces"]
=== Ingest application traces with {agent}

Refer to <<traces-get-started>>.

[role="exclude" id="threshold-alert"]
=== Create a threshold rule

Expand Down
105 changes: 105 additions & 0 deletions docs/en/observability/traces-get-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
[[traces-get-started]]
= Get started with application traces and APM

++++
<titleabbrev>Traces and APM</titleabbrev>
++++

// THIS CONTENT IS ALSO USED IN THE APM GUIDE
// tag::apm-quick-start[]

This guide describes how to:

* Collect Application Performance Monitoring (APM) data
* Send APM data to the {stack}
* Explore and visualize the data in real-time

For feedback and questions, please contact us in the {forum}[discuss forum].

[discrete]
[[traces-prereqs]]
== Prerequisites

include::{observability-docs-root}/docs/en/observability/logs-metrics-get-started.asciidoc[tag=monitoring-prereqs]

[discrete]
[[add-apm-integration]]
== Step 1: Configure the APM integration

{ecloud} runs a hosted version of {integrations-server} that includes the APM integration.

include::./tab-widgets/add-apm-integration/content.asciidoc[tag=ess]

[discrete]
[[add-apm-integration-agents]]
== Step 2: Install APM agents

APM agents are written in the same language as your service.
To monitor a new service, you must install the agent and configure it with a service name,
APM Server host, and Secret token.

* **Service name**: The APM integration maps an instrumented service's name–defined in each {apm-agent}'s configuration–
to the index that its data is stored in {es}.
Service names are case-insensitive and must be unique.
For example, you cannot have a service named `Foo` and another named `foo`.
Special characters will be removed from service names and replaced with underscores (`_`).

* **APM Server URL**: The host and port that APM Server listens for events on.
This should match the host and port defined when setting up the APM integration.

* **Secret token**: Authentication method for {apm-agent} and APM Server communication.
This should match the secret token defined when setting up the APM integration.

TIP: You can edit your APM integration settings if you need to change the APM Server URL
or secret token to match your APM agents.

--
// this if directive includes the same file, but changes the file path based on where this guide is built
ifndef::apm-integration-docs[]
include::{apm-server-root}/docs/tab-widgets/install-agents-widget.asciidoc[]
endif::[]

ifdef::apm-integration-docs[]
include::{tab-widget-dir}/install-agents-widget.asciidoc[]
endif::[]
--

[discrete]
[[view-apm-integration-data]]
== Step 3: View your data

Back in {kib}, under {observability}, select APM.
You should see application performance monitoring data flowing into the {stack}!

NOTE: The built-in `apm_user` role is not compatible with the APM integration
as it only provides read access to `apm-*` indices.
For a list of indices users need access to, refer to
{apm-guide-ref}/apm-data-streams.html[APM data streams]

[role="screenshot"]
image::images/kibana-apm-sample-data.png[{apm-app} with data]

Not seeing any data? Review our list of {apm-guide-ref}/common-problems.html[common problems] for helpful tips.

[discrete]
== What's next?

* Now that data is streaming into the {stack}, take your investigation to a
deeper level! Use https://www.elastic.co/observability[Elastic {observability}]
to unify your logs, metrics, uptime, and application performance data.

* Want to protect your endpoints from security threats? Try
https://www.elastic.co/security[{elastic-sec}]. Adding endpoint protection is
just another integration that you add to the agent policy!

* Are your eyes bleary from staring at a wall of screens?
{observability-guide}/create-alerts.html[Create alerts] and find out about
problems while sipping your favorite beverage poolside.

* Want Elastic to do the heavy lifting? Use {ml} to
{observability-guide}/inspect-log-anomalies.html[detect anomalies].

* Got everything working like you want it? Roll out your agent policies to
other hosts by deploying {agent}s across your infrastructure!

// end::apm-quick-start[]
Loading