Add Prisma Tags to our Sql Commenter tracing for extra information

Problem

At the moment Prisma can add a trace id as a SQL comment when a trace id is passed to the query.

• See this PR as an example https://github.com/prisma/prisma-engines/pull/2587
• The comment example https://github.com/prisma/quaint/pull/329/files#diff-4b2e8a5b67b97212d61df2fd30b5c5205e9368947f0262bde6c17bcf99b7c931R713

The comment doesn’t give any more information around the query for example it doesn’t mention this query is from Prisma and what operation it was for.

Suggested solution

Allow the ability to add in extra Sql Tags. For example:

SELECT * FROM FOO /* operation='CreateUser', ORM='Prisma',
traceparent='00-5bd66ef5095369c7b0d1f8f4bd33716a-c532cb4098ac3dd2-01',
tracestate='congo%3Dt61rcWkgMzE%2Crojo%3D00f067aa0ba902b7'*/

We could make it that we always add in those SQL comments even if the trace id is not added. So the Query would look like:

SELECT * FROM FOO /* operation='CreateUser', ORM='Prisma'*/

We could do this by default or allow the user to opt into adding them.

Alternatives

Additional context

• Sql Commenter spec https://google.github.io/sqlcommenter/spec/
• https://cloud.google.com/blog/products/databases/sqlcommenter-merges-with-opentelemetry

[garrensmith]

I’m away this week but I can try and find an easier ticket to work on next week.

---

From: Bogdan Soare @.> Sent: Wednesday, May 18, 2022 8:12:44 PM To: prisma/prisma @.> Cc: garren smith @.>; Mention @.> Subject: Re: [prisma/prisma] Add Prisma Tags to our Sql Commenter tracing for extra information (Issue #13360)

Got it, thank you for letting me know.

Once things are more clear if you need any help please let me know.

— Reply to this email directly, view it on GitHubhttps://github.com/prisma/prisma/issues/13360#issuecomment-1130346388, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AABL2ARKY234VXSGKT3C6RLVKUXJZANCNFSM5V3LHVSA. You are receiving this because you were mentioned.Message ID: @.***>

[matthewmueller]

This looks great! I appreciate the links you provided to get more context too.

Two questions/thoughts:

1. Would these sqlcomments also be accessible via Prisma’s query logging? Or is the expectation that you have something like rsyslog hooked up to your SQL log files?
2. Once we’re done, it might be nice to create a PR adding Prisma to their examples: https://github.com/google/sqlcommenter. This repo’s examples are linked from the blog posts, so I’d imagine it gets decent traffic.