Skip to content

Commit 9733787

Browse files
authored
[AWSX] fix(logs forwarder): Update docs on trace forwarding (#1047)
* [AWSX] fix(logs fowarder): Update docs on trace forwarding * fix wording * lint * update snapshots | redact lambda layer version * remove tag fetching from integration tests | update snapshots
1 parent e65a2ba commit 9733787

15 files changed

Lines changed: 151 additions & 381 deletions

aws/logs_monitoring/enhanced_lambda_metrics.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
logger.setLevel(logging.getLevelName(os.environ.get("DD_LOG_LEVEL", "INFO").upper()))
8686

8787
try:
88-
from datadog_lambda.metric import lambda_stats
88+
from datadog_lambda.metric import lambda_metric
8989

9090
DD_SUBMIT_ENHANCED_METRICS = True
9191
except ImportError:
@@ -136,9 +136,7 @@ def submit_to_dd(self):
136136
logger.debug(
137137
"Submitting metric {} {} {}".format(self.name, self.value, self.tags)
138138
)
139-
lambda_stats.distribution(
140-
self.name, self.value, timestamp=timestamp, tags=self.tags
141-
)
139+
lambda_metric(self.name, self.value, timestamp=timestamp, tags=self.tags)
142140

143141

144142
def get_last_modified_time(s3_file):

aws/logs_monitoring/forwarder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ def _forward_logs(self, logs, key=None):
144144
def _forward_metrics(self, metrics, key=None):
145145
"""
146146
Forward custom metrics submitted via logs to Datadog in a background thread
147-
using `lambda_stats` that is provided by the Datadog Python Lambda Layer.
147+
using `lambda_metric` that is provided by the Datadog Python Lambda Layer.
148148
"""
149149
if logger.isEnabledFor(logging.DEBUG):
150150
logger.debug(f"Forwarding {len(metrics)} metrics")

aws/logs_monitoring/template.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,11 +292,14 @@ Parameters:
292292
- CRITICAL
293293
DdTraceEnabled:
294294
Type: String
295-
Default: "true"
295+
Default: "false"
296296
AllowedValues:
297297
- "true"
298298
- "false"
299-
Description: Set to false to disable trace creation and forwarding for the forwarder itself. Enabling this may incur additional Serverless APM charges. See https://docs.datadoghq.com/tracing/trace_collection/library_config/python/#traces
299+
Description: |
300+
Set to true to enable trace creation for the forwarder itself.
301+
Lambda forwarder should be instrumented to forward these traces to Datadog, see https://docs.datadoghq.com/serverless/aws_lambda/.
302+
Enabling this may incur additional Serverless APM charges. See https://docs.datadoghq.com/tracing/trace_collection/library_config/python/#traces.
300303
DdEnhancedMetrics:
301304
Type: String
302305
Default: "false"

aws/logs_monitoring/tools/integration_tests/docker-compose.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
version: "3.8"
2-
31
services:
42
recorder:
53
image: ${PYTHON_BASE}

aws/logs_monitoring/tools/integration_tests/integration_tests.sh

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ SNAPSHOT_DIR="${INTEGRATION_TESTS_DIR}/${SNAPSHOTS_DIR_NAME}/*"
2020
SNAPS=($SNAPSHOT_DIR)
2121
ADDITIONAL_LAMBDA=false
2222
CACHE_TEST=false
23-
DD_FETCH_LAMBDA_TAGS="true"
24-
DD_FETCH_LOG_GROUP_TAGS="true"
25-
DD_FETCH_STEP_FUNCTIONS_TAGS="true"
26-
DD_STORE_FAILED_EVENTS="true"
23+
DD_FETCH_LAMBDA_TAGS="false"
24+
DD_FETCH_LOG_GROUP_TAGS="false"
25+
DD_FETCH_STEP_FUNCTIONS_TAGS="false"
26+
DD_STORE_FAILED_EVENTS="false"
2727

2828
script_start_time=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
2929
echo "Starting script time: $script_start_time"
@@ -85,6 +85,8 @@ if [ $CACHE_TEST == true ]; then
8585

8686
SNAPSHOTS_DIR_NAME="snapshots-cache-test"
8787
DD_FETCH_LAMBDA_TAGS="true"
88+
DD_FETCH_LOG_GROUP_TAGS="true"
89+
DD_FETCH_STEP_FUNCTIONS_TAGS="true"
8890

8991
# Deploy test lambda function with tags
9092
AWS_LAMBDA_FUNCTION_INVOKED="cache_test_lambda"

aws/logs_monitoring/tools/integration_tests/snapshots/cloudwatch_customized_log_group_lambda_invocation.json~snapshot

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -91,51 +91,6 @@
9191
{
9292
"data": {
9393
"series": [
94-
{
95-
"device": null,
96-
"host": null,
97-
"interval": 10,
98-
"metric": "aws.dd_forwarder.loggroup_cache_fetch_failure",
99-
"points": "<redacted from snapshot>",
100-
"tags": [
101-
"forwardername:test_function",
102-
"forwarder_memorysize:3008",
103-
"forwarder_version:<redacted from snapshot>",
104-
"event_type:awslogs",
105-
"dd_lambda_layer:datadog-python313_8.120.0"
106-
],
107-
"type": "distribution"
108-
},
109-
{
110-
"device": null,
111-
"host": null,
112-
"interval": 10,
113-
"metric": "aws.dd_forwarder.list_tags_log_group_api_call",
114-
"points": "<redacted from snapshot>",
115-
"tags": [
116-
"forwardername:test_function",
117-
"forwarder_memorysize:3008",
118-
"forwarder_version:<redacted from snapshot>",
119-
"event_type:awslogs",
120-
"dd_lambda_layer:datadog-python313_8.120.0"
121-
],
122-
"type": "distribution"
123-
},
124-
{
125-
"device": null,
126-
"host": null,
127-
"interval": 10,
128-
"metric": "aws.dd_forwarder.loggroup_cache_write_failure",
129-
"points": "<redacted from snapshot>",
130-
"tags": [
131-
"forwardername:test_function",
132-
"forwarder_memorysize:3008",
133-
"forwarder_version:<redacted from snapshot>",
134-
"event_type:awslogs",
135-
"dd_lambda_layer:datadog-python313_8.120.0"
136-
],
137-
"type": "distribution"
138-
},
13994
{
14095
"device": null,
14196
"host": null,
@@ -147,7 +102,7 @@
147102
"forwarder_memorysize:3008",
148103
"forwarder_version:<redacted from snapshot>",
149104
"event_type:awslogs",
150-
"dd_lambda_layer:datadog-python313_8.120.0"
105+
"dd_lambda_layer:<redacted from snapshot>"
151106
],
152107
"type": "distribution"
153108
},
@@ -162,7 +117,7 @@
162117
"forwarder_memorysize:3008",
163118
"forwarder_version:<redacted from snapshot>",
164119
"event_type:awslogs",
165-
"dd_lambda_layer:datadog-python313_8.120.0"
120+
"dd_lambda_layer:<redacted from snapshot>"
166121
],
167122
"type": "distribution"
168123
},
@@ -177,7 +132,7 @@
177132
"forwarder_memorysize:3008",
178133
"forwarder_version:<redacted from snapshot>",
179134
"event_type:awslogs",
180-
"dd_lambda_layer:datadog-python313_8.120.0"
135+
"dd_lambda_layer:<redacted from snapshot>"
181136
],
182137
"type": "distribution"
183138
}

