diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 87a70788b..155319861 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -23,12 +23,12 @@ include::./api.asciidoc[] include::./metrics.asciidoc[] +include::./logs.asciidoc[] + include::./opentracing.asciidoc[] include::./graphql.asciidoc[] -include::./log-correlation.asciidoc[] - include::./performance-tuning.asciidoc[] include::./debugging.asciidoc[] diff --git a/docs/log-correlation.asciidoc b/docs/logs.asciidoc similarity index 80% rename from docs/log-correlation.asciidoc rename to docs/logs.asciidoc index 7d5d2fcde..d96587f33 100644 --- a/docs/log-correlation.asciidoc +++ b/docs/logs.asciidoc @@ -3,8 +3,26 @@ NOTE: For the best reading experience, please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co] endif::[] -[[log-correlation]] -== Log correlation +[[logs]] +== Logs + +Elastic Ruby APM Agent provides the following log features: + +- <>: Automatically inject correlation IDs that allow navigation between logs, traces and services. +- <>: Automatically reformat plaintext logs in {ecs-logging-ref}/intro.html[ECS logging] format. + +Those features are part of {observability-guide}/application-logs.html[Application log ingestion strategies]. + +The {ecs-logging-ruby-ref}/intro.html[`ecs-logging-ruby`] library can also be used to format logs in the {ecs-logging-ref}/intro.html[ECS logging] format without an APM agent. +When deployed with the Ruby APM agent, the agent will provide <> IDs. + +[float] +[[log-correlation-ids]] +=== Log correlation + +{apm-guide-ref}/log-correlation.html[Log correlation] allows you to navigate to all logs belonging to a particular trace +and vice-versa: for a specific log, see in which context it has been logged and which parameters the user provided. + Trace/log correlation can be set up in three different ways. @@ -119,3 +137,12 @@ PUT _ingest/pipeline/extract_trace_id ---- Please see {apm-guide-ref}/log-correlation.html[Observability integrations] for more information. + +[float] +[[log-reformatting]] +=== Log reformatting (experimental) + +Log reformatting is controlled by the <> configuration option, and is disabled by default. + +The reformatted logs will include both the <> IDs. + diff --git a/docs/opentracing.asciidoc b/docs/opentracing.asciidoc index 1994f47bf..78ea4e862 100644 --- a/docs/opentracing.asciidoc +++ b/docs/opentracing.asciidoc @@ -89,6 +89,6 @@ The `Span.set_baggage` method is not supported. Baggage items are dropped with a warning log message. [float] -[[logs]] +[[opentracing-logs]] === Logs Logs are currently not supported. diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc new file mode 100644 index 000000000..9f4a61aff --- /dev/null +++ b/docs/redirects.asciidoc @@ -0,0 +1,9 @@ +["appendix",role="exclude",id="redirects"] += Deleted pages + +The following pages have moved or been deleted. + +[role="exclude",id="log-correlation"] +=== Log correlation + +This section has moved. See <>.