Add documentation and example for adding request ID to logs. #65
Conversation
Codecov Report
@@ Coverage Diff @@
## master #65 +/- ##
=======================================
Coverage 90.72% 90.72%
=======================================
Files 25 25
Lines 744 744
Branches 122 122
=======================================
Hits 675 675
Misses 43 43
Partials 26 26 Continue to review full report at Codecov.
|
|
The example is based on https://getpino.io/#/?id=usage , for reference. |
| @@ -136,6 +136,36 @@ sendDistributionMetric( | |||
|
|
|||
| If your Lambda function is associated with a VPC, you need to ensure it has access to the [public internet](https://aws.amazon.com/premiumsupport/knowledge-center/internet-access-lambda-function/). | |||
|
|
|||
There was a problem hiding this comment.
I think this title can be misleading, because this only applies when you are not using datadog tracer.
There was a problem hiding this comment.
I think we should have a section Trace & Log Correlation and break it down by using datadog tracer and using xray tracer.
There was a problem hiding this comment.
Let's move the description for DD_LOGS_INJECTION to this new section with a link, since it's getting a little bit complicated.
There was a problem hiding this comment.
Using the datadog tracer, trace-log correlation should just work, right? Or is there something special they need to do?
There was a problem hiding this comment.
Correct, it just works if I'm using datadog tracer. However, reading this section as a user, I wouldn't know that. Even if I'm using the datadog tracer, I still might think I need to follow the instructions in this section.
There was a problem hiding this comment.
I don't think this is a super big deal though, definitely not a blocker for merging this PR, we can always improve the structure later.
Co-Authored-By: Stephen Firrincieli <[email protected]>
README.md
Outdated
| for `console.log()`, but you will have to implement this for other logging libraries. | ||
|
|
||
| The AWS Request ID is available in the context that is passed to your lambda handler, | ||
| as `context.awsRequestId`. It should be included in your log line as `@lambda.request_id`. |
README.md
Outdated
| See instructions for [manual](https://docs.datadoghq.com/tracing/connect_logs_and_traces/?tab=nodejs#manual-trace-id-injection) trace id injection, if using other logging libraries. | ||
|
|
||
| Set the environment variable `DD_LOGS_INJECTION` to `false` to disable this feature. | ||
| Controlls whether or not the request ID is injected into log lines. See [DD_LOGS_INJECTION](#DD_LOGS_INJECTION-environment-variable) under |
There was a problem hiding this comment.
@DarcyRaynerDD correct me if i'm wrong. I thought DD_LOG_INJECTION only inject datadog trace id into logs?
There was a problem hiding this comment.
Okay yep, I misread the other section.
README.md
Outdated
|
|
||
| ### Using the Datadog Tracer | ||
|
|
||
| If you are using the [Datadog Tracer](#datadog-tracer-experimental), your log messages |
There was a problem hiding this comment.
This isn't quite true. You still need to follow the steps (here)[https://docs.datadoghq.com/tracing/connect_logs_and_traces/nodejs/]
What does this PR do?
This adds documentation around how to add the AWS request ID to logs when using a custom logger, in order to achieve trace-log correlation.