feat(tracing): AWS API Gateway Inferred Span Support

[wconti27]

What does this PR do?

Created inferred spans for AWS Api Gateway for web integrations if the received request has a specific header (see RFC). The headers will also contain info on the route, start time of the request in MS, method, etc.

AIDM-419

Motivation

Plugin Checklist

• Unit tests.
• TypeScript definitions.
• TypeScript tests.
• API documentation.
• CircleCI jobs/workflows.
• Plugin is exported.

Additional Notes

[github-actions]

Overall package size

Self size: 7.97 MB
Deduped: 64.99 MB
No deduping: 65.33 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/native-appsec | 8.2.1 | 19.18 MB | 19.19 MB | | @datadog/native-iast-taint-tracking | 3.2.0 | 13.9 MB | 13.91 MB | | @datadog/pprof | 5.4.1 | 9.76 MB | 10.13 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.5.0 | 2.51 MB | 2.65 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 3.0.1 | 1.06 MB | 1.46 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.11.2 | 112.74 kB | 826.22 kB | | msgpack-lite | 0.1.26 | 201.16 kB | 281.59 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | semver | 7.6.3 | 95.82 kB | 95.82 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.1 | 51.46 kB | 51.46 kB | | int64-buffer | 0.1.10 | 49.18 kB | 49.18 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | path-to-regexp | 0.1.10 | 6.38 kB | 6.38 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

_{🤖 This report was automatically generated by heaviest-objects-in-the-universe}

[pr-commenter]

Benchmarks

Benchmark execution time: 2024-11-12 20:06:40

Comparing candidate commit 23fc930 in PR branch conti/api-gateway-poc with baseline commit 70e99bd in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 259 metrics, 7 unstable metrics.

[tlhunter]

Was there an RFC for these header named? Seems like a shame they aren't combined into 1 header.

[wantsui]

This part is a bit subject to the AWS expectations for headers:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html
• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html

I don't know if there's a way to list multiple keys at once so that part would require a bit more research.

[wconti27]

From our tests, it seems like it's not possible to combine these values from AWS into 1 header, so our hands are pretty much tied and we're stuck with using separate headers.

[codecov]

Codecov Report

Attention: Patch coverage is 97.29730% with 2 lines in your changes missing coverage. Please review.

Project coverage is 72.34%. Comparing base (0b4dab7) to head (f97ab67).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
...ckages/dd-trace/src/plugins/util/inferred_proxy.js	95.65%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #4837       +/-   ##
===========================================
- Coverage   93.86%   72.34%   -21.52%     
===========================================
  Files         107      327      +220     
  Lines        3373    14879    +11506     
===========================================
+ Hits         3166    10764     +7598     
- Misses        207     4115     +3908     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.