From 759757fa7684eace217440b5ffebb249fedf03c0 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 24 Oct 2023 13:21:51 -0500 Subject: [PATCH] rename ingest-traces --- docs/en/observability/index.asciidoc | 3 +- docs/en/observability/ingest-traces.asciidoc | 8 -- .../landing-page/data/recommended-data.json | 4 +- ...gest-traces.png => traces-get-started.png} | Bin .../observability/landing-page/page.asciidoc | 4 +- .../observability-get-started.asciidoc | 2 +- docs/en/observability/redirects.asciidoc | 5 + .../observability/traces-get-started.asciidoc | 105 ++++++++++++++++++ 8 files changed, 116 insertions(+), 15 deletions(-) rename docs/en/observability/landing-page/images/{ingest-traces.png => traces-get-started.png} (100%) create mode 100644 docs/en/observability/traces-get-started.asciidoc diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index f05629b9d1..3c808bc5d5 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -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] diff --git a/docs/en/observability/ingest-traces.asciidoc b/docs/en/observability/ingest-traces.asciidoc index 546385da0e..d174468eab 100644 --- a/docs/en/observability/ingest-traces.asciidoc +++ b/docs/en/observability/ingest-traces.asciidoc @@ -1,11 +1,3 @@ -[[ingest-traces]] -= Get started with application traces and APM - -++++ -Traces and APM -++++ - -// THIS CONTENT IS ALSO USED IN THE APM GUIDE // tag::apm-quick-start[] This guide describes how to: diff --git a/docs/en/observability/landing-page/data/recommended-data.json b/docs/en/observability/landing-page/data/recommended-data.json index a3c242dd28..a488b0373c 100644 --- a/docs/en/observability/landing-page/data/recommended-data.json +++ b/docs/en/observability/landing-page/data/recommended-data.json @@ -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", diff --git a/docs/en/observability/landing-page/images/ingest-traces.png b/docs/en/observability/landing-page/images/traces-get-started.png similarity index 100% rename from docs/en/observability/landing-page/images/ingest-traces.png rename to docs/en/observability/landing-page/images/traces-get-started.png diff --git a/docs/en/observability/landing-page/page.asciidoc b/docs/en/observability/landing-page/page.asciidoc index dd40f2cb73..f5bed48bac 100644 --- a/docs/en/observability/landing-page/page.asciidoc +++ b/docs/en/observability/landing-page/page.asciidoc @@ -2,7 +2,7 @@ include::temp/style.asciidoc[] [subs=attributes+] ++++ -

Rely on the most widely deployed observability solution, powered by machine learning and analytics, to converge metrics, logs, and traces that deliver unified visibility and actionable insights.

  • Eliminate tool silos and efficiently store data
  • Get visibility across hybrid and multi-cloud environments
  • Monitor your digital experience — 24/7

What do you want to observe?

Use cases

Cloud monitoring

Cross-platform and multi-cloud visibility and analytics.

DevOps

Observe your entire software lifecycle — from development to production.

  • CI/CD
    Get better visibility into your CI/CD pipelines.
  • ECS logging
    Leverage the Elastic Common Schema logging libraries to automatically link application traces to their corresponding logs.

AIOps

Automate anomaly detection and accelerate root cause analysis.

  • Root cause analysis with logs
    Learn about Elastic’s artificial intelligence for IT operations and machine learning capabilities for root cause analysis.
  • APM Correlations
    Automatically identify the probable causes of slow or failed transactions.

User experience

Measure, gauge, and improve your end users’ experience.

  • Scripting browser monitors
    Simulate critical user workflows on a regular interval to catch bugs before your users report them.
  • User experience
    Learn how to track Core Web Vitals and how to use them to quantify the real-world user experience.

Related documentation

+

Rely on the most widely deployed observability solution, powered by machine learning and analytics, to converge metrics, logs, and traces that deliver unified visibility and actionable insights.

  • Eliminate tool silos and efficiently store data
  • Get visibility across hybrid and multi-cloud environments
  • Monitor your digital experience — 24/7

What do you want to observe?

Use cases

Cloud monitoring

Cross-platform and multi-cloud visibility and analytics.

DevOps

Observe your entire software lifecycle — from development to production.

  • CI/CD
    Get better visibility into your CI/CD pipelines.
  • ECS logging
    Leverage the Elastic Common Schema logging libraries to automatically link application traces to their corresponding logs.

AIOps

Automate anomaly detection and accelerate root cause analysis.

  • Root cause analysis with logs
    Learn about Elastic’s artificial intelligence for IT operations and machine learning capabilities for root cause analysis.
  • APM Correlations
    Automatically identify the probable causes of slow or failed transactions.

User experience

Measure, gauge, and improve your end users’ experience.

  • Scripting browser monitors
    Simulate critical user workflows on a regular interval to catch bugs before your users report them.
  • User experience
    Learn how to track Core Web Vitals and how to use them to quantify the real-world user experience.

Related documentation

++++ ++++ @@ -11,7 +11,7 @@ include::temp/style.asciidoc[] image::landing-page/images/application-logs.png[] image::landing-page/images/framework-integrations.png[] image::landing-page/images/ingest-logs-metrics-uptime.png[] -image::landing-page/images/ingest-traces.png[] +image::landing-page/images/traces-get-started.png[] image::landing-page/images/integrations.png[] image::landing-page/images/intro.png[] image::landing-page/images/open-telemetry.png[] diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index 0627539638..6bf7b896f8 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -32,7 +32,7 @@ detection. Follow the steps in these guides to get started: * <> -* <> +* <> * <> [discrete] diff --git a/docs/en/observability/redirects.asciidoc b/docs/en/observability/redirects.asciidoc index e798872443..5b979fc816 100644 --- a/docs/en/observability/redirects.asciidoc +++ b/docs/en/observability/redirects.asciidoc @@ -141,6 +141,11 @@ Refer to <>. Refer to <>. +[role="exclude" id="ingest-traces"] +=== Ingest application traces with {agent} + +Refer to <>. + [role="exclude" id="threshold-alert"] === Create a threshold rule diff --git a/docs/en/observability/traces-get-started.asciidoc b/docs/en/observability/traces-get-started.asciidoc new file mode 100644 index 0000000000..b334d1c4a7 --- /dev/null +++ b/docs/en/observability/traces-get-started.asciidoc @@ -0,0 +1,105 @@ +[[traces-get-started]] += Get started with application traces and APM + +++++ +Traces and APM +++++ + +// 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[]