aws/logs_monitoring/tools/integration_tests/snapshots/cloudwatch_log.json~snapshot

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -64,51 +64,6 @@
6464
{
6565
"data": {
6666
"series": [
67-
{
68-
"device": null,
69-
"host": null,
70-
"interval": 10,
71-
"metric": "aws.dd_forwarder.loggroup_cache_fetch_failure",
72-
"points": "<redacted from snapshot>",
73-
"tags": [
74-
"forwardername:test_function",
75-
"forwarder_memorysize:3008",
76-
"forwarder_version:<redacted from snapshot>",
77-
"event_type:awslogs",
78-
"dd_lambda_layer:datadog-python313_8.120.0"
79-
],
80-
"type": "distribution"
81-
},
82-
{
83-
"device": null,
84-
"host": null,
85-
"interval": 10,
86-
"metric": "aws.dd_forwarder.list_tags_log_group_api_call",
87-
"points": "<redacted from snapshot>",
88-
"tags": [
89-
"forwardername:test_function",
90-
"forwarder_memorysize:3008",
91-
"forwarder_version:<redacted from snapshot>",
92-
"event_type:awslogs",
93-
"dd_lambda_layer:datadog-python313_8.120.0"
94-
],
95-
"type": "distribution"
96-
},
97-
{
98-
"device": null,
99-
"host": null,
100-
"interval": 10,
101-
"metric": "aws.dd_forwarder.loggroup_cache_write_failure",
102-
"points": "<redacted from snapshot>",
103-
"tags": [
104-
"forwardername:test_function",
105-
"forwarder_memorysize:3008",
106-
"forwarder_version:<redacted from snapshot>",
107-
"event_type:awslogs",
108-
"dd_lambda_layer:datadog-python313_8.120.0"
109-
],
110-
"type": "distribution"
111-
},
11267
{
11368
"device": null,
11469
"host": null,
@@ -120,7 +75,7 @@
12075
"forwarder_memorysize:3008",
12176
"forwarder_version:<redacted from snapshot>",
12277
"event_type:awslogs",
123-
"dd_lambda_layer:datadog-python313_8.120.0"
78+
"dd_lambda_layer:<redacted from snapshot>"
12479
],
12580
"type": "distribution"
12681
},
@@ -135,7 +90,7 @@
13590
"forwarder_memorysize:3008",
13691
"forwarder_version:<redacted from snapshot>",
13792
"event_type:awslogs",
138-
"dd_lambda_layer:datadog-python313_8.120.0"
93+
"dd_lambda_layer:<redacted from snapshot>"
13994
],
14095
"type": "distribution"
14196
},
@@ -150,7 +105,7 @@
150105
"forwarder_memorysize:3008",
151106
"forwarder_version:<redacted from snapshot>",
152107
"event_type:awslogs",
153-
"dd_lambda_layer:datadog-python313_8.120.0"
108+
"dd_lambda_layer:<redacted from snapshot>"
154109
],
155110
"type": "distribution"
156111
}

