Skip to content

Commit 2af0e9f

Browse files
authored
Add note on o11y to architecture guide (#131291)
Adds brief overview that mostly just serves as a location for links to other more comprehensive design documentation elsewhere in the source tree. Closes ES-9874
1 parent ebdfa9c commit 2af0e9f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/internal/GeneralArchitectureGuide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,20 @@ See the [public upgrade docs][] for the upgrade process.
298298

299299
(what plugins do we have?)
300300

301+
# Observability
302+
303+
Elasticsearch emits logs as described in the [public logging docs][], and exposes a good deal of information about its inner workings using
304+
all its management and stats APIs. Elasticsearch also integrates with the [Elastic APM Java agent][] to perform distributed tracing (as
305+
described in [TRACING.md][]) and metrics collection (as described in [METERING.md][]). This agent exposes the data it collects to an
306+
[OpenTelemetry][] service such as [Elastic APM Server][].
307+
308+
[public logging docs]: https://www.elastic.co/docs/deploy-manage/monitor/logging-configuration
309+
[Elastic APM Java agent]: https://www.elastic.co/docs/reference/apm/agents/java
310+
[OpenTelemetry]: https://opentelemetry.io/
311+
[Elastic APM Server]: https://www.elastic.co/docs/solutions/observability/apm
312+
[TRACING.md]: https://github.com/elastic/elasticsearch/blob/v8.18.3/TRACING.md
313+
[METERING.md]: https://github.com/elastic/elasticsearch/blob/v8.18.3/modules/apm/METERING.md
314+
301315
# Testing
302316

303317
(Overview of our testing frameworks. Discuss base test classes.)

0 commit comments

Comments
 (0)