From 90b64847c4c16da47d911892cd12ead61efdbe4a Mon Sep 17 00:00:00 2001 From: dedemorton Date: Thu, 8 Aug 2024 18:53:27 -0700 Subject: [PATCH 01/23] Create new IA for observability docs --- ...pplication-and-service-monitoring.asciidoc | 4 + .../ci-cd-observability.asciidoc | 4 +- .../observability/cloud-monitoring.asciidoc | 4 + .../aws/monitor-amazon-intro.asciidoc | 4 +- .../aws/monitor-aws-agent.asciidoc | 6 +- .../azure/monitor-azure-agent.asciidoc | 16 +- .../azure/monitor-azure-intro.asciidoc | 2 +- .../azure/monitor-azure-native.asciidoc | 5 +- docs/en/observability/data-insights.asciidoc | 4 + .../observability/fields-reference.asciidoc | 2 +- docs/en/observability/gcp-dataflow.asciidoc | 12 +- docs/en/observability/index.asciidoc | 260 ++++++++++-------- .../logs-metrics-get-started.asciidoc | 2 +- docs/en/observability/monitor-gcp.asciidoc | 26 +- .../monitor-infra/analyze-metrics.asciidoc | 2 +- .../monitor-k8s/monitor-k8s.asciidoc | 2 +- .../observability-get-started.asciidoc | 3 +- docs/en/observability/start-here.asciidoc | 4 + .../en/observability/troubleshooting.asciidoc | 2 +- docs/en/observability/tutorials.asciidoc | 16 +- .../uptime-get-started-heartbeat.asciidoc | 4 + docs/en/observability/uptime-intro.asciidoc | 2 +- 22 files changed, 215 insertions(+), 171 deletions(-) create mode 100644 docs/en/observability/application-and-service-monitoring.asciidoc create mode 100644 docs/en/observability/cloud-monitoring.asciidoc create mode 100644 docs/en/observability/data-insights.asciidoc create mode 100644 docs/en/observability/start-here.asciidoc diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc new file mode 100644 index 0000000000..2a983e3ed4 --- /dev/null +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -0,0 +1,4 @@ +[[application-and-service-monitoring]] += Application and service monitoring + +Placeholder topic diff --git a/docs/en/observability/ci-cd-observability.asciidoc b/docs/en/observability/ci-cd-observability.asciidoc index 40f77fbd44..06094f2eef 100644 --- a/docs/en/observability/ci-cd-observability.asciidoc +++ b/docs/en/observability/ci-cd-observability.asciidoc @@ -1,7 +1,9 @@ [[ci-cd-observability]] -= CI/CD observability += CI/CD monitoring :figure-caption!: +//TODO: Update ID and filename to match name change + To help administrators monitor and troubleshoot their CI/CD platform and help developers increase the speed and reliability of their CI/CD pipelines, Elastic {observability} provides visibility in Continuous Integration and Continuous Delivery (CI/CD) processes. diff --git a/docs/en/observability/cloud-monitoring.asciidoc b/docs/en/observability/cloud-monitoring.asciidoc new file mode 100644 index 0000000000..5eac02d684 --- /dev/null +++ b/docs/en/observability/cloud-monitoring.asciidoc @@ -0,0 +1,4 @@ +[[cloud-monitoring]] += Cloud monitoring + +Placeholder topic diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-intro.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-intro.asciidoc index 89abb467bc..102387f7eb 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-intro.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-intro.asciidoc @@ -3,12 +3,12 @@ = Amazon Web Services (AWS) monitoring ++++ -AWS monitoring +AWS ++++ Elastic Observability offers powerful monitoring solutions to keep your AWS environments reliable and efficient, providing deep insights into the performance of your applications, services, and infrastructure components. -Learn how to use the Elastic Observability solution to observe and monitor a broad range of AWS resources and applications. +Learn how to use the Elastic Observability solution to observe and monitor a broad range of AWS resources and applications. - <> - <> diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc index c620a44ad8..f61851e0ed 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc @@ -410,5 +410,7 @@ To track your AWS billing, open the [role="screenshot"] image::images/agent-tut-billing-dashboard.png[Screenshot of the Billing Overview dashboard] -Congratulations! You have completed the tutorial. To try other tutorials in this -series, visit the <> page. +Congratulations! You have completed the tutorial. + +//TODO: Remove this link +//To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc b/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc index 6f9f68f417..e4e3f667dc 100644 --- a/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc +++ b/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc @@ -110,7 +110,7 @@ In this step, you install the Azure Billing Metrics integration in {kib}. This integration contains an input for collecting metrics, such as Azure usage details and forecast information, about your subscription. -To add the integration: +To add the integration: . Go to the {kib} home page and click **Add integrations**. + @@ -137,7 +137,7 @@ documentation. [horizontal] **Client ID**:: The Application (client) ID that you copied earlier when you created the service -principal. +principal. **Client secret**:: The secret value that you copied earlier. @@ -151,7 +151,7 @@ image::images/agent-tut-azure-integration-settings.png[Screenshot of integration . Make sure the **Collect Azure Billing metrics** selector is turned on. -. Accept the defaults to create a new agent policy. +. Accept the defaults to create a new agent policy. . Click **Save and continue**. This step takes a minute or two to complete. When it's done, you'll have an agent policy that contains the Azure configuration you @@ -247,7 +247,7 @@ image::images/agent-tut-azure-create-eventhub.png[Screenshot of window for creat . Click **Create** to deploy the resource. . In the new namespace, click **+ Event Hub** and enter a name for the event hub. -. Click **Review + create**, and then click **Create** to deploy the resource. +. Click **Review + create**, and then click **Create** to deploy the resource. . Make a note of the namespace and event hub name because you will need them later. @@ -266,7 +266,7 @@ This setup is more efficient than using a single event hub for all logs because it: * Ensures that you publish only the logs expected by the downstream -integration. +integration. * Saves bandwidth and compute resources because inputs only need to process relevant logs, rather than processing all the logs for all your monitored services, then discarding unneeded logs. @@ -306,7 +306,7 @@ image::images/agent-tut-azure-log-categories.png[Screenshot of Azure diagnostic Now that activity logs are streaming into the event hub, you can configure the Azure activity log integration to ingest the logs. -To add the integration: +To add the integration: . Go to the {kib} home page and click **Add integrations**. @@ -390,5 +390,5 @@ you can use to visualize the data. In {kib}, open the main menu and click [role="screenshot"] image::images/agent-tut-azure-activity-logs-dashboard.png[Screenshot of Azure activity logs dashboard] -Congratulations! You have completed the tutorial. To try other tutorials in this -series, visit the <> page. +Congratulations! You have completed the tutorial. +// To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/cloud-monitoring/azure/monitor-azure-intro.asciidoc b/docs/en/observability/cloud-monitoring/azure/monitor-azure-intro.asciidoc index 5ce5c8492b..1bacecfd8a 100644 --- a/docs/en/observability/cloud-monitoring/azure/monitor-azure-intro.asciidoc +++ b/docs/en/observability/cloud-monitoring/azure/monitor-azure-intro.asciidoc @@ -3,7 +3,7 @@ = Azure monitoring ++++ -Azure monitoring +Azure ++++ Elastic Observability offers powerful monitoring solutions to keep your Azure environments reliable and efficient, providing deep insights into the performance of your applications, services, and infrastructure components. diff --git a/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc b/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc index 17041130ac..d372a4f2e7 100644 --- a/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc +++ b/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc @@ -147,5 +147,6 @@ To explore the data further, click **Open as page**. [role="screenshot"] image::monitor-azure-native-kibana-vms-metrics-detail.png[Screenshot of detailed VM metrics] -Congratulations! You have completed the tutorial. To try other tutorials in this -series, visit the <> page. +Congratulations! You have completed the tutorial. + +//To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/data-insights.asciidoc b/docs/en/observability/data-insights.asciidoc new file mode 100644 index 0000000000..4907da0065 --- /dev/null +++ b/docs/en/observability/data-insights.asciidoc @@ -0,0 +1,4 @@ +[[data-insights]] += Data insights + +Placeholder topic diff --git a/docs/en/observability/fields-reference.asciidoc b/docs/en/observability/fields-reference.asciidoc index a1cc31e9d1..edbb12ef2e 100644 --- a/docs/en/observability/fields-reference.asciidoc +++ b/docs/en/observability/fields-reference.asciidoc @@ -4,7 +4,7 @@ This section lists Elastic Common Schema (ECS) fields the Logs and Infrastructure apps use to display data. ECS is an open source specification that defines a standard set of fields to use when storing event data in -{es}, such as logs and metrics. +{es}, such as logs and metrics. Beat modules (for example, {filebeat-ref}/filebeat-modules.html[{filebeat} modules]) are ECS-compliant, so manual field mapping is not required, and all data is diff --git a/docs/en/observability/gcp-dataflow.asciidoc b/docs/en/observability/gcp-dataflow.asciidoc index 357cd45f83..3b6dd49ebe 100644 --- a/docs/en/observability/gcp-dataflow.asciidoc +++ b/docs/en/observability/gcp-dataflow.asciidoc @@ -1,11 +1,11 @@ [[gcp-dataflow]] -=== GCP Dataflow templates +== GCP Dataflow templates In this tutorial, you'll learn how to ship logs directly from the Google Cloud Console with the Dataflow template for analyzing GCP Audit Logs in the {stack}. [discrete] -==== What you'll learn +=== What you'll learn You'll learn how to: @@ -14,14 +14,14 @@ You'll learn how to: view those logs in {kib}. [discrete] -==== Before you begin +=== Before you begin Create a deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. [discrete] -==== Step 1: Install the GCP integration +=== Step 1: Install the GCP integration You’ll start with installing the Elastic GCP integration to add pre-built dashboards, ingest node configurations, and other assets that help you get @@ -58,7 +58,7 @@ For this tutorial the data is written to the `logs-gcp.audit-default` data strea ==== **** [discrete] -==== Step 2: Create a Pub/Sub topic and subscription +=== Step 2: Create a Pub/Sub topic and subscription Before configuring the Dataflow template, create a Pub/Sub topic and subscription from your Google Cloud Console where you can send your @@ -66,7 +66,7 @@ logs from Google Operations Suite. include::gcp-topic.asciidoc[] [discrete] -==== Step 3: Configure the Google Dataflow template +=== Step 3: Configure the Google Dataflow template After creating a Pub/Sub topic and subscription, go to the *Dataflow Jobs* page and configure your template to use them. Use the search bar to find the page: diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index 6f349be94f..ff229b4fe0 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -7,203 +7,218 @@ include::{docs-root}/shared/attributes.asciidoc[] include::landing-page/page.asciidoc[] +// Group: Start here +include::start-here.asciidoc[leveloffset=+1] + // What is Observability? -include::observability-introduction.asciidoc[leveloffset=+1] +include::observability-introduction.asciidoc[leveloffset=+2] // What's new -include::whats-new.asciidoc[leveloffset=+1] +include::whats-new.asciidoc[leveloffset=+2] // Get started with Elastic Observability -include::observability-get-started.asciidoc[leveloffset=+1] - -include::logs-metrics-get-started.asciidoc[leveloffset=+2] +include::observability-get-started.asciidoc[leveloffset=+2] -include::traces-get-started.asciidoc[leveloffset=+2] +include::traces-get-started.asciidoc[leveloffset=+3] -include::splunk-get-started.asciidoc[leveloffset=+2] +include::splunk-get-started.asciidoc[leveloffset=+3] -//Observability AI Assistant -include::observability-ai-assistant.asciidoc[leveloffset=+1] +// Group: Application and service monitoring +include::application-and-service-monitoring.asciidoc[leveloffset=+1] // APM -include::apm.asciidoc[leveloffset=+1] +include::apm.asciidoc[leveloffset=+2] -// Logs -include::logs-checklist.asciidoc[leveloffset=+1] +// Synthetics +include::synthetics-intro.asciidoc[leveloffset=+2] -include::logs-stream.asciidoc[leveloffset=+2] +include::synthetics-get-started.asciidoc[leveloffset=+3] +include::synthetics-get-started-project.asciidoc[leveloffset=+4] +include::synthetics-get-started-ui.asciidoc[leveloffset=+4] -include::logs-parse.asciidoc[leveloffset=+2] +include::synthetics-journeys.asciidoc[leveloffset=+3] +include::synthetics-create-test.asciidoc[leveloffset=+4] +include::synthetics-monitor-use.asciidoc[leveloffset=+4] +include::synthetics-recorder.asciidoc[leveloffset=+4] -include::logs-filter.asciidoc[leveloffset=+2] +include::synthetics-lightweight.asciidoc[leveloffset=+3] -include::application-logs.asciidoc[leveloffset=+2] +include::synthetics-manage-monitors.asciidoc[leveloffset=+3] -include::logs-plaintext.asciidoc[leveloffset=+3] +include::synthetics-params-secrets.asciidoc[leveloffset=+3] -include::logs-ecs-application.asciidoc[leveloffset=+3] +include::synthetics-analyze.asciidoc[leveloffset=+3] -include::logs-send-application.asciidoc[leveloffset=+3] +include::synthetics-private-location.asciidoc[leveloffset=+3] -include::monitor-logs.asciidoc[leveloffset=+2] +include::synthetics-command-reference.asciidoc[leveloffset=+3] -include::explore-logs.asciidoc[leveloffset=+3] +include::synthetics-configuration.asciidoc[leveloffset=+3] -include::tail-logs.asciidoc[leveloffset=+3] +include::synthetics-settings.asciidoc[leveloffset=+3] -include::categorize-logs.asciidoc[leveloffset=+3] +include::synthetics-roles.asciidoc[leveloffset=+3] +include::synthetics-role-setup.asciidoc[leveloffset=+4] +include::synthetics-role-write.asciidoc[leveloffset=+4] +include::synthetics-role-read.asciidoc[leveloffset=+4] -include::inspect-log-anomalies.asciidoc[leveloffset=+3] +include::synthetics-manage-retention.asciidoc[leveloffset=+3] -include::configure-logs-sources.asciidoc[leveloffset=+3] +include::synthetics-traffic-filters.asciidoc[leveloffset=+3] -include::logs-monitor-datasets.asciidoc[leveloffset=+2] +include::synthetics-migrate-integration.asciidoc[leveloffset=+3] -include::logs-add-service-name.asciidoc[leveloffset=+2] +include::synthetics-scale-and-architect.asciidoc[leveloffset=+3] -include::logs-index-template.asciidoc[leveloffset=+2] +include::synthetics-support-matrix.asciidoc[leveloffset=+3] -include::logs-troubleshooting.asciidoc[leveloffset=+2] +include::synthetics-security-encryption.asciidoc[leveloffset=+3] -// Infrastructure -include::monitor-infra/analyze-metrics.asciidoc[leveloffset=+1] +include::synthetics-troubleshooting.asciidoc[leveloffset=+3] -include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] +// Universal Profiling +include::universal-profiling.asciidoc[leveloffset=+2] -include::monitor-infra/explore-metrics.asciidoc[leveloffset=+2] +include::profiling-get-started.asciidoc[leveloffset=+3] -include::monitor-infra/analyze-hosts.asciidoc[leveloffset=+2] +include::profiling-manage-storage.asciidoc[leveloffset=+3] +include::profiling-index-lifecycle-management.asciidoc[leveloffset=+4] +include::profiling-probabilistic-profiling.asciidoc[leveloffset=+4] -include::monitor-infra/inspect-metric-anomalies.asciidoc[leveloffset=+2] +include::profiling-advanced-configuration.asciidoc[leveloffset=+3] +include::profiling-tag-data-query.asciidoc[leveloffset=+4] +include::profiling-add-symbols.asciidoc[leveloffset=+4] +include::profiling-use-a-proxy.asciidoc[leveloffset=+4] +include::profiling-no-kernel-version-check.asciidoc[leveloffset=+4] -include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+2] +include::profiling-upgrade.asciidoc[leveloffset=+3] -include::monitor-infra/metrics-reference.asciidoc[leveloffset=+2] +include::profiling-troubleshooting.asciidoc[leveloffset=+3] -// AWS monitoring -// Will eventually be replaced by cloud monitoring when other providers are covered -include::cloud-monitoring/aws/monitor-amazon-intro.asciidoc[leveloffset=+1] +include::profiling-self-managed.asciidoc[leveloffset=+3] +include::profiling-self-managed-ops.asciidoc[leveloffset=+4] +include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+4] -include::cloud-monitoring/azure/monitor-azure-intro.asciidoc[leveloffset=+1] +// User experience +include::user-experience.asciidoc[leveloffset=+2] -// Synthetics -include::synthetics-intro.asciidoc[leveloffset=+1] +// Uptime +include::uptime-intro.asciidoc[leveloffset=+2] -include::synthetics-get-started.asciidoc[leveloffset=+2] -include::synthetics-get-started-project.asciidoc[leveloffset=+3] -include::synthetics-get-started-ui.asciidoc[leveloffset=+3] +include::uptime-get-started-heartbeat.asciidoc[leveloffset=+3] -include::synthetics-journeys.asciidoc[leveloffset=+2] -include::synthetics-create-test.asciidoc[leveloffset=+3] -include::synthetics-monitor-use.asciidoc[leveloffset=+3] -include::synthetics-recorder.asciidoc[leveloffset=+3] +include::uptime-analyze.asciidoc[leveloffset=+3] +include::uptime-view-monitor-status.asciidoc[leveloffset=+4] +include::uptime-analyze-monitors.asciidoc[leveloffset=+4] +include::uptime-inspect-duration-anomalies.asciidoc[leveloffset=+4] -include::synthetics-lightweight.asciidoc[leveloffset=+2] +include::configure-uptime-settings.asciidoc[leveloffset=+3] -include::synthetics-manage-monitors.asciidoc[leveloffset=+2] +include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+3] -include::synthetics-params-secrets.asciidoc[leveloffset=+2] -include::synthetics-analyze.asciidoc[leveloffset=+2] +// Single: Ci-cd observability +include::ci-cd-observability.asciidoc[leveloffset=+1] -include::synthetics-private-location.asciidoc[leveloffset=+2] +// Group: Cloud monitoring +include::cloud-monitoring.asciidoc[leveloffset=+1] -include::synthetics-command-reference.asciidoc[leveloffset=+2] +// AWS +include::cloud-monitoring/aws/monitor-amazon-intro.asciidoc[leveloffset=+2] -include::synthetics-configuration.asciidoc[leveloffset=+2] +// Azure +include::cloud-monitoring/azure/monitor-azure-intro.asciidoc[leveloffset=+2] -include::synthetics-settings.asciidoc[leveloffset=+2] +// GCP +include::monitor-gcp.asciidoc[leveloffset=+2] -include::synthetics-roles.asciidoc[leveloffset=+2] -include::synthetics-role-setup.asciidoc[leveloffset=+3] -include::synthetics-role-write.asciidoc[leveloffset=+3] -include::synthetics-role-read.asciidoc[leveloffset=+3] +// Group: Hosts and infrastructure -include::synthetics-manage-retention.asciidoc[leveloffset=+2] +include::monitor-infra/analyze-metrics.asciidoc[leveloffset=+1] -include::synthetics-traffic-filters.asciidoc[leveloffset=+2] +include::logs-metrics-get-started.asciidoc[leveloffset=+2] -include::synthetics-migrate-integration.asciidoc[leveloffset=+2] +include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] -include::synthetics-scale-and-architect.asciidoc[leveloffset=+2] +include::monitor-infra/explore-metrics.asciidoc[leveloffset=+2] -include::synthetics-support-matrix.asciidoc[leveloffset=+2] +include::monitor-infra/analyze-hosts.asciidoc[leveloffset=+2] -include::synthetics-security-encryption.asciidoc[leveloffset=+2] +include::monitor-infra/inspect-metric-anomalies.asciidoc[leveloffset=+2] -include::synthetics-troubleshooting.asciidoc[leveloffset=+2] +include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+2] -// Uptime -include::uptime-intro.asciidoc[leveloffset=+1] +include::monitor-infra/metrics-reference.asciidoc[leveloffset=+2] -include::uptime-get-started-heartbeat.asciidoc[leveloffset=+2] +// Single: Kubernetes monitoring -include::uptime-analyze.asciidoc[leveloffset=+2] -include::uptime-view-monitor-status.asciidoc[leveloffset=+3] -include::uptime-analyze-monitors.asciidoc[leveloffset=+3] -include::uptime-inspect-duration-anomalies.asciidoc[leveloffset=+3] +include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+1] -include::configure-uptime-settings.asciidoc[leveloffset=+2] +// Group: Logs +include::logs-checklist.asciidoc[leveloffset=+1] -include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+2] +include::logs-stream.asciidoc[leveloffset=+2] -// User experience -include::user-experience.asciidoc[leveloffset=+1] +include::logs-parse.asciidoc[leveloffset=+2] -// Universal Profiling -include::universal-profiling.asciidoc[leveloffset=+1] +include::logs-filter.asciidoc[leveloffset=+2] -include::profiling-get-started.asciidoc[leveloffset=+2] +include::application-logs.asciidoc[leveloffset=+2] -include::profiling-manage-storage.asciidoc[leveloffset=+2] -include::profiling-index-lifecycle-management.asciidoc[leveloffset=+3] -include::profiling-probabilistic-profiling.asciidoc[leveloffset=+3] +include::logs-plaintext.asciidoc[leveloffset=+3] + +include::logs-ecs-application.asciidoc[leveloffset=+3] + +include::logs-send-application.asciidoc[leveloffset=+3] -include::profiling-advanced-configuration.asciidoc[leveloffset=+2] -include::profiling-tag-data-query.asciidoc[leveloffset=+3] -include::profiling-add-symbols.asciidoc[leveloffset=+3] -include::profiling-use-a-proxy.asciidoc[leveloffset=+3] -include::profiling-no-kernel-version-check.asciidoc[leveloffset=+3] +include::monitor-logs.asciidoc[leveloffset=+2] -include::profiling-upgrade.asciidoc[leveloffset=+2] +include::explore-logs.asciidoc[leveloffset=+3] -include::profiling-troubleshooting.asciidoc[leveloffset=+2] +include::tail-logs.asciidoc[leveloffset=+3] -include::profiling-self-managed.asciidoc[leveloffset=+2] -include::profiling-self-managed-ops.asciidoc[leveloffset=+3] -include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+3] +include::categorize-logs.asciidoc[leveloffset=+3] -// Alerting -include::create-alerts.asciidoc[leveloffset=+1] -include::aggregation-options.asciidoc[leveloffset=+2] -include::view-observability-alerts.asciidoc[leveloffset=+2] -include::triage-slo-burn-rate-breaches.asciidoc[leveloffset=+3] -include::triage-threshold-breaches.asciidoc[leveloffset=+3] +include::inspect-log-anomalies.asciidoc[leveloffset=+3] -//SLOs -include::slo-overview.asciidoc[leveloffset=+1] +include::configure-logs-sources.asciidoc[leveloffset=+3] -include::slo-privileges.asciidoc[leveloffset=+2] +include::logs-monitor-datasets.asciidoc[leveloffset=+2] -include::slo-create.asciidoc[leveloffset=+2] +include::logs-add-service-name.asciidoc[leveloffset=+2] -// Cases -include::create-cases.asciidoc[leveloffset=+1] +include::logs-index-template.asciidoc[leveloffset=+2] -include::grant-cases-access.asciidoc[leveloffset=+2] +include::logs-troubleshooting.asciidoc[leveloffset=+2] -include::manage-cases.asciidoc[leveloffset=+2] +// Group: Data insights +include::data-insights.asciidoc[leveloffset=+1] -include::manage-cases-settings.asciidoc[leveloffset=+2] +//Observability AI Assistant +include::observability-ai-assistant.asciidoc[leveloffset=+2] -include::ci-cd-observability.asciidoc[leveloffset=+1] +// Alerting +include::create-alerts.asciidoc[leveloffset=+2] +include::aggregation-options.asciidoc[leveloffset=+3] +include::view-observability-alerts.asciidoc[leveloffset=+3] +include::triage-slo-burn-rate-breaches.asciidoc[leveloffset=+4] +include::triage-threshold-breaches.asciidoc[leveloffset=+4] -// Troubleshooting -include::troubleshooting.asciidoc[leveloffset=+1] +// Cases +include::create-cases.asciidoc[leveloffset=+2] -include::exploratory-data-visualizations.asciidoc[leveloffset=+2] +include::grant-cases-access.asciidoc[leveloffset=+3] -include::inspect.asciidoc[leveloffset=+2] +include::manage-cases.asciidoc[leveloffset=+3] + +include::manage-cases-settings.asciidoc[leveloffset=+3] + +//SLOs +include::slo-overview.asciidoc[leveloffset=+2] + +include::slo-privileges.asciidoc[leveloffset=+3] + +include::slo-create.asciidoc[leveloffset=+3] // Reference include::reference.asciidoc[leveloffset=+1] @@ -216,7 +231,18 @@ include::fields-reference.asciidoc[leveloffset=+2] include::elastic-entity-model.asciidoc[leveloffset=+2] // Tutorials -include::tutorials.asciidoc[] +//include::tutorials.asciidoc[] + +// Find me a home +include::troubleshooting.asciidoc[leveloffset=+1] + +include::exploratory-data-visualizations.asciidoc[leveloffset=+2] + +include::inspect.asciidoc[leveloffset=+2] + +include::monitor-java-app.asciidoc[leveloffset=+2] + +include::monitor-nginx.asciidoc[leveloffset=+2] // add redirects file include::redirects.asciidoc[] diff --git a/docs/en/observability/logs-metrics-get-started.asciidoc b/docs/en/observability/logs-metrics-get-started.asciidoc index 06011b4303..b7ce18786a 100644 --- a/docs/en/observability/logs-metrics-get-started.asciidoc +++ b/docs/en/observability/logs-metrics-get-started.asciidoc @@ -2,7 +2,7 @@ = Get started with logs and metrics ++++ -Logs and metrics +Get started ++++ **** diff --git a/docs/en/observability/monitor-gcp.asciidoc b/docs/en/observability/monitor-gcp.asciidoc index b84c009bdc..8741d27620 100644 --- a/docs/en/observability/monitor-gcp.asciidoc +++ b/docs/en/observability/monitor-gcp.asciidoc @@ -1,7 +1,11 @@ [[monitor-gcp]] -== Monitor Google Cloud Platform += Monitor Google Cloud Platform -In this tutorial, you'll learn how to monitor your Google Cloud Platform (GCP) +++++ +GCP +++++ + +In this guide, you'll learn how to monitor your Google Cloud Platform (GCP) deployments using Elastic {observability}: Logs and Infrastructure metrics. [NOTE] @@ -13,7 +17,7 @@ link:gcp-dataflow.html[GCP Dataflow Templates]. ==== [discrete] -=== What you'll learn +== What you'll learn You'll learn how to: @@ -25,14 +29,14 @@ Google Cloud Platform module] and view those metrics in {kib}. Google Cloud module] and view those logs in {kib}. [discrete] -=== Before you begin +== Before you begin Create a deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. [discrete] -=== Step 1: Setup a Service Account +== Step 1: Setup a Service Account Google Cloud Platform implements https://cloud.google.com/compute/docs/access/service-accounts[service accounts] as a way to access APIs securely. To monitor GCP with @@ -91,7 +95,7 @@ After that, the credential file is downloaded. Keep this file in an accessible place to use later. [discrete] -=== Step 2: Install and configure {metricbeat} +== Step 2: Install and configure {metricbeat} [NOTE] ==== @@ -107,14 +111,14 @@ monitor metrics, and {filebeat} to monitor logs. You can run the agents on any machine. This tutorial uses a small GCP instance, e2-small (2 vCPUs, 2 GB memory), with an Ubuntu distribution. -:leveloffset: +3 +:leveloffset: +2 include::{observability-docs-root}/docs/en/shared/install-configure-metricbeat.asciidoc[] -:leveloffset: -3 +:leveloffset: -2 Now that the output is working, you are going to set up the input (GCP). [discrete] -=== Step 3: Configure {metricbeat} Google Cloud Platform module +== Step 3: Configure {metricbeat} Google Cloud Platform module To collect metrics from Google Cloud Platform, use the {metricbeat-ref}/metricbeat-module-gcp.html[Google Cloud Platform] @@ -183,7 +187,7 @@ dashboard. image:monitor-gcp-compute-overview-dashboard.png[{metricbeat} compute overview dashboard] [discrete] -=== Step 4: Install and configure {filebeat} +== Step 4: Install and configure {filebeat} Now that {metricbeat} is up and running, configure {filebeat} to collect Google Cloud logs. @@ -195,7 +199,7 @@ include::{observability-docs-root}/docs/en/shared/install-configure-filebeat.asc Now that the output is working, you are going to set up the input (GCP). [discrete] -=== Step 5: Configure {filebeat} Google Cloud module +== Step 5: Configure {filebeat} Google Cloud module To collect logs from Google Cloud Platform, use the {filebeat-ref}/filebeat-module-gcp.html[Google Cloud Platform] diff --git a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc b/docs/en/observability/monitor-infra/analyze-metrics.asciidoc index f7f8e69a44..b145841218 100644 --- a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc +++ b/docs/en/observability/monitor-infra/analyze-metrics.asciidoc @@ -1,5 +1,5 @@ [[analyze-metrics]] -= Infrastructure monitoring += Host and infrastructure monitoring The {infrastructure-app} in {kib} enables you to visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, diff --git a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc index 3cbc8295b6..9e79b46ff2 100644 --- a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc +++ b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc @@ -1,7 +1,7 @@ [[monitor-kubernetes]] = Monitor Kubernetes: Observe the health and performance of your Kubernetes deployments ++++ -Monitor Kubernetes +Kubernetes monitoring ++++ Applications running in a containerized environment like Kubernetes pose a diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index 6bf7b896f8..fc883c6d8d 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -51,4 +51,5 @@ Ready to dig into more features of Elastic Observability? See these guides: * {estc-welcome}/index.html[Starting with the {es} Platform and its Solutions] for new users * {cloud}/ec-cloud-ingest-data.html[Adding data to {es}] for other ways to ingest data -* <> for hands-on steps +//TODO: Remove this link +//* <> for hands-on steps diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc new file mode 100644 index 0000000000..7f25545091 --- /dev/null +++ b/docs/en/observability/start-here.asciidoc @@ -0,0 +1,4 @@ +[[observability-start-here]] += Start here + +Placeholder topic diff --git a/docs/en/observability/troubleshooting.asciidoc b/docs/en/observability/troubleshooting.asciidoc index dd06f1178b..8da08f70b1 100644 --- a/docs/en/observability/troubleshooting.asciidoc +++ b/docs/en/observability/troubleshooting.asciidoc @@ -1,5 +1,5 @@ [[troubleshooting]] -= Troubleshooting += Find me a home Learn how to troubleshoot common issues on your own or ask for help. diff --git a/docs/en/observability/tutorials.asciidoc b/docs/en/observability/tutorials.asciidoc index 407887332e..be72cdb110 100644 --- a/docs/en/observability/tutorials.asciidoc +++ b/docs/en/observability/tutorials.asciidoc @@ -1,6 +1,8 @@ [[observability-tutorials]] = Tutorials +//TODO: Delete this topic? + Using Elastic {observability}, learn how to analyze log data, monitor system and service metrics, instrument code and collect performance data, and monitor host availability and endpoints. @@ -14,17 +16,3 @@ instead. Not sure which agent to use? Refer to {fleet-guide}/beats-agent-comparison.html[{beats} and {agent} capabilities]. - -* <> - -* <> - -* <> - -include::monitor-gcp.asciidoc[] - -include::monitor-java-app.asciidoc[] - -include::monitor-nginx.asciidoc[leveloffset=+1] - -include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+1] \ No newline at end of file diff --git a/docs/en/observability/uptime-get-started-heartbeat.asciidoc b/docs/en/observability/uptime-get-started-heartbeat.asciidoc index d94a270c98..d9cb65aeb8 100644 --- a/docs/en/observability/uptime-get-started-heartbeat.asciidoc +++ b/docs/en/observability/uptime-get-started-heartbeat.asciidoc @@ -1,6 +1,10 @@ [[uptime-get-started]] = Get started with Uptime +++++ +Get started +++++ + IMPORTANT: *This approach can only be used to create lightweight monitors.* To create _browser_ monitors, use the <>. {heartbeat} is a lightweight daemon that you install on a remote server to periodically diff --git a/docs/en/observability/uptime-intro.asciidoc b/docs/en/observability/uptime-intro.asciidoc index 06e6f0e957..03e63fbd66 100644 --- a/docs/en/observability/uptime-intro.asciidoc +++ b/docs/en/observability/uptime-intro.asciidoc @@ -1,5 +1,5 @@ [[uptime-intro]] -= Uptime monitoring += Uptime monitoring (deprecated) [[uptime-monitors]] From de1cddf944f87c26154619b12dd453a9dc765310 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 13 Aug 2024 16:41:07 -0700 Subject: [PATCH 02/23] Try making the nav titles shorter --- .../application-and-service-monitoring.asciidoc | 5 +++++ docs/en/observability/ci-cd-observability.asciidoc | 4 +++- docs/en/observability/cloud-monitoring.asciidoc | 5 +++++ docs/en/observability/data-insights.asciidoc | 4 ---- docs/en/observability/incident-management.asciidoc | 5 +++++ docs/en/observability/index.asciidoc | 14 +++++++------- docs/en/observability/logs-checklist.asciidoc | 4 ++++ .../logs-metrics-get-started.asciidoc | 2 +- .../monitor-infra/analyze-metrics.asciidoc | 8 +++++++- docs/en/observability/monitor-java-app.asciidoc | 6 +++++- .../observability/monitor-k8s/monitor-k8s.asciidoc | 3 ++- docs/en/observability/monitor-nginx.asciidoc | 2 +- 12 files changed, 45 insertions(+), 17 deletions(-) delete mode 100644 docs/en/observability/data-insights.asciidoc create mode 100644 docs/en/observability/incident-management.asciidoc diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index 2a983e3ed4..b021269dbb 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -1,4 +1,9 @@ [[application-and-service-monitoring]] = Application and service monitoring +++++ +Applications and services +++++ + +//TODO: Add content here Placeholder topic diff --git a/docs/en/observability/ci-cd-observability.asciidoc b/docs/en/observability/ci-cd-observability.asciidoc index 06094f2eef..453594ec2f 100644 --- a/docs/en/observability/ci-cd-observability.asciidoc +++ b/docs/en/observability/ci-cd-observability.asciidoc @@ -2,7 +2,9 @@ = CI/CD monitoring :figure-caption!: -//TODO: Update ID and filename to match name change +++++ +CI/CD +++++ To help administrators monitor and troubleshoot their CI/CD platform and help developers increase the speed and reliability of their CI/CD pipelines, Elastic {observability} diff --git a/docs/en/observability/cloud-monitoring.asciidoc b/docs/en/observability/cloud-monitoring.asciidoc index 5eac02d684..a04c6c6c97 100644 --- a/docs/en/observability/cloud-monitoring.asciidoc +++ b/docs/en/observability/cloud-monitoring.asciidoc @@ -1,4 +1,9 @@ [[cloud-monitoring]] = Cloud monitoring +++++ +Cloud +++++ + +//TODO: Add content here Placeholder topic diff --git a/docs/en/observability/data-insights.asciidoc b/docs/en/observability/data-insights.asciidoc deleted file mode 100644 index 4907da0065..0000000000 --- a/docs/en/observability/data-insights.asciidoc +++ /dev/null @@ -1,4 +0,0 @@ -[[data-insights]] -= Data insights - -Placeholder topic diff --git a/docs/en/observability/incident-management.asciidoc b/docs/en/observability/incident-management.asciidoc new file mode 100644 index 0000000000..86b4352eb6 --- /dev/null +++ b/docs/en/observability/incident-management.asciidoc @@ -0,0 +1,5 @@ +[[incident-management]] += Incident management + +//TODO: Add content here +Placeholder topic diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index ff229b4fe0..dca24eca0d 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -19,6 +19,10 @@ include::whats-new.asciidoc[leveloffset=+2] // Get started with Elastic Observability include::observability-get-started.asciidoc[leveloffset=+2] +include::logs-metrics-get-started.asciidoc[leveloffset=+3] + +include::monitor-nginx.asciidoc[leveloffset=3] + include::traces-get-started.asciidoc[leveloffset=+3] include::splunk-get-started.asciidoc[leveloffset=+3] @@ -29,6 +33,8 @@ include::application-and-service-monitoring.asciidoc[leveloffset=+1] // APM include::apm.asciidoc[leveloffset=+2] +include::monitor-java-app.asciidoc[leveloffset=+1] + // Synthetics include::synthetics-intro.asciidoc[leveloffset=+2] @@ -136,8 +142,6 @@ include::monitor-gcp.asciidoc[leveloffset=+2] include::monitor-infra/analyze-metrics.asciidoc[leveloffset=+1] -include::logs-metrics-get-started.asciidoc[leveloffset=+2] - include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] include::monitor-infra/explore-metrics.asciidoc[leveloffset=+2] @@ -192,7 +196,7 @@ include::logs-index-template.asciidoc[leveloffset=+2] include::logs-troubleshooting.asciidoc[leveloffset=+2] // Group: Data insights -include::data-insights.asciidoc[leveloffset=+1] +include::incident-management.asciidoc[leveloffset=+1] //Observability AI Assistant include::observability-ai-assistant.asciidoc[leveloffset=+2] @@ -240,9 +244,5 @@ include::exploratory-data-visualizations.asciidoc[leveloffset=+2] include::inspect.asciidoc[leveloffset=+2] -include::monitor-java-app.asciidoc[leveloffset=+2] - -include::monitor-nginx.asciidoc[leveloffset=+2] - // add redirects file include::redirects.asciidoc[] diff --git a/docs/en/observability/logs-checklist.asciidoc b/docs/en/observability/logs-checklist.asciidoc index f4d4f3310b..715870bb68 100644 --- a/docs/en/observability/logs-checklist.asciidoc +++ b/docs/en/observability/logs-checklist.asciidoc @@ -1,6 +1,10 @@ [[logs-checklist]] = Log monitoring +++++ +Logs +++++ + Logs are an important tool for ensuring the performance and reliability of your applications and infrastructure. They provide important information for debugging, analyzing performance, and managing compliance. On this page, you'll find resources for sending log data to {es}, configuring your logs, and analyzing your logs. diff --git a/docs/en/observability/logs-metrics-get-started.asciidoc b/docs/en/observability/logs-metrics-get-started.asciidoc index b7ce18786a..06011b4303 100644 --- a/docs/en/observability/logs-metrics-get-started.asciidoc +++ b/docs/en/observability/logs-metrics-get-started.asciidoc @@ -2,7 +2,7 @@ = Get started with logs and metrics ++++ -Get started +Logs and metrics ++++ **** diff --git a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc b/docs/en/observability/monitor-infra/analyze-metrics.asciidoc index b145841218..0582e3b841 100644 --- a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc +++ b/docs/en/observability/monitor-infra/analyze-metrics.asciidoc @@ -1,5 +1,11 @@ [[analyze-metrics]] -= Host and infrastructure monitoring += Infrastructure and host monitoring + +++++ +Infrastructure and hosts +++++ + +//TODO: Update ID and set up redirect The {infrastructure-app} in {kib} enables you to visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, diff --git a/docs/en/observability/monitor-java-app.asciidoc b/docs/en/observability/monitor-java-app.asciidoc index 62e36349c7..d912e71c6a 100644 --- a/docs/en/observability/monitor-java-app.asciidoc +++ b/docs/en/observability/monitor-java-app.asciidoc @@ -1,7 +1,11 @@ [[monitor-java-app]] == Monitor a Java application -In this tutorial, you'll learn how to monitor a Java application using Elastic +++++ +Java application monitoring +++++ + +In this guide, you'll learn how to monitor a Java application using Elastic {observability}: Logs, Infrastructure metrics, APM, and Uptime. [discrete] diff --git a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc index 9e79b46ff2..2f9ea18ac9 100644 --- a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc +++ b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc @@ -1,7 +1,8 @@ [[monitor-kubernetes]] = Monitor Kubernetes: Observe the health and performance of your Kubernetes deployments + ++++ -Kubernetes monitoring +Kubernetes ++++ Applications running in a containerized environment like Kubernetes pose a diff --git a/docs/en/observability/monitor-nginx.asciidoc b/docs/en/observability/monitor-nginx.asciidoc index e4d7a4dedc..8b88a3286d 100644 --- a/docs/en/observability/monitor-nginx.asciidoc +++ b/docs/en/observability/monitor-nginx.asciidoc @@ -1,7 +1,7 @@ [[monitor-nginx]] = Monitor nginx: Observe the logs and metrics of your nginx instances ++++ -Monitor nginx +Nginx ++++ **** From 89247f15f3deaa343bb45701806ef1cc769cb5c2 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 19 Aug 2024 16:04:18 -0700 Subject: [PATCH 03/23] Align TOC with latest outline --- docs/en/observability/apm.asciidoc | 4 ++++ docs/en/observability/index.asciidoc | 21 +++++++++---------- docs/en/observability/start-here.asciidoc | 2 ++ .../observability/synthetics-intro.asciidoc | 4 ++++ .../en/observability/troubleshooting.asciidoc | 2 +- .../en/observability/user-experience.asciidoc | 2 ++ 6 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs/en/observability/apm.asciidoc b/docs/en/observability/apm.asciidoc index 7c9c8f9b7a..24c07c6e84 100644 --- a/docs/en/observability/apm.asciidoc +++ b/docs/en/observability/apm.asciidoc @@ -1,6 +1,10 @@ [[apm]] = Application performance monitoring (APM) +++++ +Application performance (APM) +++++ + // OTHER ATTRS // TODO: Check that these are still relevant :no_kibana: diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index dca24eca0d..e56c50659b 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -122,6 +122,12 @@ include::configure-uptime-settings.asciidoc[leveloffset=+3] include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+3] +// Troubleshooting? +include::troubleshooting.asciidoc[leveloffset=+2] + +include::exploratory-data-visualizations.asciidoc[leveloffset=+3] + +include::inspect.asciidoc[leveloffset=+3] // Single: Ci-cd observability include::ci-cd-observability.asciidoc[leveloffset=+1] @@ -195,12 +201,9 @@ include::logs-index-template.asciidoc[leveloffset=+2] include::logs-troubleshooting.asciidoc[leveloffset=+2] -// Group: Data insights +// Group: Incident management include::incident-management.asciidoc[leveloffset=+1] -//Observability AI Assistant -include::observability-ai-assistant.asciidoc[leveloffset=+2] - // Alerting include::create-alerts.asciidoc[leveloffset=+2] include::aggregation-options.asciidoc[leveloffset=+3] @@ -224,6 +227,9 @@ include::slo-privileges.asciidoc[leveloffset=+3] include::slo-create.asciidoc[leveloffset=+3] +//Observability AI Assistant +include::observability-ai-assistant.asciidoc[leveloffset=+1] + // Reference include::reference.asciidoc[leveloffset=+1] @@ -237,12 +243,5 @@ include::elastic-entity-model.asciidoc[leveloffset=+2] // Tutorials //include::tutorials.asciidoc[] -// Find me a home -include::troubleshooting.asciidoc[leveloffset=+1] - -include::exploratory-data-visualizations.asciidoc[leveloffset=+2] - -include::inspect.asciidoc[leveloffset=+2] - // add redirects file include::redirects.asciidoc[] diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc index 7f25545091..3ff49c7df8 100644 --- a/docs/en/observability/start-here.asciidoc +++ b/docs/en/observability/start-here.asciidoc @@ -1,4 +1,6 @@ [[observability-start-here]] = Start here +//TODO: Add description + Placeholder topic diff --git a/docs/en/observability/synthetics-intro.asciidoc b/docs/en/observability/synthetics-intro.asciidoc index 22dd4cbaa7..13080fbd32 100644 --- a/docs/en/observability/synthetics-intro.asciidoc +++ b/docs/en/observability/synthetics-intro.asciidoc @@ -1,6 +1,10 @@ [[monitor-uptime-synthetics]] = Synthetic monitoring +++++ +Synthetics +++++ + [NOTE] ==== The {synthetics-app} is for viewing result data from monitors created and managed diff --git a/docs/en/observability/troubleshooting.asciidoc b/docs/en/observability/troubleshooting.asciidoc index 8da08f70b1..dd06f1178b 100644 --- a/docs/en/observability/troubleshooting.asciidoc +++ b/docs/en/observability/troubleshooting.asciidoc @@ -1,5 +1,5 @@ [[troubleshooting]] -= Find me a home += Troubleshooting Learn how to troubleshoot common issues on your own or ask for help. diff --git a/docs/en/observability/user-experience.asciidoc b/docs/en/observability/user-experience.asciidoc index 124315d033..cf0c1983f4 100644 --- a/docs/en/observability/user-experience.asciidoc +++ b/docs/en/observability/user-experience.asciidoc @@ -3,6 +3,8 @@ [[user-experience]] = Real user monitoring ({user-experience}) +//TODO: Decide whether this should say "User experience" or "Real user monitoring" + ++++ Real user monitoring ++++ From 45527e025dd590f448cacda4d8079cda5d995679 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 19 Aug 2024 16:31:04 -0700 Subject: [PATCH 04/23] Fix link text and rename analyze-metrics file --- docs/en/observability/index.asciidoc | 4 ++-- docs/en/observability/logs-checklist.asciidoc | 2 +- docs/en/observability/logs-metrics-get-started.asciidoc | 2 +- ....asciidoc => monitor-infrastructure-and-hosts.asciidoc} | 2 +- docs/en/observability/redirects.asciidoc | 7 ++++++- docs/en/observability/uptime-intro.asciidoc | 2 +- 6 files changed, 12 insertions(+), 7 deletions(-) rename docs/en/observability/monitor-infra/{analyze-metrics.asciidoc => monitor-infrastructure-and-hosts.asciidoc} (97%) diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index e56c50659b..86b17db6f0 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -144,9 +144,9 @@ include::cloud-monitoring/azure/monitor-azure-intro.asciidoc[leveloffset=+2] // GCP include::monitor-gcp.asciidoc[leveloffset=+2] -// Group: Hosts and infrastructure +// Group: Infrastructure and hosts -include::monitor-infra/analyze-metrics.asciidoc[leveloffset=+1] +include::monitor-infra/monitor-infrastructure-and-hosts.asciidoc[leveloffset=+1] include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] diff --git a/docs/en/observability/logs-checklist.asciidoc b/docs/en/observability/logs-checklist.asciidoc index 715870bb68..a33de68310 100644 --- a/docs/en/observability/logs-checklist.asciidoc +++ b/docs/en/observability/logs-checklist.asciidoc @@ -104,7 +104,7 @@ The following resources provide information on viewing and monitoring your logs: == Monitor Kubernetes logs You can use the {agent} with the Kubernetes integration to collect and parse Kubernetes logs. -Refer to <>. +Refer to <>. [discrete] [[logs-app-checklist]] diff --git a/docs/en/observability/logs-metrics-get-started.asciidoc b/docs/en/observability/logs-metrics-get-started.asciidoc index 06011b4303..dd220ee75d 100644 --- a/docs/en/observability/logs-metrics-get-started.asciidoc +++ b/docs/en/observability/logs-metrics-get-started.asciidoc @@ -200,7 +200,7 @@ to the data stream. == What's next? * Monitor the status and response times of applications and services in real time using the {uptime-app}. -You can monitor the availability of network endpoints via HTTP, TCP, ICMP or Browser monitors. Get started in <>. +You can monitor the availability of network endpoints via HTTP, TCP, ICMP or Browser monitors. Get started in <>. * Now that data is streaming into the {stack}, take your investigation to a deeper level! Use https://www.elastic.co/observability[Elastic {observability}] diff --git a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc similarity index 97% rename from docs/en/observability/monitor-infra/analyze-metrics.asciidoc rename to docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc index 0582e3b841..0ce5a7ce0f 100644 --- a/docs/en/observability/monitor-infra/analyze-metrics.asciidoc +++ b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc @@ -1,4 +1,4 @@ -[[analyze-metrics]] +[[monitor-infrastructure-and-hosts]] = Infrastructure and host monitoring ++++ diff --git a/docs/en/observability/redirects.asciidoc b/docs/en/observability/redirects.asciidoc index 7f371de972..30b376b97a 100644 --- a/docs/en/observability/redirects.asciidoc +++ b/docs/en/observability/redirects.asciidoc @@ -3,6 +3,11 @@ The following pages have moved or been deleted. +[role="exclude" id="analyze-metrics"] +=== Infrastructure monitoring + +Refer to <>. + //Start links removed in Spacetime revamp (https://github.com/elastic/observability-docs/pull/2880) [role="exclude",id="spin-up-stack"] @@ -154,7 +159,7 @@ Refer to <>. [role="exclude" id="logs-observability-overview"] === Logs Overview -For an overview of ingesting and viewing logs in {observability}, refer to <>. +For an overview of ingesting and viewing logs in {observability}, refer to <>. [role="exclude",id="apm-mutating-admission-webhook"] ==== APM Attacher diff --git a/docs/en/observability/uptime-intro.asciidoc b/docs/en/observability/uptime-intro.asciidoc index 03e63fbd66..3c864dc9bc 100644 --- a/docs/en/observability/uptime-intro.asciidoc +++ b/docs/en/observability/uptime-intro.asciidoc @@ -43,7 +43,7 @@ to make sure the service is accessible and running. [role="screenshot"] image::images/uptime-app.png[{uptime-app} in {kib}] -To set up your first monitor, refer to <>. +To set up your first monitor, refer to <>. [discrete] [[view-certificate-status]] From 6fd7dfd3b766b61dfa40ecfe6e8aa0bebe09df12 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 19 Aug 2024 17:17:17 -0700 Subject: [PATCH 05/23] Add redirect page for observability tutorials --- docs/en/observability/redirects.asciidoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/en/observability/redirects.asciidoc b/docs/en/observability/redirects.asciidoc index 30b376b97a..ee9584176c 100644 --- a/docs/en/observability/redirects.asciidoc +++ b/docs/en/observability/redirects.asciidoc @@ -3,6 +3,20 @@ The following pages have moved or been deleted. +[role="exclude",id="observability-tutorials"] +=== Tutorials + +This page no longer exists in the Observability Guide. +The content in this section has been reworked and moved to other sections of the guide. +Refer to the following resources to learn how to monitor observability data: + +* <> +* <> +* <> +* <> +* <> +* <> + [role="exclude" id="analyze-metrics"] === Infrastructure monitoring From c80b2c8a1b5892820e4cf84ceb1621126ab9b835 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 20 Aug 2024 11:39:14 -0700 Subject: [PATCH 06/23] Add content to start here topic --- docs/en/observability/start-here.asciidoc | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc index 3ff49c7df8..ef7ea81cb4 100644 --- a/docs/en/observability/start-here.asciidoc +++ b/docs/en/observability/start-here.asciidoc @@ -1,6 +1,19 @@ [[observability-start-here]] = Start here -//TODO: Add description +New to Elastic {observability}? Explore the topics in this section to learn more about our observability features and how to get started. -Placeholder topic +[cols="1,1"] +|=== +|<> +|Introduces core Observability features you can use to get value from your Observability data. + +|<> +|Provides highlights of what's new and improved for this version of Elastic Observability. + +|Quick starts +|Walk you through the fast path to ingest and visualize your Observability data. + +|<> +|Show how to spin up a deployment of our hosted Elasticsearch Service and use Elastic Observability. +|=== From fe338df48e1bd687e2b251a219aa6f017ef2b979 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 20 Aug 2024 12:17:36 -0700 Subject: [PATCH 07/23] Add content to overview topic about monitoring applications and services --- ...pplication-and-service-monitoring.asciidoc | 27 +++++++++++++++++-- docs/en/observability/start-here.asciidoc | 10 +++---- 2 files changed, 30 insertions(+), 7 deletions(-) diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index b021269dbb..dda8310f2d 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -5,5 +5,28 @@ Applications and services ++++ -//TODO: Add content here -Placeholder topic +Explore the topics in this section to learn how to monitor software services and applications to catch problems in real time. + +[cols="1,1"] +|=== +|<> +|Monitor software services and applications in real time, by collecting detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more. + +|<> +|Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime. + +|<> +|Monitor the availability of network endpoints and services. + +|<> +|Profile all the code running on a machine, including application code, kernel, and third-party libraries. + +|<> +|Quantify and analyze the perceived performance of your web application using real-world user experiences. + +|<> +|Periodically check the status of your services and applications. + +|<> +|Troubleshoot issues across Observability apps: select and filter result data in any dimension, look for the cause or impact of performance problems, and view information about all requests that were made to collect the data displayed on the current page. +|=== \ No newline at end of file diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc index ef7ea81cb4..93ef9463da 100644 --- a/docs/en/observability/start-here.asciidoc +++ b/docs/en/observability/start-here.asciidoc @@ -1,19 +1,19 @@ [[observability-start-here]] = Start here -New to Elastic {observability}? Explore the topics in this section to learn more about our observability features and how to get started. +New to Elastic {observability}? Explore the topics in this section to learn more about our {observability} features and how to get started. [cols="1,1"] |=== |<> -|Introduces core Observability features you can use to get value from your Observability data. +|Learn about core features you can use to get value from your {observability} data. |<> -|Provides highlights of what's new and improved for this version of Elastic Observability. +|Learn about what's new and improved for this version of Elastic {observability}. |Quick starts -|Walk you through the fast path to ingest and visualize your Observability data. +|Learn about the fast path to ingest and visualize your {observability} data. |<> -|Show how to spin up a deployment of our hosted Elasticsearch Service and use Elastic Observability. +|Learn how to spin up a deployment of our hosted Elasticsearch Service and use Elastic {observability}. |=== From c6aa5717b8b72343b94931d8d8e597278c59b235 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 20 Aug 2024 16:23:42 -0700 Subject: [PATCH 08/23] Add content to overview topic about incident management --- ...pplication-and-service-monitoring.asciidoc | 2 +- .../observability/cloud-monitoring.asciidoc | 20 +++++++++++++++++-- .../observability/fields-reference.asciidoc | 7 +++++++ .../incident-management.asciidoc | 18 +++++++++++++++-- 4 files changed, 42 insertions(+), 5 deletions(-) diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index dda8310f2d..260fc8f73a 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -5,7 +5,7 @@ Applications and services ++++ -Explore the topics in this section to learn how to monitor software services and applications to catch problems in real time. +Explore the topics in this section to learn how to observe and monitor software applications and services running in your environment. [cols="1,1"] |=== diff --git a/docs/en/observability/cloud-monitoring.asciidoc b/docs/en/observability/cloud-monitoring.asciidoc index a04c6c6c97..d2809d1447 100644 --- a/docs/en/observability/cloud-monitoring.asciidoc +++ b/docs/en/observability/cloud-monitoring.asciidoc @@ -5,5 +5,21 @@ Cloud ++++ -//TODO: Add content here -Placeholder topic +Explore the topics in this section to learn how to observe and monitor a broad range of resources and applications running in your cloud ecosystem. + +//TODO: This topic needs input from Arianna and PMs to figure out what to highlight given our current spotty coverage in the docs. + +[cols="1,1"] +|=== +|<> +|Monitor AWS services and resources, including EC2, Kinesis data streams, S3 buckets, SQS, VPC Flow Logs, CloudTrail logs, network firewall logs, WAF logs, and CloudWatch logs. + +|<> +|Get visibility into your key Azure services including through secure native integration within the Azure console. + +|<> +|Track performance of your Google Cloud services, including through agentless data ingestion with Google Pub/Sub. +|=== + + + diff --git a/docs/en/observability/fields-reference.asciidoc b/docs/en/observability/fields-reference.asciidoc index edbb12ef2e..9ef747cbab 100644 --- a/docs/en/observability/fields-reference.asciidoc +++ b/docs/en/observability/fields-reference.asciidoc @@ -6,12 +6,19 @@ This section lists Elastic Common Schema (ECS) fields the Logs and Infrastructur ECS is an open source specification that defines a standard set of fields to use when storing event data in {es}, such as logs and metrics. +//TODO: This topic should mention integrations and Elastic Agent, too. + Beat modules (for example, {filebeat-ref}/filebeat-modules.html[{filebeat} modules]) are ECS-compliant, so manual field mapping is not required, and all data is populated automatically in the Logs and Infrastructure apps. If you cannot use {beats}, map your data to {ecs-ref}[ECS fields] (see {ecs-ref}/ecs-converting.html[how to map data to ECS]). You can also try using the experimental https://github.com/elastic/ecs-mapper[ECS Mapper] tool. +This reference covers: + +* <> +* <> + include::logs-app-fields.asciidoc[leveloffset=+1] include::metrics-app-fields.asciidoc[leveloffset=+1] \ No newline at end of file diff --git a/docs/en/observability/incident-management.asciidoc b/docs/en/observability/incident-management.asciidoc index 86b4352eb6..a60beb8c66 100644 --- a/docs/en/observability/incident-management.asciidoc +++ b/docs/en/observability/incident-management.asciidoc @@ -1,5 +1,19 @@ [[incident-management]] = Incident management -//TODO: Add content here -Placeholder topic +Explore the topics in this section to learn how to respond to incidents detected in your {observability} data. + + +[cols="1,1"] +|=== +|<> +|Trigger alerts when incidents occur, and use built-in connectors to send the alerts to email, slack, or other third-party systems, such as your external incident management application. + +|<> +|Collect and share information about {observability} issues by opening cases and optionally sending them to your external incident management application. + +|<> +|Set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics. +|=== + + From 2aec89f0879a2329681bdd06451bbf03a3f1e00f Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 20 Aug 2024 16:49:23 -0700 Subject: [PATCH 09/23] Remove old tutorial container topic --- docs/en/observability/index.asciidoc | 3 --- docs/en/observability/tutorials.asciidoc | 18 ------------------ 2 files changed, 21 deletions(-) delete mode 100644 docs/en/observability/tutorials.asciidoc diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index 86b17db6f0..a5f005802e 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -240,8 +240,5 @@ include::fields-reference.asciidoc[leveloffset=+2] include::elastic-entity-model.asciidoc[leveloffset=+2] -// Tutorials -//include::tutorials.asciidoc[] - // add redirects file include::redirects.asciidoc[] diff --git a/docs/en/observability/tutorials.asciidoc b/docs/en/observability/tutorials.asciidoc deleted file mode 100644 index be72cdb110..0000000000 --- a/docs/en/observability/tutorials.asciidoc +++ /dev/null @@ -1,18 +0,0 @@ -[[observability-tutorials]] -= Tutorials - -//TODO: Delete this topic? - -Using Elastic {observability}, learn how to analyze log data, monitor system and -service metrics, instrument code and collect performance data, and monitor host -availability and endpoints. - -The {stack} provides a variety of ways to add monitoring data to {es}. -The tutorials in this section focus on {agent} and {beats}. - -It's recommended that you use {agent}, when possible, to achieve your monitoring -goals. However, if {agent} doesn't work for your use case, you can use {beats} -instead. - -Not sure which agent to use? Refer to -{fleet-guide}/beats-agent-comparison.html[{beats} and {agent} capabilities]. From 2701742dea32bfea6f904608b69b0ea177df6ae5 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Thu, 22 Aug 2024 17:33:01 -0700 Subject: [PATCH 10/23] Apply changes from colleenmcginnis --- docs/en/observability/apm.asciidoc | 4 ---- .../application-and-service-monitoring.asciidoc | 6 +++--- docs/en/observability/ci-cd-observability.asciidoc | 2 +- docs/en/observability/index.asciidoc | 8 +++++--- docs/en/observability/monitor-gcp.asciidoc | 2 +- docs/en/observability/monitor-java-app.asciidoc | 6 +----- docs/en/observability/synthetics-intro.asciidoc | 4 ---- 7 files changed, 11 insertions(+), 21 deletions(-) diff --git a/docs/en/observability/apm.asciidoc b/docs/en/observability/apm.asciidoc index 24c07c6e84..7c9c8f9b7a 100644 --- a/docs/en/observability/apm.asciidoc +++ b/docs/en/observability/apm.asciidoc @@ -1,10 +1,6 @@ [[apm]] = Application performance monitoring (APM) -++++ -Application performance (APM) -++++ - // OTHER ATTRS // TODO: Check that these are still relevant :no_kibana: diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index 260fc8f73a..c32b00f694 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -12,9 +12,6 @@ Explore the topics in this section to learn how to observe and monitor software |<> |Monitor software services and applications in real time, by collecting detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more. -|<> -|Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime. - |<> |Monitor the availability of network endpoints and services. @@ -27,6 +24,9 @@ Explore the topics in this section to learn how to observe and monitor software |<> |Periodically check the status of your services and applications. +|<> +|Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime. + |<> |Troubleshoot issues across Observability apps: select and filter result data in any dimension, look for the cause or impact of performance problems, and view information about all requests that were made to collect the data displayed on the current page. |=== \ No newline at end of file diff --git a/docs/en/observability/ci-cd-observability.asciidoc b/docs/en/observability/ci-cd-observability.asciidoc index 453594ec2f..bf6769ead1 100644 --- a/docs/en/observability/ci-cd-observability.asciidoc +++ b/docs/en/observability/ci-cd-observability.asciidoc @@ -1,5 +1,5 @@ [[ci-cd-observability]] -= CI/CD monitoring += Continuous Integration and Continuous Delivery (CI/CD) monitoring :figure-caption!: ++++ diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index a5f005802e..e41c84a81c 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -33,8 +33,6 @@ include::application-and-service-monitoring.asciidoc[leveloffset=+1] // APM include::apm.asciidoc[leveloffset=+2] -include::monitor-java-app.asciidoc[leveloffset=+1] - // Synthetics include::synthetics-intro.asciidoc[leveloffset=+2] @@ -122,7 +120,11 @@ include::configure-uptime-settings.asciidoc[leveloffset=+3] include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+3] -// Troubleshooting? +// Tutorials +include::monitor-java-app.asciidoc[leveloffset=+1] + + +// Troubleshooting include::troubleshooting.asciidoc[leveloffset=+2] include::exploratory-data-visualizations.asciidoc[leveloffset=+3] diff --git a/docs/en/observability/monitor-gcp.asciidoc b/docs/en/observability/monitor-gcp.asciidoc index 8741d27620..654619287a 100644 --- a/docs/en/observability/monitor-gcp.asciidoc +++ b/docs/en/observability/monitor-gcp.asciidoc @@ -1,5 +1,5 @@ [[monitor-gcp]] -= Monitor Google Cloud Platform += Monitor Google Cloud Platform (GCP) ++++ GCP diff --git a/docs/en/observability/monitor-java-app.asciidoc b/docs/en/observability/monitor-java-app.asciidoc index d912e71c6a..a1e22d1c63 100644 --- a/docs/en/observability/monitor-java-app.asciidoc +++ b/docs/en/observability/monitor-java-app.asciidoc @@ -1,9 +1,5 @@ [[monitor-java-app]] -== Monitor a Java application - -++++ -Java application monitoring -++++ +== Tutorial: Monitor a Java application In this guide, you'll learn how to monitor a Java application using Elastic {observability}: Logs, Infrastructure metrics, APM, and Uptime. diff --git a/docs/en/observability/synthetics-intro.asciidoc b/docs/en/observability/synthetics-intro.asciidoc index 13080fbd32..22dd4cbaa7 100644 --- a/docs/en/observability/synthetics-intro.asciidoc +++ b/docs/en/observability/synthetics-intro.asciidoc @@ -1,10 +1,6 @@ [[monitor-uptime-synthetics]] = Synthetic monitoring -++++ -Synthetics -++++ - [NOTE] ==== The {synthetics-app} is for viewing result data from monitors created and managed From aafd6f1948f618bcdfe237990604547642c1bcd6 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Thu, 22 Aug 2024 17:55:06 -0700 Subject: [PATCH 11/23] Apply feedback from alaudazzi --- .../aws/monitor-amazon-ec2.asciidoc | 8 +++---- .../aws/monitor-amazon-kinesis.asciidoc | 2 +- .../aws/monitor-amazon-s3.asciidoc | 4 ++-- .../aws/monitor-amazon-sqs.asciidoc | 2 +- .../monitor-aws-cloudtrail-firehose.asciidoc | 12 +++++----- .../monitor-aws-cloudwatch-firehose.asciidoc | 24 +++++++++---------- .../monitor-aws-firewall-firehose.asciidoc | 10 ++++---- .../aws/monitor-aws-vpc-flow-logs.asciidoc | 2 +- .../aws/monitor-aws-waf-firehose.asciidoc | 14 +++++------ docs/en/observability/start-here.asciidoc | 2 +- 10 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-ec2.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-ec2.asciidoc index d5017a1bd0..efc82a5d56 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-ec2.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-ec2.asciidoc @@ -2,7 +2,7 @@ = Monitor Amazon Cloud Compute (EC2) ++++ -Monitor EC2 +EC2 ++++ https://aws.amazon.com/ec2[Elastic Compute Cloud (Amazon EC2)] enables @@ -115,7 +115,7 @@ workloads. A burstable performance instance configured as unlimited can sustain high CPU utilization for any period of time whenever required. T4g, T3a, and T3 instances launch as unlimited by default. If the average CPU usage over a 24-hour period -exceeds the baseline, you incur charges for surplus credits. +exceeds the baseline, you incur charges for surplus credits. + The CPU surplus credit balance metric tracks the accumulated balance. The CPU surplus credit charged measures extra credits that will result in additional @@ -227,7 +227,7 @@ of related EC2 instances. + The Elastic EC2 integration comes with a default dashboard that shows key metrics like status check, CPU utilization, Disk I/O, and network throughput. It -also provides filtering for region, availability zone, and machine type. +also provides filtering for region, availability zone, and machine type. `aws.ec2.metrics.StatusCheckFailed_Instance.avg`:: This check monitors the software and network configuration of the instance. @@ -236,7 +236,7 @@ networking or startup configuration, exhausted memory, corrupted file system, incompatible kernel, and so on. When an instance status check fails, you typically must address the problem yourself. You may need to reboot the instance or make instance configuration changes. To troubleshoot instances with failed -status checks, refer to the +status checks, refer to the https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html[Amazon EC2 documentation]. + This check returns 0 (passed) if an instance passes the system status check or 1 diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-kinesis.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-kinesis.asciidoc index 5b2529ac4f..7bc9dad8a8 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-kinesis.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-kinesis.asciidoc @@ -2,7 +2,7 @@ = Monitor Amazon Kinesis data streams ++++ -Monitor Kinesis data streams +Kinesis data streams ++++ https://aws.amazon.com/kinesis/data-streams/[Amazon Kinesis Data Streams] diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-s3.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-s3.asciidoc index 5b5c88f0d5..24bc3bcdf4 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-s3.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-s3.asciidoc @@ -2,7 +2,7 @@ = Monitor Amazon Simple Storage Service (S3) ++++ -Monitor S3 +S3 ++++ https://aws.amazon.com/s3/[Amazon Simple Storage Service (S3)] @@ -25,7 +25,7 @@ storage. These metrics are reported once per day by default and are provided to AWS customers at no additional cost. * Request metrics. Use these metrics to quickly identify and act on operational issues. These request metrics are available at one-minute intervals -after some latency for processing, and they are not enabled by default. +after some latency for processing, and they are not enabled by default. [discrete] [[get-started-s3]] diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-sqs.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-sqs.asciidoc index 5f1da22688..40076092b7 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-amazon-sqs.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-amazon-sqs.asciidoc @@ -2,7 +2,7 @@ = Monitor Amazon Simple Queue Service (SQS) ++++ -Monitor SQS +SQS ++++ https://aws.amazon.com/sqs/[Amazon Simple Queue Service (SQS)] is a message diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudtrail-firehose.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudtrail-firehose.asciidoc index 27fc4b1965..7f5921b02b 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudtrail-firehose.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudtrail-firehose.asciidoc @@ -2,7 +2,7 @@ = Monitor CloudTrail logs ++++ -Monitor CloudTrail logs +CloudTrail logs ++++ In this section, you'll learn how to monitor and analyze the CloudTrail logs you send to Elastic with Amazon Data Firehose. You will go through the following steps: @@ -41,7 +41,7 @@ image::firehose-cloudtrail-cloudwatch.png[Cloudtrail to CloudWatch] To export CloudTrail logs to CloudWatch, you must set up a *trail* through the following steps: -. Go to the https://console.aws.amazon.com/[AWS console] and navigate to CloudTrail. +. Go to the https://console.aws.amazon.com/[AWS console] and navigate to CloudTrail. . Click *Create trail* and configure the general details on the *Choose trail attributes* panel, like: + @@ -91,13 +91,13 @@ For more information on how to set up a Amazon Data Firehose delivery stream to - Elastic endpoint URL - API key - Content encoding: gzip -- Retry duration: 60 (default) +- Retry duration: 60 (default) - Backup settings: failed data only to s3 bucket You now have an Amazon Data Firehose delivery specified with: -- source: direct put -- destination: elastic +- source: direct put +- destination: elastic - parameters: es_datastream_name: logs-aws.cloudtrail-default [discrete] @@ -106,7 +106,7 @@ You now have an Amazon Data Firehose delivery specified with: image::firehose-subscription-filter.png[Firehose subscription filter] -The Amazon Data Firehose delivery stream is ready to send logs to your Elastic Cloud deployment. +The Amazon Data Firehose delivery stream is ready to send logs to your Elastic Cloud deployment. . Visit the log group with the CloudTrail events. + diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudwatch-firehose.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudwatch-firehose.asciidoc index fbaa9d2118..bc8c095626 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudwatch-firehose.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudwatch-firehose.asciidoc @@ -2,7 +2,7 @@ = Monitor CloudWatch logs ++++ -Monitor CloudWatch logs +CloudWatch logs ++++ In this section, you'll learn how to export log events from CloudWatch logs to an Elastic cluster by using Amazon Data Firehose. @@ -10,7 +10,7 @@ In this section, you'll learn how to export log events from CloudWatch logs to a You'll go through the following steps: - Install AWS integration in {kib} -- Select a CloudWatch log group to monitor +- Select a CloudWatch log group to monitor - Create a delivery stream in Amazon Data Firehose - Set up a subscription filter to forward the logs using the Firehose stream - Visualize your logs in {kib} @@ -36,17 +36,17 @@ IMPORTANT: AWS PrivateLink is not supported. Make sure the deployment is on AWS, [discrete] [[firehose-cloudwatch-step-two]] -== Step 2: Select a CloudWatch log group to monitor +== Step 2: Select a CloudWatch log group to monitor image::firehose-cloudwatch-log-group.png[CloudWatch log group] -In this tutorial, you are going to collect application logs from an AWS Lambda-based app and forward them to Elastic. +In this tutorial, you are going to collect application logs from an AWS Lambda-based app and forward them to Elastic. **Create a Lambda function** -NOTE: You can skip this section if you already have a Lambda function, or any other service or application that sends logs to a CloudWatch log group. Take note of the log group from which you want to collect log events and move to the next section. +NOTE: You can skip this section if you already have a Lambda function, or any other service or application that sends logs to a CloudWatch log group. Take note of the log group from which you want to collect log events and move to the next section. -Like many other services and platforms in AWS, Lambda functions natively log directly to CloudWatch out of the box. +Like many other services and platforms in AWS, Lambda functions natively log directly to CloudWatch out of the box. . Go to the https://console.aws.amazon.com/[AWS console] and open the AWS Lambda page. . Click **Create function** and select the option to create a function from scratch. @@ -90,11 +90,11 @@ Take note of the log group name for this Lambda function, as you will need it in image::firehose-cloudwatch-firehose-stream.png[Amazon Firehose Stream] -. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. +. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. -. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Unless you are streaming data from Kinesis Data Streams, set source to `Direct PUT` and destination to `Elastic`. +. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Unless you are streaming data from Kinesis Data Streams, set source to `Direct PUT` and destination to `Elastic`. -. Provide a meaningful *Firehose stream name* that will allow you to identify this delivery stream later. +. Provide a meaningful *Firehose stream name* that will allow you to identify this delivery stream later. + NOTE: For advanced use cases, source records can be transformed by invoking a custom Lambda function. When using Elastic integrations, this should not be required. @@ -111,7 +111,7 @@ image::firehose-cloudwatch-subscription-filter.png[CloudWatch subscription filte To send log events from CloudWatch to Firehose, open the log group where the Lambda service is logging and create a subscription filter. -**Create a subscription filter for Amazon Data Firehose** +**Create a subscription filter for Amazon Data Firehose** The https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html[subscription filter] allows you to pick log events from the log group and forward them to other services, such as an Amazon Kinesis stream, an Amazon Data Firehose stream, or AWS Lambda. @@ -188,8 +188,8 @@ image::firehose-cloudwatch-destination-errors.png[Firehose destination errors] The Firehose delivery stream reports: -* The number of failed deliveries. -* The failure detail. +* The number of failed deliveries. +* The failure detail. [discrete] [[firehose-cloudwatch-step-five]] diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-firewall-firehose.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-firewall-firehose.asciidoc index 1458bdac93..d52de9ce90 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-firewall-firehose.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-firewall-firehose.asciidoc @@ -2,14 +2,14 @@ = Monitor AWS Network Firewall logs ++++ -Monitor Network Firewall logs +Network Firewall logs ++++ In this section, you'll learn how to send AWS Network Firewall log events from AWS to your Elastic stack using Amazon Data Firehose. You will go through the following steps: -- Select a AWS Network Firewall-compatible resource +- Select a AWS Network Firewall-compatible resource - Create a delivery stream in Amazon Data Firehose - Set up logging to forward the logs to the Elastic stack using a Firehose stream - Visualize your logs in {kib} @@ -49,9 +49,9 @@ Creating a Network Firewall is not trivial and is beyond the scope of this guide image::firehose-networkfirewall-stream.png[Firehose stream] -. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. +. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. -. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Set source to `Direct PUT` and destination to `Elastic`. +. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Set source to `Direct PUT` and destination to `Elastic`. . Collect {es} endpoint and API key from your deployment on Elastic Cloud. + @@ -64,7 +64,7 @@ image::firehose-networkfirewall-stream.png[Firehose stream] - Elastic endpoint URL - API key - Content encoding: gzip -- Retry duration: 60 (default) +- Retry duration: 60 (default) - Parameter *es_datastream_name* = `logs-aws.firewall_logs-default` - Backup settings: failed data only to s3 bucket diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-vpc-flow-logs.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-vpc-flow-logs.asciidoc index 36a93b0603..9cd2081d9e 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-vpc-flow-logs.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-vpc-flow-logs.asciidoc @@ -2,7 +2,7 @@ = Monitor Virtual Private Cloud (VPC) Flow Logs ++++ -Monitor VPC Flow Logs +VPC Flow Logs ++++ In this section, you'll learn how to monitor and analyze the VPC flow logs you sent to Elastic with Amazon Data Firehose. You can choose among the following monitoring options: diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-waf-firehose.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-waf-firehose.asciidoc index 8433de4701..fde9abbe36 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-waf-firehose.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-waf-firehose.asciidoc @@ -2,7 +2,7 @@ = Monitor Web Application Firewall (WAF) logs ++++ -Monitor WAF logs +WAF logs ++++ In this section, you'll learn how to send AWS WAF events from AWS to your {stack} using Amazon Data Firehose. @@ -38,9 +38,9 @@ IMPORTANT: Make sure the deployment is on AWS, because the Amazon Data Firehose [[firehose-waf-step-two]] == Step 2: Create a delivery stream in Amazon Data Firehose -. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. +. Go to the https://console.aws.amazon.com/[AWS console] and navigate to Amazon Data Firehose. -. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Unless you are streaming data from Kinesis Data Streams, set source to `Direct PUT` and destination to `Elastic`. +. Click *Create Firehose stream* and choose the source and destination of your Firehose stream. Unless you are streaming data from Kinesis Data Streams, set source to `Direct PUT` and destination to `Elastic`. . Provide a meaningful *Firehose stream name* that will allow you to identify this delivery stream later. Your Firehose name must start with the prefix `aws-waf-logs-` or it will not show up later. @@ -54,9 +54,9 @@ NOTE: For advanced use cases, source records can be transformed by invoking a cu + * *Elastic endpoint URL*: Enter the Elastic endpoint URL of your Elasticsearch cluster. To find the Elasticsearch endpoint, go to the Elastic Cloud console, navigate to the Integrations page, and select *Connection details*. Here is an example of how it looks like: `https://my-deployment.es.us-east-1.aws.elastic-cloud.com`. + -* *API key*: Enter the encoded Elastic API key. To create an API key, go to the Elastic Cloud console, navigate to the Integrations page, select *Connection details* and click *Create and manage API keys*. If you are using an API key with *Restrict privileges*, make sure to review the Indices privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this delivery stream. +* *API key*: Enter the encoded Elastic API key. To create an API key, go to the Elastic Cloud console, navigate to the Integrations page, select *Connection details* and click *Create and manage API keys*. If you are using an API key with *Restrict privileges*, make sure to review the Indices privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this delivery stream. + -* *Content encoding*: For a better network efficiency, leave content encoding set to GZIP. +* *Content encoding*: For a better network efficiency, leave content encoding set to GZIP. + * *Retry duration*: Determines how long Firehose continues retrying the request in the event of an error. A duration of 60-300s should be suitable for most use cases. + @@ -68,9 +68,9 @@ NOTE: For advanced use cases, source records can be transformed by invoking a cu To create a new web access control list (ACL), follow these steps: -. Go to the https://console.aws.amazon.com/[AWS console] and navigate to the *WAF & Shield* page. +. Go to the https://console.aws.amazon.com/[AWS console] and navigate to the *WAF & Shield* page. -. Describe web ACL by entering the resource type, region, and name. +. Describe web ACL by entering the resource type, region, and name. . Associate it to an AWS resource. If you don't have an existing resource, you can create and attach a web ACL to several AWS resources: + diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc index 93ef9463da..849482ff2b 100644 --- a/docs/en/observability/start-here.asciidoc +++ b/docs/en/observability/start-here.asciidoc @@ -1,7 +1,7 @@ [[observability-start-here]] = Start here -New to Elastic {observability}? Explore the topics in this section to learn more about our {observability} features and how to get started. +New to Elastic {observability}? Discover more about our {observability} features and how to get started. [cols="1,1"] |=== From ed55b9009ce8b4db4a6bf63ea5a3de9eb49891db Mon Sep 17 00:00:00 2001 From: dedemorton Date: Thu, 22 Aug 2024 18:04:27 -0700 Subject: [PATCH 12/23] More K8s tutorial to infra/hosts monitoring section --- docs/en/observability/index.asciidoc | 6 ++---- docs/en/observability/monitor-k8s/monitor-k8s.asciidoc | 6 +----- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index e41c84a81c..c4c9124263 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -160,11 +160,9 @@ include::monitor-infra/inspect-metric-anomalies.asciidoc[leveloffset=+2] include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+2] -include::monitor-infra/metrics-reference.asciidoc[leveloffset=+2] - -// Single: Kubernetes monitoring +include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+2] -include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+1] +include::monitor-infra/metrics-reference.asciidoc[leveloffset=+2] // Group: Logs include::logs-checklist.asciidoc[leveloffset=+1] diff --git a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc index 2f9ea18ac9..8b1f0cbbdb 100644 --- a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc +++ b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc @@ -1,9 +1,5 @@ [[monitor-kubernetes]] -= Monitor Kubernetes: Observe the health and performance of your Kubernetes deployments - -++++ -Kubernetes -++++ += Tutorial: Observe your Kubernetes deployments Applications running in a containerized environment like Kubernetes pose a unique monitoring challenge: how do you diagnose and resolve issues with From 854673641c5f74ceb57be3e5fb8fe55bb029edc4 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Fri, 23 Aug 2024 17:15:04 -0700 Subject: [PATCH 13/23] Add getting started change and other changes requested by obs docs --- .../apm-ui/new-experience-services.asciidoc | 2 +- docs/en/observability/apm.asciidoc | 2 +- .../apm/getting-started-apm-server.asciidoc | 5 ++- .../apm/setting-up-and-running.asciidoc | 2 +- ...doc => delete_traces-get-started.asciidoc} | 2 + docs/en/observability/index.asciidoc | 13 +++--- .../logs-metrics-get-started.asciidoc | 43 ++++++------------- docs/en/observability/monitor-nginx.asciidoc | 5 +-- .../observability-get-started.asciidoc | 14 +++--- docs/en/observability/redirects.asciidoc | 2 +- .../observability/splunk-get-started.asciidoc | 10 ++--- 11 files changed, 43 insertions(+), 57 deletions(-) rename docs/en/observability/{traces-get-started.asciidoc => delete_traces-get-started.asciidoc} (99%) diff --git a/docs/en/observability/apm-ui/new-experience-services.asciidoc b/docs/en/observability/apm-ui/new-experience-services.asciidoc index bd9e8eff98..a548774e4a 100644 --- a/docs/en/observability/apm-ui/new-experience-services.asciidoc +++ b/docs/en/observability/apm-ui/new-experience-services.asciidoc @@ -47,5 +47,5 @@ which means that other users need to turn on the new experience if they want to To add services to the inventory, use one of the following approaches: * Instrument your services with APM or OpenTelemetry. -To learn how, refer to <>. +To learn how, refer to <>. * Declare `service.name` in your logs. To learn how, <>. diff --git a/docs/en/observability/apm.asciidoc b/docs/en/observability/apm.asciidoc index 7c9c8f9b7a..4c9e3693c0 100644 --- a/docs/en/observability/apm.asciidoc +++ b/docs/en/observability/apm.asciidoc @@ -43,7 +43,7 @@ like JVM metrics in the Java Agent, and Go runtime metrics in the Go Agent. [float] === Give Elastic APM a try -Use <> to quickly spin up an APM deployment. +Use <> to quickly spin up an APM deployment. Want to host everything yourself instead? See <>. include::{observability-docs-root}/docs/en/observability/apm/getting-started-apm-server.asciidoc[] diff --git a/docs/en/observability/apm/getting-started-apm-server.asciidoc b/docs/en/observability/apm/getting-started-apm-server.asciidoc index 2c447e6b91..9ccde19dbd 100644 --- a/docs/en/observability/apm/getting-started-apm-server.asciidoc +++ b/docs/en/observability/apm/getting-started-apm-server.asciidoc @@ -8,7 +8,7 @@ TIP: 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. -See <> to get started in minutes. +See <> to get started in minutes. // TODO: MOVE THIS @@ -475,7 +475,7 @@ include::{observability-docs-root}/docs/en/observability/apm/repositories.asciid // Shared docker include::{observability-docs-root}/docs/en/observability/apm/shared-docker.asciidoc[] - +[[get-started-with-fleet-apm-server]] === Fleet-managed APM Server This guide will explain how to set up and configure a Fleet-managed APM Server. @@ -498,6 +498,7 @@ include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/add-fleet-serv For more information, refer to {fleet-guide}/fleet-server.html[{fleet-server}]. +[[add-apm-integration]] ==== Step 2: Add and configure the APM integration include::{observability-docs-root}/docs/en/observability/tab-widgets/add-apm-integration/content.asciidoc[tag=self-managed] diff --git a/docs/en/observability/apm/setting-up-and-running.asciidoc b/docs/en/observability/apm/setting-up-and-running.asciidoc index db97f75751..a9a065f614 100644 --- a/docs/en/observability/apm/setting-up-and-running.asciidoc +++ b/docs/en/observability/apm/setting-up-and-running.asciidoc @@ -6,7 +6,7 @@ Advanced setup ++++ -Before reading this section, see the <> +Before reading this section, see the <> for basic installation and running instructions. This section includes additional information on how to set up and run APM Server, including: diff --git a/docs/en/observability/traces-get-started.asciidoc b/docs/en/observability/delete_traces-get-started.asciidoc similarity index 99% rename from docs/en/observability/traces-get-started.asciidoc rename to docs/en/observability/delete_traces-get-started.asciidoc index 7240a082fd..3b42258e89 100644 --- a/docs/en/observability/traces-get-started.asciidoc +++ b/docs/en/observability/delete_traces-get-started.asciidoc @@ -5,6 +5,8 @@ Traces and APM ++++ +//TODO: Delete this file. + // THIS CONTENT IS ALSO USED IN THE APM GUIDE // tag::apm-quick-start[] diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index c4c9124263..f02ea4e9c0 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -19,13 +19,10 @@ include::whats-new.asciidoc[leveloffset=+2] // Get started with Elastic Observability include::observability-get-started.asciidoc[leveloffset=+2] -include::logs-metrics-get-started.asciidoc[leveloffset=+3] +//TODO: Delete this file when we're sure we don't want to keep it +//include::traces-get-started.asciidoc[leveloffset=+3] -include::monitor-nginx.asciidoc[leveloffset=3] - -include::traces-get-started.asciidoc[leveloffset=+3] - -include::splunk-get-started.asciidoc[leveloffset=+3] +include::splunk-get-started.asciidoc[leveloffset=+2] // Group: Application and service monitoring include::application-and-service-monitoring.asciidoc[leveloffset=+1] @@ -150,6 +147,8 @@ include::monitor-gcp.asciidoc[leveloffset=+2] include::monitor-infra/monitor-infrastructure-and-hosts.asciidoc[leveloffset=+1] +include::logs-metrics-get-started.asciidoc[leveloffset=+2] + include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] include::monitor-infra/explore-metrics.asciidoc[leveloffset=+2] @@ -162,6 +161,8 @@ include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+2] include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+2] +include::monitor-nginx.asciidoc[leveloffset=2] + include::monitor-infra/metrics-reference.asciidoc[leveloffset=+2] // Group: Logs diff --git a/docs/en/observability/logs-metrics-get-started.asciidoc b/docs/en/observability/logs-metrics-get-started.asciidoc index dd220ee75d..d1f938067e 100644 --- a/docs/en/observability/logs-metrics-get-started.asciidoc +++ b/docs/en/observability/logs-metrics-get-started.asciidoc @@ -1,21 +1,13 @@ [[logs-metrics-get-started]] -= Get started with logs and metrics += Get started with system metrics -++++ -Logs and metrics -++++ +In this guide you'll learn how to onboard system metrics data from a machine or server, then observe the data in Elastic Observability. This guide describes how to use a {fleet}-managed {agent}. +To get started quickly with a standalone agent that does not require {fleet}, +follow the steps described in the quickstart. -**** -**New to Elastic?** Follow the steps in our {estc-welcome}/getting-started-observability.html[getting started guide] instead -of the steps described here. -**** +//TODO: Add link to the quickstart when it's merged. -This guide describes how to: - -* Monitor logs and infrastructure metrics from systems and services across your organization -* Monitor Nginx logs and metrics using the Nginx integration - -For feedback and questions, please contact us in the {forum}[discuss forum]. +//TODO: If we keep this topic, we should work on it more and make it consistent with serverless. [discrete] [[logs-metrics-prereqs]] @@ -151,27 +143,21 @@ You can hover over any visualization to adjust its settings, or click the {kibana-ref}/dashboard.html[Dashboard and visualizations]. [discrete] -[[add-nginx-integration]] -== Step 4: Monitor Nginx logs and metrics -[discrete] +[[add-other-integrations]] +== Step 4: Monitor other sources -Next, add an Nginx integration to the policy used by your agent. - -NOTE: For these steps, we assume that you have `nginx` running on your host, and -want to collect logs and metrics from it. If not, you can skip this part of the -guide. +Next, add additional integrations to the policy used by your agent. . In {kib}, go to the **Integrations** page. -. In the query bar, search for **Nginx** and select the integration to see more -details about it. +. In the query bar, search for the source you want to monitor (for example, nginx) and select the integration to see more details about it. -. Click **Add Nginx**. +. Click **Add **. . Configure the integration name and optionally add a description. . Expand each configuration section to verify that the settings are correct for -your host. You may need to change the **Paths** settings. +your host. . Under **Where to add this integration**, select *Existing hosts*, then select the agent policy you created earlier. That way, you can deploy the change to @@ -181,14 +167,13 @@ the agent that's already running. // lint ignore nginx-1 . To see the updated policy, click the agent policy link. + -The newly added Nginx integration should appear on the **Integrations** tab in +The newly added integration should appear on the **Integrations** tab in your agent policy. + [role="screenshot"] image::images/kibana-fleet-policies-default-with-nginx.png[{fleet} showing default agent policy with nginx-1 data source] + -Any {agent}s assigned to this policy will collect logs and metrics from the -Nginx server and the host, along with system logs and uptime data. +Any {agent}s assigned to this policy will begin collecting data for the newly configured integrations. . To view the data, go to **Management > {fleet}**, then click the **Data streams** tab. diff --git a/docs/en/observability/monitor-nginx.asciidoc b/docs/en/observability/monitor-nginx.asciidoc index 8b88a3286d..d6dba717b6 100644 --- a/docs/en/observability/monitor-nginx.asciidoc +++ b/docs/en/observability/monitor-nginx.asciidoc @@ -1,8 +1,5 @@ [[monitor-nginx]] -= Monitor nginx: Observe the logs and metrics of your nginx instances -++++ -Nginx -++++ += Tutorial: Observe your nginx instances **** **New to Elastic?** Follow the steps in our {estc-welcome}/getting-started-observability.html[getting started guide] instead of the steps described here. diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index fc883c6d8d..f2c2574a81 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -9,10 +9,10 @@ Learn how to spin up a deployment of our hosted {ess} and use Elastic Observability to gain deeper insight into the behavior of your applications and systems. -The guides in this section describe how to: - image::images/get-started.svg[] +//TODO: Mention OpenTelemetry here? + 1. **Choose your source.** Elastic integrates with hundreds of data sources for unified visibility across all your applications and systems. @@ -31,8 +31,11 @@ detection. Follow the steps in these guides to get started: -* <> -* <> +// TODO: Decide whether to add the quickstarts on this page. +// We could remove the container topic called quickstarts and just add a section to this info here. + +* <> +* <> * <> [discrete] @@ -51,5 +54,4 @@ Ready to dig into more features of Elastic Observability? See these guides: * {estc-welcome}/index.html[Starting with the {es} Platform and its Solutions] for new users * {cloud}/ec-cloud-ingest-data.html[Adding data to {es}] for other ways to ingest data -//TODO: Remove this link -//* <> for hands-on steps +* <> for hands-on steps diff --git a/docs/en/observability/redirects.asciidoc b/docs/en/observability/redirects.asciidoc index ee9584176c..510a63557e 100644 --- a/docs/en/observability/redirects.asciidoc +++ b/docs/en/observability/redirects.asciidoc @@ -163,7 +163,7 @@ Refer to <>. [role="exclude" id="ingest-traces"] === Ingest application traces with {agent} -Refer to <>. +Refer to <>. [role="exclude" id="threshold-alert"] === Create a threshold rule diff --git a/docs/en/observability/splunk-get-started.asciidoc b/docs/en/observability/splunk-get-started.asciidoc index 97e9acfcc9..84f3d97272 100644 --- a/docs/en/observability/splunk-get-started.asciidoc +++ b/docs/en/observability/splunk-get-started.asciidoc @@ -1,9 +1,7 @@ [[splunk-get-started]] = Get started with data from Splunk -++++ -Data from Splunk -++++ +//TODO: Add more detail to the part about adding the integration. preview::[] @@ -36,9 +34,9 @@ include::{observability-docs-root}/docs/en/observability/logs-metrics-get-starte [[splunk-step-one]] == Step 1: Add integration -// lint ignore add-nginx-integration -Find the Nginx integration and begin adding it as described in -<>. +Go to the {kib} home page and click **Add integrations**. +Search for and add the nginx integration. +Refer to <> for detailed steps about adding integrations. [discrete] [[splunk-step-two]] From ed321e305e96816b5b0909a00caeaf1549124a2b Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 26 Aug 2024 09:22:42 -0700 Subject: [PATCH 14/23] Fix broken apm links --- docs/en/apm-server/redirects.asciidoc | 2 +- docs/en/observability/apm/apm-quick-start.asciidoc | 2 ++ docs/en/observability/landing-page/data/recommended-data.json | 2 +- docs/en/observability/landing-page/page.asciidoc | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/en/apm-server/redirects.asciidoc b/docs/en/apm-server/redirects.asciidoc index 986593cbb4..7ff6de87dd 100644 --- a/docs/en/apm-server/redirects.asciidoc +++ b/docs/en/apm-server/redirects.asciidoc @@ -428,7 +428,7 @@ Refer to {observability-guide}/apm.html[Application Performance Monitoring (APM) {move-notice} -Refer to {observability-guide}/traces-get-started.html[Quick start with Elastic Cloud]. +Refer to {observability-guide}/get-started-with-fleet-apm-server.html[Quick start with Elastic Cloud]. [role="exclude",id="getting-started-apm-server"] === Self manage APM Server diff --git a/docs/en/observability/apm/apm-quick-start.asciidoc b/docs/en/observability/apm/apm-quick-start.asciidoc index aef32b5ebf..a8de5bc44f 100644 --- a/docs/en/observability/apm/apm-quick-start.asciidoc +++ b/docs/en/observability/apm/apm-quick-start.asciidoc @@ -1,6 +1,8 @@ [[apm-quick-start]] == Quick start with {ecloud} +TODO: Ask Colleen if this file should be deleted. + 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. diff --git a/docs/en/observability/landing-page/data/recommended-data.json b/docs/en/observability/landing-page/data/recommended-data.json index 812d674c96..c2e990cbc9 100644 --- a/docs/en/observability/landing-page/data/recommended-data.json +++ b/docs/en/observability/landing-page/data/recommended-data.json @@ -11,7 +11,7 @@ { "title": "Monitor your application performance", "description": "Learn how to collect and visualize Application Performance Monitoring (APM) data with the Elastic Stack.", - "link": "traces-get-started.html", + "link": "get-started-with-fleet-apm-server.html", "image": "traces-get-started.png" }, { diff --git a/docs/en/observability/landing-page/page.asciidoc b/docs/en/observability/landing-page/page.asciidoc index 9fe6c3135e..aa16a9cca3 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.
+

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.
++++ ++++ From a0b7a5e577afdf555959a477a9d1660857355e62 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 26 Aug 2024 11:13:11 -0700 Subject: [PATCH 15/23] Apply more link fixes --- docs/en/apm-server/redirects.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/apm-server/redirects.asciidoc b/docs/en/apm-server/redirects.asciidoc index 7ff6de87dd..f733cc02c8 100644 --- a/docs/en/apm-server/redirects.asciidoc +++ b/docs/en/apm-server/redirects.asciidoc @@ -491,7 +491,7 @@ Refer to {observability-guide}/apm-running-on-docker.html[Run APM Server on Dock {move-notice} -Refer to {observability-guide}/_fleet_managed_apm_server.html[Fleet-managed APM Server]. +Refer to {observability-guide}/get-started-with-fleet-apm-server.html[Fleet-managed APM Server]. [role="exclude",id="_step_1_set_up_fleet"] === Step 1: Set up Fleet @@ -505,7 +505,7 @@ Refer to {observability-guide}/_step_1_set_up_fleet.html[Step 1: Set up Fleet]. {move-notice} -Refer to {observability-guide}/_step_2_add_and_configure_the_apm_integration.html[Step 2: Add and configure the APM integration]. +Refer to {observability-guide}/add-apm-integration.html[Step 2: Add and configure the APM integration]. [role="exclude",id="_step_3_install_apm_agents"] === Step 3: Install APM agents From b7695cbf24d4e5c9827853547993c57f5c9b73cb Mon Sep 17 00:00:00 2001 From: dedemorton Date: Mon, 26 Aug 2024 15:26:25 -0700 Subject: [PATCH 16/23] Reorganize getting started/quick start section --- .../aws/monitor-aws-agent.asciidoc | 3 -- .../azure/monitor-azure-agent.asciidoc | 1 - .../azure/monitor-azure-native.asciidoc | 2 -- docs/en/observability/index.asciidoc | 12 ++++---- .../observability-get-started.asciidoc | 30 ++++++++++++++----- .../monitor-hosts-with-elastic-agent.asciidoc | 2 +- .../monitor-k8s-logs-metrics.asciidoc | 2 +- .../quickstarts/quickstarts-overview.asciidoc | 16 ---------- docs/en/observability/start-here.asciidoc | 8 ++--- 9 files changed, 34 insertions(+), 42 deletions(-) delete mode 100644 docs/en/observability/quickstarts/quickstarts-overview.asciidoc diff --git a/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc b/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc index f61851e0ed..34dc15dec3 100644 --- a/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc +++ b/docs/en/observability/cloud-monitoring/aws/monitor-aws-agent.asciidoc @@ -411,6 +411,3 @@ To track your AWS billing, open the image::images/agent-tut-billing-dashboard.png[Screenshot of the Billing Overview dashboard] Congratulations! You have completed the tutorial. - -//TODO: Remove this link -//To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc b/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc index e4e3f667dc..c7790c244a 100644 --- a/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc +++ b/docs/en/observability/cloud-monitoring/azure/monitor-azure-agent.asciidoc @@ -391,4 +391,3 @@ you can use to visualize the data. In {kib}, open the main menu and click image::images/agent-tut-azure-activity-logs-dashboard.png[Screenshot of Azure activity logs dashboard] Congratulations! You have completed the tutorial. -// To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc b/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc index d372a4f2e7..43f10ad1f1 100644 --- a/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc +++ b/docs/en/observability/cloud-monitoring/azure/monitor-azure-native.asciidoc @@ -148,5 +148,3 @@ To explore the data further, click **Open as page**. image::monitor-azure-native-kibana-vms-metrics-detail.png[Screenshot of detailed VM metrics] Congratulations! You have completed the tutorial. - -//To try other tutorials in this series, visit the <> page. diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index 321d36afd6..0ce316bd05 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -16,15 +16,15 @@ include::observability-introduction.asciidoc[leveloffset=+2] // What's new include::whats-new.asciidoc[leveloffset=+2] -// Quickstarts -include::quickstarts/quickstarts-overview.asciidoc[leveloffset=+1] +// Get started with Elastic Observability +include::observability-get-started.asciidoc[leveloffset=+2] -include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+2] +// Quickstarts +//include::quickstarts/quickstarts-overview.asciidoc[leveloffset=+3] -include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+2] +include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+3] -// Get started with Elastic Observability -include::observability-get-started.asciidoc[leveloffset=+2] +include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+3] //TODO: Delete this file when we're sure we don't want to keep it //include::traces-get-started.asciidoc[leveloffset=+3] diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index f2c2574a81..a684f3eaed 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -27,24 +27,39 @@ dashboards to identify and resolve problems quickly. detection. [discrete] -== Get started now +[[quickstarts-overview]] +== Quickstarts -Follow the steps in these guides to get started: +Our quickstarts dramatically reduce your time-to-value by offering a fast path to ingest and visualize your Observability data. +Each quickstart provides: + +* A highly opinionated, fast path to data ingestion +* Sensible configuration defaults with minimal configuration required +* Auto-detection of logs and metrics for monitoring hosts +* Quick access to related dashboards and visualizations + +Follow the steps in these guides to get started quickly: + +* <> +* <> + + +[discrete] +== Get started with other features -// TODO: Decide whether to add the quickstarts on this page. -// We could remove the container topic called quickstarts and just add a section to this info here. +Want to use {fleet} or some other feature not covered in the quickstarts? +Follow the steps in these guides to get started: * <> * <> -* <> +* <> +* <> [discrete] == Additional guides Ready to dig into more features of Elastic Observability? See these guides: -* <> -* <> * <> * <> @@ -54,4 +69,3 @@ Ready to dig into more features of Elastic Observability? See these guides: * {estc-welcome}/index.html[Starting with the {es} Platform and its Solutions] for new users * {cloud}/ec-cloud-ingest-data.html[Adding data to {es}] for other ways to ingest data -* <> for hands-on steps diff --git a/docs/en/observability/quickstarts/monitor-hosts-with-elastic-agent.asciidoc b/docs/en/observability/quickstarts/monitor-hosts-with-elastic-agent.asciidoc index 188f7d64ad..61b37e782d 100644 --- a/docs/en/observability/quickstarts/monitor-hosts-with-elastic-agent.asciidoc +++ b/docs/en/observability/quickstarts/monitor-hosts-with-elastic-agent.asciidoc @@ -1,5 +1,5 @@ [[quickstart-monitor-hosts-with-elastic-agent]] -= Monitor hosts with {agent} += Quickstart: Monitor hosts with {agent} preview::[] diff --git a/docs/en/observability/quickstarts/monitor-k8s-logs-metrics.asciidoc b/docs/en/observability/quickstarts/monitor-k8s-logs-metrics.asciidoc index 4c5318f906..23b77351d7 100644 --- a/docs/en/observability/quickstarts/monitor-k8s-logs-metrics.asciidoc +++ b/docs/en/observability/quickstarts/monitor-k8s-logs-metrics.asciidoc @@ -1,5 +1,5 @@ [[monitor-k8s-logs-metrics-with-elastic-agent]] -= Monitor your Kubernetes cluster with {agent} += Quickstart: Monitor your Kubernetes cluster with {agent} preview::[] diff --git a/docs/en/observability/quickstarts/quickstarts-overview.asciidoc b/docs/en/observability/quickstarts/quickstarts-overview.asciidoc deleted file mode 100644 index 2379947fa3..0000000000 --- a/docs/en/observability/quickstarts/quickstarts-overview.asciidoc +++ /dev/null @@ -1,16 +0,0 @@ -[[quickstarts-overview]] -= Quickstarts - -Our quickstarts dramatically reduce your time-to-value by offering a fast path to ingest and visualize your Observability data. -Each quickstart provides: - -* A highly opinionated, fast path to data ingestion -* Sensible configuration defaults with minimal configuration required -* Auto-detection of logs and metrics for monitoring hosts -* Quick access to related dashboards and visualizations - -[discrete] -== Available quickstarts - -* <> -* <> diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc index 849482ff2b..d6176d02af 100644 --- a/docs/en/observability/start-here.asciidoc +++ b/docs/en/observability/start-here.asciidoc @@ -11,9 +11,9 @@ New to Elastic {observability}? Discover more about our {observability} features |<> |Learn about what's new and improved for this version of Elastic {observability}. -|Quick starts -|Learn about the fast path to ingest and visualize your {observability} data. - |<> -|Learn how to spin up a deployment of our hosted Elasticsearch Service and use Elastic {observability}. +|Learn how to get started with Elastic {observability} and its features. + +|<> +|Learn how to seamlessly ingest data from a Splunk Enterprise instance. |=== From 8b0f363ee1e9eb0256196b1e7c1cf9ffaf1089be Mon Sep 17 00:00:00 2001 From: dedemorton Date: Wed, 28 Aug 2024 16:14:42 -0700 Subject: [PATCH 17/23] Resolve or remove related TODOs --- docs/en/observability/cloud-monitoring.asciidoc | 2 -- docs/en/observability/logs-metrics-get-started.asciidoc | 6 ++---- .../monitor-infra/monitor-infrastructure-and-hosts.asciidoc | 2 -- docs/en/observability/observability-get-started.asciidoc | 2 -- docs/en/observability/user-experience.asciidoc | 2 -- 5 files changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/en/observability/cloud-monitoring.asciidoc b/docs/en/observability/cloud-monitoring.asciidoc index d2809d1447..cca5242fed 100644 --- a/docs/en/observability/cloud-monitoring.asciidoc +++ b/docs/en/observability/cloud-monitoring.asciidoc @@ -7,8 +7,6 @@ Explore the topics in this section to learn how to observe and monitor a broad range of resources and applications running in your cloud ecosystem. -//TODO: This topic needs input from Arianna and PMs to figure out what to highlight given our current spotty coverage in the docs. - [cols="1,1"] |=== |<> diff --git a/docs/en/observability/logs-metrics-get-started.asciidoc b/docs/en/observability/logs-metrics-get-started.asciidoc index d1f938067e..d5d3cd895a 100644 --- a/docs/en/observability/logs-metrics-get-started.asciidoc +++ b/docs/en/observability/logs-metrics-get-started.asciidoc @@ -3,11 +3,9 @@ In this guide you'll learn how to onboard system metrics data from a machine or server, then observe the data in Elastic Observability. This guide describes how to use a {fleet}-managed {agent}. To get started quickly with a standalone agent that does not require {fleet}, -follow the steps described in the quickstart. +follow the steps described in the <>. -//TODO: Add link to the quickstart when it's merged. - -//TODO: If we keep this topic, we should work on it more and make it consistent with serverless. +//TODO: Make this info more consistent with serverless. [discrete] [[logs-metrics-prereqs]] diff --git a/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc index 0ce5a7ce0f..25c0304123 100644 --- a/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc +++ b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc @@ -5,8 +5,6 @@ Infrastructure and hosts ++++ -//TODO: Update ID and set up redirect - The {infrastructure-app} in {kib} enables you to visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, automatically discover and track pods, and unify your metrics with logs and APM diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index a684f3eaed..e10b78f253 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -11,8 +11,6 @@ systems. image::images/get-started.svg[] -//TODO: Mention OpenTelemetry here? - 1. **Choose your source.** Elastic integrates with hundreds of data sources for unified visibility across all your applications and systems. diff --git a/docs/en/observability/user-experience.asciidoc b/docs/en/observability/user-experience.asciidoc index cf0c1983f4..124315d033 100644 --- a/docs/en/observability/user-experience.asciidoc +++ b/docs/en/observability/user-experience.asciidoc @@ -3,8 +3,6 @@ [[user-experience]] = Real user monitoring ({user-experience}) -//TODO: Decide whether this should say "User experience" or "Real user monitoring" - ++++ Real user monitoring ++++ From 22af26932696fb3c11c2d4f1bff40d58358570ed Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Thu, 29 Aug 2024 11:45:19 -0700 Subject: [PATCH 18/23] Update docs/en/observability/splunk-get-started.asciidoc --- docs/en/observability/splunk-get-started.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/splunk-get-started.asciidoc b/docs/en/observability/splunk-get-started.asciidoc index 84f3d97272..ebe74742ac 100644 --- a/docs/en/observability/splunk-get-started.asciidoc +++ b/docs/en/observability/splunk-get-started.asciidoc @@ -1,5 +1,5 @@ [[splunk-get-started]] -= Get started with data from Splunk += Add data from Splunk //TODO: Add more detail to the part about adding the integration. From af8af2b95f85e977b300ab747bda2bf33113416d Mon Sep 17 00:00:00 2001 From: dedemorton Date: Thu, 29 Aug 2024 12:03:58 -0700 Subject: [PATCH 19/23] Make changes to getting started section --- docs/en/observability/index.asciidoc | 12 ++++-------- .../observability-get-started.asciidoc | 18 ++++++++++++++++-- docs/en/observability/start-here.asciidoc | 19 ------------------- 3 files changed, 20 insertions(+), 29 deletions(-) delete mode 100644 docs/en/observability/start-here.asciidoc diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index fe956c4e02..9a0f73cdab 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -7,8 +7,8 @@ include::{docs-root}/shared/attributes.asciidoc[] include::landing-page/page.asciidoc[] -// Group: Start here -include::start-here.asciidoc[leveloffset=+1] +// Get started with Elastic Observability +include::observability-get-started.asciidoc[leveloffset=+1] // What is Observability? include::observability-introduction.asciidoc[leveloffset=+2] @@ -16,15 +16,11 @@ include::observability-introduction.asciidoc[leveloffset=+2] // What's new include::whats-new.asciidoc[leveloffset=+2] -// Get started with Elastic Observability -include::observability-get-started.asciidoc[leveloffset=+2] - // Quickstarts -//include::quickstarts/quickstarts-overview.asciidoc[leveloffset=+3] -include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+3] +include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+2] -include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+3] +include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+2] //TODO: Delete this file when we're sure we don't want to keep it //include::traces-get-started.asciidoc[leveloffset=+3] diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index e10b78f253..5f16c35b8e 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -5,6 +5,20 @@ Get started ++++ +New to Elastic {observability}? Discover more about our observability features and how to get started. + +[discrete] +== Learn about Elastic {observability} + +Learn about key features available to help you get value from your observability data: + +* <> +* <> + +[discrete] +[[get-started-with-use-case]] +== Get started with your use case + Learn how to spin up a deployment of our hosted {ess} and use Elastic Observability to gain deeper insight into the behavior of your applications and systems. @@ -26,7 +40,7 @@ detection. [discrete] [[quickstarts-overview]] -== Quickstarts +=== Quickstarts Our quickstarts dramatically reduce your time-to-value by offering a fast path to ingest and visualize your Observability data. Each quickstart provides: @@ -43,7 +57,7 @@ Follow the steps in these guides to get started quickly: [discrete] -== Get started with other features +=== Get started with other features Want to use {fleet} or some other feature not covered in the quickstarts? Follow the steps in these guides to get started: diff --git a/docs/en/observability/start-here.asciidoc b/docs/en/observability/start-here.asciidoc deleted file mode 100644 index d6176d02af..0000000000 --- a/docs/en/observability/start-here.asciidoc +++ /dev/null @@ -1,19 +0,0 @@ -[[observability-start-here]] -= Start here - -New to Elastic {observability}? Discover more about our {observability} features and how to get started. - -[cols="1,1"] -|=== -|<> -|Learn about core features you can use to get value from your {observability} data. - -|<> -|Learn about what's new and improved for this version of Elastic {observability}. - -|<> -|Learn how to get started with Elastic {observability} and its features. - -|<> -|Learn how to seamlessly ingest data from a Splunk Enterprise instance. -|=== From 8d975b05bbbc3291d60c834d9cb99a6d8fae62cf Mon Sep 17 00:00:00 2001 From: dedemorton Date: Fri, 30 Aug 2024 12:59:23 -0700 Subject: [PATCH 20/23] Move universal profiling to section about infra monitoring --- ...pplication-and-service-monitoring.asciidoc | 3 - docs/en/observability/index.asciidoc | 64 ++++++++++--------- ...ructure-and-host-monitoring-intro.asciidoc | 18 ++++++ .../monitor-infrastructure-and-hosts.asciidoc | 6 +- .../universal-profiling.asciidoc | 2 +- 5 files changed, 54 insertions(+), 39 deletions(-) create mode 100644 docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index c32b00f694..dde378f4e9 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -15,9 +15,6 @@ Explore the topics in this section to learn how to observe and monitor software |<> |Monitor the availability of network endpoints and services. -|<> -|Profile all the code running on a machine, including application code, kernel, and third-party libraries. - |<> |Quantify and analyze the perceived performance of your web application using real-world user experiences. diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index 9a0f73cdab..0e745b6696 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -80,29 +80,6 @@ include::synthetics-security-encryption.asciidoc[leveloffset=+3] include::synthetics-troubleshooting.asciidoc[leveloffset=+3] -// Universal Profiling -include::universal-profiling.asciidoc[leveloffset=+2] - -include::profiling-get-started.asciidoc[leveloffset=+3] - -include::profiling-manage-storage.asciidoc[leveloffset=+3] -include::profiling-index-lifecycle-management.asciidoc[leveloffset=+4] -include::profiling-probabilistic-profiling.asciidoc[leveloffset=+4] - -include::profiling-advanced-configuration.asciidoc[leveloffset=+3] -include::profiling-tag-data-query.asciidoc[leveloffset=+4] -include::profiling-add-symbols.asciidoc[leveloffset=+4] -include::profiling-use-a-proxy.asciidoc[leveloffset=+4] -include::profiling-no-kernel-version-check.asciidoc[leveloffset=+4] - -include::profiling-upgrade.asciidoc[leveloffset=+3] - -include::profiling-troubleshooting.asciidoc[leveloffset=+3] - -include::profiling-self-managed.asciidoc[leveloffset=+3] -include::profiling-self-managed-ops.asciidoc[leveloffset=+4] -include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+4] - // User experience include::user-experience.asciidoc[leveloffset=+2] @@ -148,24 +125,51 @@ include::monitor-gcp.asciidoc[leveloffset=+2] // Group: Infrastructure and hosts -include::monitor-infra/monitor-infrastructure-and-hosts.asciidoc[leveloffset=+1] +include::monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc[leveloffset=+1] + +include::monitor-infra/monitor-infrastructure-and-hosts.asciidoc[leveloffset=+2] -include::logs-metrics-get-started.asciidoc[leveloffset=+2] +include::logs-metrics-get-started.asciidoc[leveloffset=+3] -include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+2] +include::monitor-infra/view-infrastructure-metrics.asciidoc[leveloffset=+3] -include::monitor-infra/explore-metrics.asciidoc[leveloffset=+2] +include::monitor-infra/explore-metrics.asciidoc[leveloffset=+3] -include::monitor-infra/analyze-hosts.asciidoc[leveloffset=+2] +include::monitor-infra/analyze-hosts.asciidoc[leveloffset=+3] -include::monitor-infra/inspect-metric-anomalies.asciidoc[leveloffset=+2] +include::monitor-infra/inspect-metric-anomalies.asciidoc[leveloffset=+3] -include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+2] +include::monitor-infra/configure-metrics-sources.asciidoc[leveloffset=+3] +// Universal Profiling +include::universal-profiling.asciidoc[leveloffset=+2] + +include::profiling-get-started.asciidoc[leveloffset=+3] + +include::profiling-manage-storage.asciidoc[leveloffset=+3] +include::profiling-index-lifecycle-management.asciidoc[leveloffset=+4] +include::profiling-probabilistic-profiling.asciidoc[leveloffset=+4] + +include::profiling-advanced-configuration.asciidoc[leveloffset=+3] +include::profiling-tag-data-query.asciidoc[leveloffset=+4] +include::profiling-add-symbols.asciidoc[leveloffset=+4] +include::profiling-use-a-proxy.asciidoc[leveloffset=+4] +include::profiling-no-kernel-version-check.asciidoc[leveloffset=+4] + +include::profiling-upgrade.asciidoc[leveloffset=+3] + +include::profiling-troubleshooting.asciidoc[leveloffset=+3] + +include::profiling-self-managed.asciidoc[leveloffset=+3] +include::profiling-self-managed-ops.asciidoc[leveloffset=+4] +include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+4] + +// Tutorials include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+2] include::monitor-nginx.asciidoc[leveloffset=+2] +// Troubleshooting include::troubleshooting-infra.asciidoc[leveloffset=+2] include::handle-no-results-found-message.asciidoc[leveloffset=+3] diff --git a/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc b/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc new file mode 100644 index 0000000000..95cae7f54d --- /dev/null +++ b/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc @@ -0,0 +1,18 @@ +[[infrastructure-and-host-monitoring-intro]] += Infrastructure and host monitoring + +++++ +Infrastructure and hosts +++++ + +Explore the topics in this section to learn how to observe and monitor hosts and other systems running in your environment. + +[cols="1,1"] +|=== +|<> +|Visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, automatically discover and track pods, and unify your metrics with other observability data. + +|<> +|Profile all the code running on a machine, including application code, kernel, and third-party libraries. +|=== + diff --git a/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc index 25c0304123..2c2bb0cf10 100644 --- a/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc +++ b/docs/en/observability/monitor-infra/monitor-infrastructure-and-hosts.asciidoc @@ -1,9 +1,5 @@ [[monitor-infrastructure-and-hosts]] -= Infrastructure and host monitoring - -++++ -Infrastructure and hosts -++++ += Analyze infrastructure and host metrics The {infrastructure-app} in {kib} enables you to visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, diff --git a/docs/en/observability/universal-profiling.asciidoc b/docs/en/observability/universal-profiling.asciidoc index 1ec8c233a0..e8d47d6330 100644 --- a/docs/en/observability/universal-profiling.asciidoc +++ b/docs/en/observability/universal-profiling.asciidoc @@ -1,7 +1,7 @@ [[universal-profiling]] = Universal Profiling -Elastic Universal Profiling is a whole-system, always-on, continuous profiling solution that eliminates the need for code instrumentation, recompilation, on-host debug symbols and service restarts. Leveraging eBPF technology, Universal Profiling operates within the Linux kernel space, capturing only the needed data with minimal overhead in an unobtrusive manner. For a quick overview of Universal Profiling, see the https://www.elastic.co/observability/ebpf-continuous-code-profiling[Universal Profiling product page]. +Elastic Universal Profiling is a whole-system, always-on, continuous profiling solution that eliminates the need for code instrumentation, recompilation, on-host debug symbols, and service restarts. Leveraging eBPF technology, Universal Profiling operates within the Linux kernel space, capturing only the needed data with minimal overhead in an unobtrusive manner. For a quick overview of Universal Profiling, see the https://www.elastic.co/observability/ebpf-continuous-code-profiling[Universal Profiling product page]. On this page, you'll find information on: From 9f54a64af62e18508ac310eb6eab9d481243ab93 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 3 Sep 2024 10:39:38 -0700 Subject: [PATCH 21/23] Move troubleshooting up a level in the nav --- docs/en/observability/index.asciidoc | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index 0e745b6696..e0f557521c 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -7,7 +7,7 @@ include::{docs-root}/shared/attributes.asciidoc[] include::landing-page/page.asciidoc[] -// Get started with Elastic Observability +// Group: Get started with Elastic Observability include::observability-get-started.asciidoc[leveloffset=+1] // What is Observability? @@ -100,14 +100,6 @@ include::troubleshoot-uptime-mapping-issues.asciidoc[leveloffset=+3] // Tutorials include::monitor-java-app.asciidoc[leveloffset=+1] - -// Troubleshooting -include::troubleshooting.asciidoc[leveloffset=+2] - -include::exploratory-data-visualizations.asciidoc[leveloffset=+3] - -include::inspect.asciidoc[leveloffset=+3] - // Single: Ci-cd observability include::ci-cd-observability.asciidoc[leveloffset=+1] @@ -213,6 +205,13 @@ include::logs-index-template.asciidoc[leveloffset=+2] include::logs-troubleshooting.asciidoc[leveloffset=+2] +// Troubleshooting +include::troubleshooting.asciidoc[leveloffset=+1] + +include::exploratory-data-visualizations.asciidoc[leveloffset=+2] + +include::inspect.asciidoc[leveloffset=+2] + // Group: Incident management include::incident-management.asciidoc[leveloffset=+1] From eedfc9808c5b7a5a12c3f704e4842ec1a556bdc4 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 3 Sep 2024 10:44:10 -0700 Subject: [PATCH 22/23] Delete old APM tutorial --- .../delete_traces-get-started.asciidoc | 107 ------------------ docs/en/observability/index.asciidoc | 3 - 2 files changed, 110 deletions(-) delete mode 100644 docs/en/observability/delete_traces-get-started.asciidoc diff --git a/docs/en/observability/delete_traces-get-started.asciidoc b/docs/en/observability/delete_traces-get-started.asciidoc deleted file mode 100644 index 3b42258e89..0000000000 --- a/docs/en/observability/delete_traces-get-started.asciidoc +++ /dev/null @@ -1,107 +0,0 @@ -[[traces-get-started]] -= Get started with application traces and APM - -++++ -Traces and APM -++++ - -//TODO: Delete this file. - -// 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/tab-widgets/install-agents-widget.asciidoc[] -endif::[] - -ifdef::apm-integration-docs[] -include::{observability-docs-root}/docs/en/observability/apm/tab-widgets/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 -{observability-guide}/apm-data-streams.html[APM data streams] - -[role="screenshot"] -image::images/kibana-apm-sample-data.png[APM UI with data] - -Not seeing any data? Review our list of {observability-guide}/apm-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[] diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index e0f557521c..f8e3dab042 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -22,9 +22,6 @@ include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+2] include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+2] -//TODO: Delete this file when we're sure we don't want to keep it -//include::traces-get-started.asciidoc[leveloffset=+3] - include::splunk-get-started.asciidoc[leveloffset=+2] // Group: Application and service monitoring From f8602d2eb9b5e976b2a3491a27e47b0fb7d5892f Mon Sep 17 00:00:00 2001 From: dedemorton Date: Wed, 4 Sep 2024 10:04:20 -0700 Subject: [PATCH 23/23] Fix jump tables --- .../application-and-service-monitoring.asciidoc | 2 -- ...nfrastructure-and-host-monitoring-intro.asciidoc | 13 ++++++++++++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/en/observability/application-and-service-monitoring.asciidoc b/docs/en/observability/application-and-service-monitoring.asciidoc index dde378f4e9..7f953dc382 100644 --- a/docs/en/observability/application-and-service-monitoring.asciidoc +++ b/docs/en/observability/application-and-service-monitoring.asciidoc @@ -24,6 +24,4 @@ Explore the topics in this section to learn how to observe and monitor software |<> |Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime. -|<> -|Troubleshoot issues across Observability apps: select and filter result data in any dimension, look for the cause or impact of performance problems, and view information about all requests that were made to collect the data displayed on the current page. |=== \ No newline at end of file diff --git a/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc b/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc index 95cae7f54d..a9a781cfa4 100644 --- a/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc +++ b/docs/en/observability/monitor-infra/infrastructure-and-host-monitoring-intro.asciidoc @@ -14,5 +14,16 @@ Explore the topics in this section to learn how to observe and monitor hosts and |<> |Profile all the code running on a machine, including application code, kernel, and third-party libraries. -|=== +|<> +|Observe all layers of your application, including the orchestration software itself. + +|<> +|Collect valuable metrics and logs from your nginx instances. + +|<> +|Troubleshoot common issues on your own or ask for help. + +|<> +|Learn about the key metrics displayed in the Infrastructure UI and how they are calculated. +|===