Introduce TraceFormatter, add log correlation docs #635
Conversation
Introduce TraceFormatter, a function taking a context and returning a fmt.Formatter that can format trace, transaction, and span IDs.
Codecov Report
@@ Coverage Diff @@
## master #635 +/- ##
==========================================
+ Coverage 84.55% 87.78% +3.22%
==========================================
Files 122 123 +1
Lines 7493 7522 +29
==========================================
+ Hits 6336 6603 +267
+ Misses 823 816 -7
+ Partials 334 103 -231
Continue to review full report at Codecov.
|
| ---- | ||
|
|
||
| You can follow this article in order to ingest JSON-encoded logs with Filebeat: | ||
| {blog-ref}how-to-instrument-your-go-app-with-the-elastic-apm-go-agent#logs[How to instrument your Go app with the Elastic APM Go agent]. |
There was a problem hiding this comment.
I agree that the content of this link is better suited for a blog post than documentation, but I'm wondering if you think it's possible/useful to include some of this information in the docs?
There was a problem hiding this comment.
I would love to see more guided walkthroughs in our docs in general. For the specific case of how to ingest JSON logs using Filebeat, to me it seems more appropriate to add it to FIlebeat docs than here. WDYT?
There was a problem hiding this comment.
Yeah, it's a tough line to toe. Our docs are so difficult to navigate cross-stack that I worry about users getting lost along the way. With this in mind, I've added a small amount of Filebeat information to the central documentation for this feature -- with the hopes that it will be helpful enough for users, and not be too difficult to maintain.
There was a problem hiding this comment.
Cool, I'll link to that instead then.
There was a problem hiding this comment.
... of course that's not actually merged yet, so I can't. I'll update the Go docs once that's merged and released.
Introduce TraceFormatter, a function taking a context and returning a fmt.Formatter that can format trace, transaction, and span IDs.
Also, add documentation around log correlation.