Skip to content

Commit 007ba52

Browse files
authored
Create new IA for observability docs (#4134)
* Create new IA for observability docs * Try making the nav titles shorter * Align TOC with latest outline * Fix link text and rename analyze-metrics file * Add redirect page for observability tutorials * Add content to start here topic * Add content to overview topic about monitoring applications and services * Add content to overview topic about incident management * Remove old tutorial container topic * Apply changes from colleenmcginnis * Apply feedback from alaudazzi * More K8s tutorial to infra/hosts monitoring section * Add getting started change and other changes requested by obs docs * Fix broken apm links * Apply more link fixes * Reorganize getting started/quick start section * Resolve or remove related TODOs * Update docs/en/observability/splunk-get-started.asciidoc * Make changes to getting started section * Move universal profiling to section about infra monitoring * Move troubleshooting up a level in the nav * Delete old APM tutorial * Fix jump tables
1 parent fc7581c commit 007ba52

File tree

48 files changed

+433
-421
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+433
-421
lines changed

docs/en/apm-server/redirects.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ Refer to {observability-guide}/apm.html[Application Performance Monitoring (APM)
428428

429429
{move-notice}
430430

431-
Refer to {observability-guide}/traces-get-started.html[Quick start with Elastic Cloud].
431+
Refer to {observability-guide}/get-started-with-fleet-apm-server.html[Quick start with Elastic Cloud].
432432

433433
[role="exclude",id="getting-started-apm-server"]
434434
=== Self manage APM Server
@@ -491,7 +491,7 @@ Refer to {observability-guide}/apm-running-on-docker.html[Run APM Server on Dock
491491

492492
{move-notice}
493493

494-
Refer to {observability-guide}/_fleet_managed_apm_server.html[Fleet-managed APM Server].
494+
Refer to {observability-guide}/get-started-with-fleet-apm-server.html[Fleet-managed APM Server].
495495

496496
[role="exclude",id="_step_1_set_up_fleet"]
497497
=== Step 1: Set up Fleet
@@ -505,7 +505,7 @@ Refer to {observability-guide}/_step_1_set_up_fleet.html[Step 1: Set up Fleet].
505505

506506
{move-notice}
507507

508-
Refer to {observability-guide}/_step_2_add_and_configure_the_apm_integration.html[Step 2: Add and configure the APM integration].
508+
Refer to {observability-guide}/add-apm-integration.html[Step 2: Add and configure the APM integration].
509509

510510
[role="exclude",id="_step_3_install_apm_agents"]
511511
=== Step 3: Install APM agents

docs/en/observability/apm-ui/new-experience-services.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ which means that other users need to turn on the new experience if they want to
4747
To add services to the inventory, use one of the following approaches:
4848

4949
* Instrument your services with APM or OpenTelemetry.
50-
To learn how, refer to <<traces-get-started>>.
50+
To learn how, refer to <<get-started-with-fleet-apm-server>>.
5151
* Declare `service.name` in your logs. To learn how, <<add-logs-service-name>>.

docs/en/observability/apm.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ like JVM metrics in the Java Agent, and Go runtime metrics in the Go Agent.
4343
[float]
4444
=== Give Elastic APM a try
4545

46-
Use <<traces-get-started,Get started with application traces and APM>> to quickly spin up an APM deployment.
46+
Use <<get-started-with-fleet-apm-server,Get started with application traces and APM>> to quickly spin up an APM deployment.
4747
Want to host everything yourself instead? See <<apm-getting-started-apm-server>>.
4848

4949
include::{observability-docs-root}/docs/en/observability/apm/getting-started-apm-server.asciidoc[]

docs/en/observability/apm/apm-quick-start.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[[apm-quick-start]]
22
== Quick start with {ecloud}
33

4+
TODO: Ask Colleen if this file should be deleted.
5+
46
The easiest way to get started with Elastic APM is by using our
57
{ess-product}[hosted {es} Service] on {ecloud}.
68
The {es} Service is available on AWS, GCP, and Azure.

docs/en/observability/apm/getting-started-apm-server.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
TIP: The easiest way to get started with Elastic APM is by using our
99
{ess-product}[hosted {es} Service] on {ecloud}.
1010
The {es} Service is available on AWS, GCP, and Azure.
11-
See <<traces-get-started,getting started documentation>> to get started in minutes.
11+
See <<get-started-with-fleet-apm-server,getting started documentation>> to get started in minutes.
1212

1313

1414
// TODO: MOVE THIS
@@ -475,7 +475,7 @@ include::{observability-docs-root}/docs/en/observability/apm/repositories.asciid
475475
// Shared docker
476476
include::{observability-docs-root}/docs/en/observability/apm/shared-docker.asciidoc[]
477477

478-
478+
[[get-started-with-fleet-apm-server]]
479479
=== Fleet-managed APM Server
480480

481481
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
498498

499499
For more information, refer to {fleet-guide}/fleet-server.html[{fleet-server}].
500500

501+
[[add-apm-integration]]
501502
==== Step 2: Add and configure the APM integration
502503

503504
include::{observability-docs-root}/docs/en/observability/tab-widgets/add-apm-integration/content.asciidoc[tag=self-managed]

docs/en/observability/apm/setting-up-and-running.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<titleabbrev>Advanced setup</titleabbrev>
77
++++
88

9-
Before reading this section, see the <<traces-get-started,getting started documentation>>
9+
Before reading this section, see the <<get-started-with-fleet-apm-server,getting started documentation>>
1010
for basic installation and running instructions.
1111

1212
This section includes additional information on how to set up and run APM Server, including:
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[[application-and-service-monitoring]]
2+
= Application and service monitoring
3+
4+
++++
5+
<titleabbrev>Applications and services</titleabbrev>
6+
++++
7+
8+
Explore the topics in this section to learn how to observe and monitor software applications and services running in your environment.
9+
10+
[cols="1,1"]
11+
|===
12+
|<<apm>>
13+
|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.
14+
15+
|<<monitor-uptime-synthetics>>
16+
|Monitor the availability of network endpoints and services.
17+
18+
|<<user-experience>>
19+
|Quantify and analyze the perceived performance of your web application using real-world user experiences.
20+
21+
|<<uptime-intro>>
22+
|Periodically check the status of your services and applications.
23+
24+
|<<monitor-java-app>>
25+
|Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime.
26+
27+
|===

docs/en/observability/ci-cd-observability.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
[[ci-cd-observability]]
2-
= CI/CD observability
2+
= Continuous Integration and Continuous Delivery (CI/CD) monitoring
33
:figure-caption!:
44

5+
++++
6+
<titleabbrev>CI/CD</titleabbrev>
7+
++++
8+
59
To help administrators monitor and troubleshoot their CI/CD platform and help developers
610
increase the speed and reliability of their CI/CD pipelines, Elastic {observability}
711
provides visibility in Continuous Integration and Continuous Delivery (CI/CD) processes.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[[cloud-monitoring]]
2+
= Cloud monitoring
3+
4+
++++
5+
<titleabbrev>Cloud</titleabbrev>
6+
++++
7+
8+
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.
9+
10+
[cols="1,1"]
11+
|===
12+
|<<monitor-amazon-web-services>>
13+
|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.
14+
15+
|<<monitor-azure-web-services>>
16+
|Get visibility into your key Azure services including through secure native integration within the Azure console.
17+
18+
|<<monitor-gcp>>
19+
|Track performance of your Google Cloud services, including through agentless data ingestion with Google Pub/Sub.
20+
|===
21+
22+
23+

docs/en/observability/cloud-monitoring/aws/monitor-amazon-ec2.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Monitor Amazon Cloud Compute (EC2)
33

44
++++
5-
<titleabbrev>Monitor EC2</titleabbrev>
5+
<titleabbrev>EC2</titleabbrev>
66
++++
77

88
https://aws.amazon.com/ec2[Elastic Compute Cloud (Amazon EC2)] enables
@@ -115,7 +115,7 @@ workloads.
115115
A burstable performance instance configured as unlimited can sustain high CPU
116116
utilization for any period of time whenever required. T4g, T3a, and T3 instances
117117
launch as unlimited by default. If the average CPU usage over a 24-hour period
118-
exceeds the baseline, you incur charges for surplus credits.
118+
exceeds the baseline, you incur charges for surplus credits.
119119
+
120120
The CPU surplus credit balance metric tracks the accumulated balance. The CPU
121121
surplus credit charged measures extra credits that will result in additional
@@ -227,7 +227,7 @@ of related EC2 instances.
227227
+
228228
The Elastic EC2 integration comes with a default dashboard that shows key
229229
metrics like status check, CPU utilization, Disk I/O, and network throughput. It
230-
also provides filtering for region, availability zone, and machine type.
230+
also provides filtering for region, availability zone, and machine type.
231231

232232
`aws.ec2.metrics.StatusCheckFailed_Instance.avg`::
233233
This check monitors the software and network configuration of the instance.
@@ -236,7 +236,7 @@ networking or startup configuration, exhausted memory, corrupted file system,
236236
incompatible kernel, and so on. When an instance status check fails, you
237237
typically must address the problem yourself. You may need to reboot the instance
238238
or make instance configuration changes. To troubleshoot instances with failed
239-
status checks, refer to the
239+
status checks, refer to the
240240
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html[Amazon EC2 documentation].
241241
+
242242
This check returns 0 (passed) if an instance passes the system status check or 1

0 commit comments

Comments
 (0)