aws/logs_monitoring/tools/integration_tests/snapshots/cloudwatch_log_cloudtrail.json~snapshot

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -100,51 +100,6 @@
100100
{
101101
"data": {
102102
"series": [
103-
{
104-
"device": null,
105-
"host": null,
106-
"interval": 10,
107-
"metric": "aws.dd_forwarder.loggroup_cache_fetch_failure",
108-
"points": "<redacted from snapshot>",
109-
"tags": [
110-
"forwardername:test_function",
111-
"forwarder_memorysize:3008",
112-
"forwarder_version:<redacted from snapshot>",
113-
"event_type:awslogs",
114-
"dd_lambda_layer:datadog-python313_8.120.0"
115-
],
116-
"type": "distribution"
117-
},
118-
{
119-
"device": null,
120-
"host": null,
121-
"interval": 10,
122-
"metric": "aws.dd_forwarder.list_tags_log_group_api_call",
123-
"points": "<redacted from snapshot>",
124-
"tags": [
125-
"forwardername:test_function",
126-
"forwarder_memorysize:3008",
127-
"forwarder_version:<redacted from snapshot>",
128-
"event_type:awslogs",
129-
"dd_lambda_layer:datadog-python313_8.120.0"
130-
],
131-
"type": "distribution"
132-
},
133-
{
134-
"device": null,
135-
"host": null,
136-
"interval": 10,
137-
"metric": "aws.dd_forwarder.loggroup_cache_write_failure",
138-
"points": "<redacted from snapshot>",
139-
"tags": [
140-
"forwardername:test_function",
141-
"forwarder_memorysize:3008",
142-
"forwarder_version:<redacted from snapshot>",
143-
"event_type:awslogs",
144-
"dd_lambda_layer:datadog-python313_8.120.0"
145-
],
146-
"type": "distribution"
147-
},
148103
{
149104
"device": null,
150105
"host": null,
@@ -156,7 +111,7 @@
156111
"forwarder_memorysize:3008",
157112
"forwarder_version:<redacted from snapshot>",
158113
"event_type:awslogs",
159-
"dd_lambda_layer:datadog-python313_8.120.0"
114+
"dd_lambda_layer:<redacted from snapshot>"
160115
],
161116
"type": "distribution"
162117
},
@@ -171,7 +126,7 @@
171126
"forwarder_memorysize:3008",
172127
"forwarder_version:<redacted from snapshot>",
173128
"event_type:awslogs",
174-
"dd_lambda_layer:datadog-python313_8.120.0"
129+
"dd_lambda_layer:<redacted from snapshot>"
175130
],
176131
"type": "distribution"
177132
},
@@ -186,7 +141,7 @@
186141
"forwarder_memorysize:3008",
187142
"forwarder_version:<redacted from snapshot>",
188143
"event_type:awslogs",
189-
"dd_lambda_layer:datadog-python313_8.120.0"
144+
"dd_lambda_layer:<redacted from snapshot>"
190145
],
191146
"type": "distribution"
192147
}

0 commit comments

Comments
 (0)