feat(mysql2): Instrument mysql2 >= 3.20.0 via native tracing channels#21824
Draft
logaretm wants to merge 5 commits into
Draft
feat(mysql2): Instrument mysql2 >= 3.20.0 via native tracing channels#21824logaretm wants to merge 5 commits into
logaretm wants to merge 5 commits into
Conversation
![sentry-warden[bot]](https://avatars.githubusercontent.com/in/2755838?s=60&v=4){kind=small}
Contributor
size-limit report 📦
|
logaretm
force-pushed
the
awad/instrument-mysql2-via-tc
branch
2 times, most recently
from
bfe56a5 to
2dc47b7
Compare
mysql2 >= 3.20.0 publishes its operations over node:diagnostics_channel (mysql2:query / :execute / :connect / :pool:connect), so the SDK can subscribe to those channels instead of monkey-patching, the same way we did for redis/ioredis and mongoose. The subscription lives in server-utils as mysql2Integration, and the node mysql2Integration extends it (via extendIntegration) while keeping the vendored OTel patcher for mysql2 < 3.20.0, which is now gated to that range so the two paths never double-instrument. The channel path emits the stable DB semconv (db.system.name, db.query.text, db.operation.name, db.namespace, server.address, server.port), so there's the same attribute drift we accepted for redis/mongoose. mysql2 publishes already-formatted SQL, so db.query.text is run through the OTel sanitizer and raw values are never attached.
The mysql2-tracing-channel docker-compose bound host port 3307, which collides with the knex/mysql2 suite. When both run in parallel the second container fails with 'port is already allocated'. Switch to 3308.
Replace the conditional-spread pattern for optional attributes with `?? undefined` (and `|| undefined` for the database name, which keeps dropping empty strings). Undefined-valued keys are dropped by the span backends, so this is equivalent while keeping the attribute lines consistent.
Replace the ad-hoc `void Promise.resolve().then(...)` deferral with the shared `waitForTracingChannelBinding` util, matching the mongoose, graphql, vercel-ai and redis integrations. It retries until the async context binding is available, so it also handles custom OTel setups where the binding isn't ready on the first tick.
The suite gated readiness on `mysqladmin ping`, which reports "alive"
even during MySQL 8's init bootstrap (it treats access-denied as alive).
So `docker compose up --wait` could return before the real server and
root password were ready, and the scenario's first connection was
dropped ("server closed the connection") — crashing the run and timing
out the test. Gate on an authenticated `SELECT 1` instead, mirroring the
knex/mysql2 sibling suite (#21868).
logaretm
force-pushed
the
awad/instrument-mysql2-via-tc
branch
from
b8c0f1c to
ba2bc18
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Instruments mysql2 >= 3.20.0 through its native
diagnostics_channeltracing channels instead of monkey-patching, the same way we did for redis/ioredis and mongoose. mysql2 publishes onmysql2:query,mysql2:execute,mysql2:connectandmysql2:pool:connect.The channel path emits the stable DB semconv (
db.system.name,db.query.text,db.operation.name,db.namespace,server.address,server.port), so there's an attribute drift here. We could match the legacy attributes and drop them at v11 instead if that's what we want.One mysql2-specific thing: the
mysql2:querychannel publishes the already-formatted SQL with values inlined, so I run it through the OTeldb.query.textsanitizer.