Khanayan123/instrument apollo gateway

[khanayan123]

What does this PR do?

Instruments @apollo/gateway versions >= 2.3.0

Motivation

Feature request

Note

Because apollo-gateway uses graphql methods, automatic instrumentation of apollo gateway also generates graphql spans, so users are advised to disable the graphql plugin when using apollo gateway

[pr-commenter]

Benchmarks

Benchmark execution time: 2024-03-06 17:56:19

Comparing candidate commit 6f88a22 in PR branch khanayan123/instrument-apollo-gateway with baseline commit c9af707 in branch master.

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

[github-actions]

Overall package size

Self size: 6.21 MB
Deduped: 61.2 MB
No deduping: 61.96 MB

Dependency sizes

name	version	self size	total size
@datadog/native-iast-taint-tracking	1.7.0	16.71 MB	16.72 MB
@datadog/native-appsec	7.1.0	14.37 MB	14.38 MB
@datadog/pprof	5.1.0	8.83 MB	9.68 MB
protobufjs	7.2.5	2.77 MB	6.56 MB
@datadog/native-iast-rewriter	2.2.3	2.19 MB	2.28 MB
@opentelemetry/core	1.14.0	872.87 kB	1.47 MB
@datadog/native-metrics	2.0.0	898.77 kB	1.3 MB
@opentelemetry/api	1.4.1	780.32 kB	780.32 kB
import-in-the-middle	1.7.3	67.62 kB	731.01 kB
pprof-format	2.0.7	588.12 kB	588.12 kB
msgpack-lite	0.1.26	201.16 kB	281.59 kB
opentracing	0.14.7	194.81 kB	194.81 kB
semver	7.5.4	93.4 kB	123.8 kB
@datadog/sketches-js	2.1.0	109.9 kB	109.9 kB
lodash.sortby	4.7.0	75.76 kB	75.76 kB
lru-cache	7.14.0	74.95 kB	74.95 kB
ipaddr.js	2.1.0	60.23 kB	60.23 kB
ignore	5.2.4	51.22 kB	51.22 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
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
node-abort-controller	3.1.1	16.89 kB	16.89 kB
jest-docblock	29.7.0	8.99 kB	12.76 kB
crypto-randomuuid	1.0.0	11.18 kB	11.18 kB
path-to-regexp	0.1.7	6.78 kB	6.78 kB
koalas	1.0.2	6.47 kB	6.47 kB
methods	1.1.2	5.29 kB	5.29 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}

[codecov]

Codecov Report

Attention: Patch coverage is 3.33333% with 29 lines in your changes are missing coverage. Please review.

Project coverage is 84.99%. Comparing base (c9af707) to head (6f88a22).
Report is 2 commits behind head on master.

Files	Patch %	Lines
...ages/dd-trace/src/service-naming/schemas/v0/web.js	0.00%	12 Missing ⚠️
...ages/dd-trace/src/service-naming/schemas/v1/web.js	0.00%	12 Missing ⚠️
packages/dd-trace/src/plugins/tracing.js	0.00%	4 Missing ⚠️
packages/dd-trace/src/plugins/index.js	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4102      +/-   ##
==========================================
- Coverage   85.20%   84.99%   -0.22%     
==========================================
  Files         247      247              
  Lines       10878    10907      +29     
  Branches       33       33              
==========================================
+ Hits         9269     9270       +1     
- Misses       1609     1637      +28     

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

[jbertran]

We should have the composite plugins you defined all use the serviceName/operationName operations provided by TracingPlugin for span name and service name definition.

Having a composite plugin with the same kind for each plugin makes this sort of awkward, but you can override any of the 3 plugin properties used for resolving the naming schema by supplying a different value in options (details here).

Since you're keeping the id consistent across all composites to have the correct component reported, you could use (for example, details are up to you though - you might use this.constructor.operation to build it) this.serviceName({id: 'apollo-gateway-execute'}) and this.operationName({id: 'apollo-gateway-execute'}) in span starts, and define each plugin's naming schema inside web.js under the corresponding overridden id. This would require to set type for all these plugins to web and kind to server, which doesn't sound inaccurate to me.