Skip to content

Commit e001197

Browse files
authored
Update README.md
1 parent 15d3d03 commit e001197

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,35 @@ AWS Lambda is expected to recieve a [breaking change](https://aws.amazon.com/blo
1414

1515
## Installation
1616

17-
Check out our [installation instructions for Python](https://docs.datadoghq.com/serverless/installation/python/).
17+
Follow the [installation instructions](https://docs.datadoghq.com/serverless/installation/python/), and view your function's enhanced metrics, traces and logs in Datadog.
18+
19+
## Custom Metrics
20+
21+
Once [installed](#installation), you should be able to submit custom metrics from your Lambda function.
22+
23+
Check out the instructions for [submitting custom metrics from AWS Lambda functions](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#custom-metrics).
24+
25+
## Tracing
26+
27+
Once [installed](#installation), you should be able to view your function's traces in Datadog, and your function's logs should be automatically connected to the traces.
28+
29+
For additional details on trace collection, take a look at [collecting traces from AWS Lambda functions](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#trace-collection).
30+
31+
For additional details on trace and log connection, see [connecting logs and traces](https://docs.datadoghq.com/tracing/connect_logs_and_traces/python/).
32+
33+
For additional details on the tracer, check out the [official documentation for Datadog trace client](http://pypi.datadoghq.com/trace/docs/index.html).
34+
35+
## Enhanced Metrics
36+
37+
Once [installed](#installation), you should be able to view enhanced metrics for your Lambda function in Datadog.
38+
39+
Check out the official documentation on [Datadog Lambda enhanced metrics](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#real-time-enhanced-lambda-metrics).
1840

1941
## Environment Variables
2042

2143
### DD_FLUSH_TO_LOG
2244

23-
Set to `true` (recommended) to send custom metrics asynchronously (with no added latency to your Lambda function executions) through CloudWatch Logs with the help of [Datadog Forwarder](https://github.com/DataDog/datadog-serverless-functions/tree/master/aws/logs_monitoring). Defaultss to `false`. If set to `false`, you also need to set `DD_API_KEY` and `DD_SITE`.
45+
Set to `true` (recommended) to send custom metrics asynchronously (with no added latency to your Lambda function executions) through CloudWatch Logs with the help of [Datadog Forwarder](https://github.com/DataDog/datadog-serverless-functions/tree/master/aws/logs_monitoring). Defaults to `false`. If set to `false`, you also need to set `DD_API_KEY` and `DD_SITE`.
2446

2547
### DD_API_KEY
2648

@@ -44,7 +66,7 @@ If `DD_FLUSH_TO_LOG` is set to `false` (not recommended), and your data need to
4466

4567
### DD_LOGS_INJECTION
4668

47-
Inject Datadog trace id into logs for [correlation](https://docs.datadoghq.com/tracing/connect_logs_and_traces/?tab=python). Defaults to `true`.
69+
Inject Datadog trace id into logs for [correlation](https://docs.datadoghq.com/tracing/connect_logs_and_traces/python/). Defaults to `true`.
4870

4971
### DD_LOG_LEVEL
5072

@@ -56,28 +78,16 @@ Generate enhanced Datadog Lambda integration metrics, such as, `aws.lambda.enhan
5678

5779
### DD_LAMBDA_HANDLER
5880

59-
For use with the [redirected handler](#Redirected-Handler) method. Location of your original lambda handler.
81+
Your original Lambda handler.
6082

6183
### DD_TRACE_ENABLED
6284

63-
When used with the [redirected handler](#Redirected-Handler) method, will auto initialize the tracer when set to true. Defaults to `false`.
85+
Initialize the Datadog tracer when set to `true`. Defaults to `false`.
6486

6587
### DD_MERGE_XRAY_TRACES
6688

6789
Set to `true` to merge the X-Ray trace and the Datadog trace, when using both the X-Ray and Datadog tracing. Defaults to `false`.
6890

69-
## Custom Metrics
70-
71-
Check out the instructions for [submitting custom metrics from AWS Lambda functions](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#custom-metrics).
72-
73-
## Tracing
74-
75-
Check out the instructions for [collecting traces from AWS Lambda functions](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#trace-collection), and the [official documentation for Datadog trace client](http://pypi.datadoghq.com/trace/docs/index.html).
76-
77-
## Enhanced Metrics
78-
79-
Check out the official documentation on [Datadog Lambda enhanced metrics](https://docs.datadoghq.com/integrations/amazon_lambda/?tab=python#real-time-enhanced-lambda-metrics).
80-
8191
## Opening Issues
8292

8393
If you encounter a bug with this package, we want to hear about it. Before opening a new issue, search the existing issues to avoid duplicates.

0 commit comments

Comments
 (0)