Disable the fs module integration by default in the tracer (#103)

* disable fs by default * format * just pass in the env var for dd-trace * use undefined instead for empty string * modify readme * fix readme * cr feedback
DataDog · Oct 5, 2020 · 4747521 · 4747521
1 parent 4a6fb03
commit 4747521
Show file tree

Hide file tree

Showing 21 changed files with 19 additions and 173 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,8 @@ For additional details on trace collection, take a look at [collecting traces fr
 
 For additional details on trace and log connection, check out the [official documentation for Datadog trace client](https://datadoghq.dev/dd-trace-js/).
 
+The `fs` module is disabled by default. If you want to enable it you have to set the environment variable `DD_TRACE_DISABLED_PLUGINS` to `''` or to a comma-separated list of the plugins you want to disable. See the full list of supported plugins [here](https://docs.datadoghq.com/tracing/compatibility_requirements/nodejs/).
+
 ### Trace & Log Correlation
 
 By default, the Datadog trace id gets automatically injected into the logs for correlation, if using `console` or a logging library supported for automatic trace id injection. You have to manually inject the trace id, if using other logging libraries. See additional details on [connecting logs and traces](https://docs.datadoghq.com/tracing/connect_logs_and_traces/nodejs/).

diff --git a/integration_tests/http-errors.js b/integration_tests/http-errors.js
diff --git a/integration_tests/serverless-plugin.yml b/integration_tests/serverless-plugin.yml
@@ -87,23 +87,6 @@ functions:
       WITH_PLUGIN: true
       DD_FLUSH_TO_LOG: true
 
-  # http-errors
-  http-errors_node10_with_plugin:
-    handler: http-errors.handle
-    runtime: nodejs10.x
-    layers:
-      - { Ref: Node10LambdaLayer }
-    environment:
-      WITH_PLUGIN: true
-
-  http-errors_node12_with_plugin:
-    handler: http-errors.handle
-    runtime: nodejs12.x
-    layers:
-      - { Ref: Node12LambdaLayer }
-    environment:
-      WITH_PLUGIN: true
-
 plugins:
   - serverless-plugin-datadog
 

diff --git a/integration_tests/serverless.yml b/integration_tests/serverless.yml
@@ -77,17 +77,3 @@ functions:
       - { Ref: Node12LambdaLayer }
     environment:
       DD_FLUSH_TO_LOG: true
-
-# http-errors
-  http-errors_node10:
-    handler: http-errors.handle
-    runtime: nodejs10.x
-    layers:
-      - { Ref: Node10LambdaLayer }
-
-  http-errors_node12:
-    handler: http-errors.handle
-    runtime: nodejs12.x
-    layers:
-      - { Ref: Node12LambdaLayer }
-
diff --git a/integration_tests/snapshots/logs/async-metrics_node12_with_plugin.log b/integration_tests/snapshots/logs/async-metrics_node12_with_plugin.log
@@ -2,7 +2,7 @@ START RequestId: XXXX Version: $LATEST
 {"e":XXXX,"m":"aws.lambda.enhanced.invocations","t":["region:us-east-1","account_id:XXXX","functionname:integration-plugin-dev-async-metrics_node12_with_plugin","resource:integration-plugin-dev-async-metrics_node12_with_plugin","cold_start:true","memorysize:1024","runtime:nodejs12.x"],"v":1}
 {"e":XXXX,"m":"serverless.integration_test.execution","t":["tagkey:tagvalue","eventsource:APIGateway","dd_lambda_layer:datadog-nodev12.XX.X"],"v":1}
 XXXX-XX-XX XX:XX:XX.XXX	XXXX-XXXX-XXXX-XXXX-XXXX	INFO	[dd.trace_id=XXXX dd.span_id=XXXX] Processed APIGateway request
-{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"true","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
+{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"true","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
 END RequestId: XXXX
 REPORT RequestId: XXXX	Duration: XXXX ms	Billed Duration: XXXX ms	Memory Size: 1024 MB	Max Memory Used: XXXX MB	Init Duration: XXXX ms	
 XRAY TraceId: XXXX	SegmentId: XXXX	Sampled: true	
@@ -12,7 +12,7 @@ START RequestId: XXXX Version: $LATEST
 {"e":XXXX,"m":"serverless.integration_test.records_processed","t":["tagkey:tagvalue","eventsource:SNS","dd_lambda_layer:datadog-nodev12.XX.X"],"v":1}
 {"e":XXXX,"m":"serverless.integration_test.execution","t":["tagkey:tagvalue","eventsource:SNS","dd_lambda_layer:datadog-nodev12.XX.X"],"v":1}
 XXXX-XX-XX XX:XX:XX.XXX	XXXX-XXXX-XXXX-XXXX-XXXX	INFO	[dd.trace_id=XXXX dd.span_id=XXXX] Processed SNS request
-{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"false","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
+{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"false","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
 END RequestId: XXXX
 REPORT RequestId: XXXX	Duration: XXXX ms	Billed Duration: XXXX ms	Memory Size: 1024 MB	Max Memory Used: XXXX MB	
 XRAY TraceId: XXXX	SegmentId: XXXX	Sampled: true	
@@ -23,7 +23,7 @@ START RequestId: XXXX Version: $LATEST
 {"e":XXXX,"m":"serverless.integration_test.records_processed","t":["tagkey:tagvalue","eventsource:SQS","dd_lambda_layer:datadog-nodev12.XX.X"],"v":1}
 {"e":XXXX,"m":"serverless.integration_test.execution","t":["tagkey:tagvalue","eventsource:SQS","dd_lambda_layer:datadog-nodev12.XX.X"],"v":1}
 XXXX-XX-XX XX:XX:XX.XXX	XXXX-XXXX-XXXX-XXXX-XXXX	INFO	[dd.trace_id=XXXX dd.span_id=XXXX] Processed SQS request
-{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"fs.operation","resource":"writeSync","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","component":"fs","span.kind":"internal","file.descriptor":"3"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"integration-plugin-dev-async-metrics_node12_with_plugin-fs"},{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"false","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
+{"traces":[[{"trace_id":"XXXX","span_id":"XXXX","parent_id":"XXXX","name":"aws.lambda","resource":"integration-plugin-dev-async-metrics_node12_with_plugin","error":0,"meta":{"_dd.origin":"lambda","service":"integration-plugin-dev-async-metrics_node12_with_plugin","cold_start":"false","function_arn":"XXXX_node12_with_plugin","function_version":"$LATEST","request_id":"XXXX","resource_names":"integration-plugin-dev-async-metrics_node12_with_plugin","_dd.parent_source":"xray"},"metrics":{"_sample_rate":1,"_sampling_priority_v1":2},"start":XXXX,"duration":XXXX,"service":"aws.lambda","type":"serverless"}]]}
 END RequestId: XXXX
 REPORT RequestId: XXXX	Duration: XXXX ms	Billed Duration: XXXX ms	Memory Size: 1024 MB	Max Memory Used: XXXX MB	
 XRAY TraceId: XXXX	SegmentId: XXXX	Sampled: true	
diff --git a/integration_tests/snapshots/logs/http-errors_node10.log b/integration_tests/snapshots/logs/http-errors_node10.log
diff --git a/integration_tests/snapshots/logs/http-errors_node10_with_plugin.log b/integration_tests/snapshots/logs/http-errors_node10_with_plugin.log
diff --git a/integration_tests/snapshots/logs/http-errors_node12.log b/integration_tests/snapshots/logs/http-errors_node12.log