Skip to content

Commit 0b2d653

Browse files
Add EDOT mentions on landing pages (#3983)
This PR adds mentions of EDOT as the recommended/preferred option across Observability docs, normalizing EDOT as the preferred approach while preserving existing content. * Added EDOT recommendations: tips/notes in infrastructure, logs, APM, and CI/CD docs recommending EDOT Collector or EDOT SDKs as the preferred way to collect telemetry data * Updated placeholders: uses `{{edot}}` substitute where appropriate * Fixed linting errors: added missing `applies_to` tags and corrected invalid lifecycle values (`all`) Part of [#82](elastic/docs-team#82) Closes [#110](elastic/docs-team#110) LLM usage disclosure: I prompted Claude 4.5 Sonnet in Cursor to find instances where EDOT mentions are missing (according to the issue description and internal conversations about this audit), then reviewed the content manually and fixed Vale linting issues. --------- Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent ec28a27 commit 0b2d653

File tree

6 files changed

+30
-10
lines changed

6 files changed

+30
-10
lines changed

solutions/observability/apm/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Metrics are another vital source of information when debugging production system
2626

2727
## Give Elastic APM a try [give_elastic_apm_a_try]
2828

29-
Want to quickly spin up an APM deployment? Refer to [Get started for APM](/solutions/observability/apm/get-started.md). To host everything yourself instead, refer to [Set up APM Server](/solutions/observability/apm/apm-server/setup.md).
29+
Want to quickly spin up an APM deployment? Refer to [Get started for APM](/solutions/observability/apm/get-started.md). We recommend using the [Elastic Distributions of OpenTelemetry (EDOT)](/solutions/observability/apm/opentelemetry/index.md) to collect application telemetry data. To host everything yourself instead, refer to [Set up APM Server](/solutions/observability/apm/apm-server/setup.md).

solutions/observability/cicd.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
navigation_title: CI/CD
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/ci-cd-observability.html
5+
applies_to:
6+
stack: ga
57
products:
68
- id: observability
79
---
@@ -18,14 +20,18 @@ To provide monitoring dashboards, alerting, and root cause analysis on pipelines
1820

1921
## CI/CD observability architectures [ci-cd-architecture]
2022

21-
Using the APM Server, connect all your OpenTelemetry native CI/CD tools directly to Elastic {{observability}}.
23+
Use the {{apm-server}} to connect all your OpenTelemetry native CI/CD tools directly to Elastic {{observability}}.
24+
25+
:::{tip}
26+
We recommend using the [{{edot}} Collector](opentelemetry://reference/index.md) to collect CI/CD observability data.
27+
:::
2228

2329
:::{image} /solutions/images/observability-simple-arch-observability.png
2430
:alt: Simple architecture of CI/CD observability with Elastic
2531
:title: Architecture of CI/CD observability with Elastic
2632
:::
2733

28-
A more advanced CI/CD observability architecture includes an OpenTelemetry Collector deployed on the edge, next to the CI/CD tools. This architecture provides the following:
34+
A more advanced CI/CD observability architecture includes an [{{edot}} Collector](opentelemetry://reference/index.md) deployed on the edge, next to the CI/CD tools. This architecture provides the following:
2935

3036
* Low latency between the CI/CD tools and the collector is particularly beneficial to ephemeral tools like the otel-cli.
3137
* The ability to route the observability signals to multiple backends in addition to Elastic {{observability}}.

solutions/observability/infra-and-hosts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ products:
1717

1818
Explore the topics in this section to learn how to observe and monitor hosts and other systems running in your environment.
1919

20+
:::{tip}
21+
We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Collector](/solutions/observability/get-started/quickstart-monitor-hosts-with-opentelemetry.md) to collect infrastructure metrics and logs. You can also use the [Elastic Agent](/solutions/observability/infra-and-hosts/get-started-with-system-metrics.md) with integrations for infrastructure monitoring.
22+
:::
23+
2024
| | |
2125
| --- | --- |
2226
| [Analyze infrastructure and host metrics](/solutions/observability/infra-and-hosts/analyze-infrastructure-host-metrics.md) | 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. |

solutions/observability/infra-and-hosts/analyze-infrastructure-host-metrics.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ products:
1414

1515
Observability allows 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 data.
1616

17-
Using {{agent}} integrations, you can ingest and analyze metrics from servers, Docker containers, Kubernetes orchestrations, explore and analyze application telemetry, and more.
17+
:::{tip}
18+
We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Collector](/solutions/observability/get-started/quickstart-monitor-hosts-with-opentelemetry.md) to collect infrastructure metrics. You can also use {{agent}} integrations to ingest and analyze metrics from servers, Docker containers, {{k8s}} deployments, and more.
19+
:::
1820

1921
For more information, refer to the following links:
2022

solutions/observability/logs/ecs-formatted-application-logs.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/logs-ecs-application.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-ecs-application-logs.html
55
applies_to:
6-
stack: all
7-
serverless: all
6+
stack: ga
7+
serverless: ga
88
products:
99
- id: observability
1010
- id: cloud-serverless
1111
---
1212

1313
# ECS formatted application logs [logs-ecs-application]
1414

15-
Logs formatted in Elastic Common Schema (ECS) don’t require manual parsing, and the configuration can be reused across applications. ECS-formatted logs, when paired with an {{apm-agent}}, allow you to correlate logs to easily view logs that belong to a particular trace.
15+
Logs formatted in {{product.ecs}} don't require manual parsing, and the same ingest configuration can be reused across applications. ECS-formatted logs, when paired with an {{apm-agent}} or [{{edot}} SDKs](opentelemetry://reference/edot-sdks/index.md), allow you to correlate logs to easily view logs that belong to a particular trace.
16+
17+
:::{tip}
18+
We recommend using the [{{edot}} SDKs](opentelemetry://reference/edot-sdks/index.md) to instrument your applications and collect ECS-formatted logs with automatic log correlation. You can also format your logs in ECS format.
19+
:::
1620

1721
You can format your logs in ECS format the following ways:
1822

solutions/observability/logs/plaintext-application-logs.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/logs-plaintext.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-plaintext-application-logs.html
55
applies_to:
6-
stack: all
7-
serverless: all
6+
stack: ga
7+
serverless: ga
88
products:
99
- id: observability
1010
- id: cloud-serverless
@@ -31,7 +31,11 @@ To ingest, parse, and correlate plaintext logs:
3131
Send application logs to {{es}} using one of the following shipping tools:
3232

3333
* [{{filebeat}}](/solutions/observability/logs/plaintext-application-logs.md#ingest-plaintext-logs-with-filebeat) A lightweight data shipper that sends log data to {{es}}.
34-
* [{{agent}}](/solutions/observability/logs/plaintext-application-logs.md#ingest-plaintext-logs-with-the-agent) A single agent for logs, metrics, security data, and threat prevention. Combined with Fleet, you can centrally manage {{agent}} policies and lifecycles directly from {{kib}}.
34+
* [{{agent}}](/solutions/observability/logs/plaintext-application-logs.md#ingest-plaintext-logs-with-the-agent) A single agent that can collect logs, metrics, and security data, and protect your hosts. You can use {{fleet}} to manage {{agent}} policies and lifecycles directly from {{kib}}.
35+
36+
:::{tip}
37+
We recommend using the [{{edot}} Collector](/solutions/observability/logs/stream-any-log-file-using-edot-collector.md) to collect application logs.
38+
:::
3539

3640

3741
### Ingest logs with {{filebeat}} [ingest-plaintext-logs-with-filebeat]

0 commit comments

Comments
 (0)