Ability to add more comments with the Commenter Feature

[debuggerpk]

GCP CloudSQL Commenter add a couple of keys e.g. action, route etc which are visible in CloudSQL Query insights. In those keys, action key is very interesting. It would be wonderful if we can add more comments to the query.

I have been playing the library a little bit but I can't seem to wrap to head around this line.

otelsql/commenter.go

Line 61 in dc43389

c.propagator.Inject(ctx, &cc)

My debugging investigation shows that traceparent becomes available in context after this line. I believe this happens because we are instantiating it with propagation.NewCompositeTextMapPropagator()

Is there a way we can set more keys for commentCarrier when setting the context of the query?

PS: thankyou for the wonderful work.

[XSAM]

Hi @debuggerpk, thanks for raising this issue.

I am not sure about the scenario that custom comments could solve. Could you please describe more about the new keys that CloudSQL Commenter introduced?

• What kind of value could be stored under these keys?
• What UI or system did you expect to see those keys?
• What reasons could adding these keys to comments in SQL help you solve the problem? Would adding attributes into the span before calling the SQL operation do the same for you?