feat(pg): Patch client inside lib and lib/pg-native

[onurtemizkan]

Which problem is this PR solving?

Ref:

• Missing postgres query spans in Remix app getsentry/sentry-javascript#14238
• (Potentially related) Missing postgres query spans in Remix app getsentry/sentry-javascript#14238 (comment)

Debugging the reproduction of getsentry/sentry-javascript#14238, it seems @opentelemetry/instrumentation-pg fails to pick up the pg module while it successfully picks up and patches pg-pool.

Digging into node_modules of the reproduction, pg package did not have an index on its root, and the whole implementation resides in lib. Which made me suspect that relying on the root exports may not be enough with certain bundlers (Vite in this case) and runtimes. Instrumenting the client file instead worked well and spans were created successfully.

The same applies to pg-native which pg has bindings inside lib/native. So it's possible to patch it from the pg itself. That is similar to the approach Sentry was using to instrument pg-native before migrating to OTEL.

Short description of the changes

• Added file patchers for lib/client.js and lib/native/client.js on top of the original implementation.
• Tested both locally.

[codecov]

Codecov Report

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

Project coverage is 90.91%. Comparing base (c2ad0af) to head (6ac36ac).

Files with missing lines	Patch %	Lines
...elemetry-instrumentation-pg/src/instrumentation.ts	93.75%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2563      +/-   ##
==========================================
+ Coverage   90.79%   90.91%   +0.11%     
==========================================
  Files         169      169              
  Lines        8059     8075      +16     
  Branches     1645     1645              
==========================================
+ Hits         7317     7341      +24     
+ Misses        742      734       -8     

Files with missing lines	Coverage Δ
...elemetry-instrumentation-pg/src/instrumentation.ts	95.00% <93.75%> (+4.78%)	⬆️

[danielabel]

I'd very much like to support this PR getting merged. It solves a problem I am seeing where pg-native is not sending traces when the native flag is used in Sequelize

[pichlermarc]

cc @maryliag (component owner) 🙂

[maryliag]

Hi, nice work working on this. I added a few questions :)

[maryliag]

Thank you for working on this!