Skip to content

Commit

Permalink
docs: add log correlation info to plaintext
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 committed Jan 24, 2023
1 parent 5609196 commit ce3ebd1
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/en/observability/application-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,26 @@ For example, the same example shown above might look like this when structured w
[[log-correlation]]
== Log correlation

To correlate your logs, you must annotate your logs with the APM identifier, `service.name`.
Elastic APM integrates with the most popular logging frameworks in each programming language to accomplish this automatically.

// tag::correlate-logs[]
Correlating your application logs with trace events allows you to:

* view the context of a log and the parameters a user provided
* view all logs belonging to a particular trace
* easily move between logs and traces when debugging application issues in {kib}

To correlate your logs, you must add APM identifiers,
like trace, transaction, and error ID fields into your application's logs.
Elastic APM integrates with the most popular logging frameworks in each programming language to accomplish this automatically.

Learn more about log correlation in the APM Guide: {apm-guide-ref}/log-correlation.html[log correlation]
Or in any of the agent-specific ingestion guides:
Learn more about log correlation in the APM Guide: {apm-guide-ref}/log-correlation.html[log correlation],
or in any of the agent-specific ingestion guides:

* {apm-go-ref}/log-correlation.html[Go]
* {apm-java-ref}/log-correlation.html[Java]
* {apm-dotnet-ref}/log-correlation.html[.NET]
* {apm-node-ref}/log-correlation.html[Node.js]
* {apm-py-ref}/log-correlation.html[Python]
* {apm-ruby-ref}/log-correlation.html[Ruby]
// end::correlate-logs[]

[float]
[[ingest-application-logs]]
Expand Down Expand Up @@ -214,7 +215,12 @@ To learn how to use the Grok processor to parse application logs before indexing
see {ref}/common-log-format-example.html[Example: Parse logs in the Common Log Format].

[float]
=== Step 3: View your logs in {kib}
=== Step 3: Correlate your logs

include::application-logs.asciidoc[tag=correlate-logs]

[float]
=== Step 4: View your logs in {kib}

Use the <<apm,APM>> or <<monitor-logs,Logs>> UI to search, filter, and visualize your logs.

Expand Down

0 comments on commit ce3ebd1

Please sign in to comment.