[Feature Request] Caller SDK details in ExtraQueryParams

[bgavrilMS]

Problem statement

Goal

Higher level SDKs provide a hint on their identity: id + version

Dev Experience

request.WithExtraQueryParameters({{ "caller-sdk-id", "41"}, { "caller-sdk-ver", "1.42.0"}}

Note: pls improve WithExtraQueryParameters so that it can be used multiple times, in which case values are appended.

Implementation

The data should be sent to ESTS via the msal-curr header and also captured in the OTEL metrics.

[bgavrilMS]

CC @localden and @jmprieur

[localden]

@bgavrilMS @neha-bhargava for the current schema, does it mean that arbitrary caller SDK IDs and versions can be included? I am assuming that we're not actually going to use 41 but rather something like azure-identity-go?

[neha-bhargava]

@localden the caller-sdk-id is the api id used to call MSAL from the higher level sdk. I think it will be some kind of numeric or alpha numeric, so yes something like 41 can be a valid value. Since this data will be added to server side telemetry, this value cannot be huge. @bgavrilMS can confirm my understanding.

[localden]

@localden the caller-sdk-id is the api id used to call MSAL from the higher level sdk. I think it will be some kind of numeric or alpha numeric, so yes something like 41 can be a valid value. Since this data will be added to server side telemetry, this value cannot be huge. @bgavrilMS can confirm my understanding.

OK so I think that's the interesting part that we need to flesh out - what are the constraints for this field? Because I can totally see someone putting their entire user agent here 😁

[TimHannMSFT]

In other internal libraries we own, we solve a very similar problem using something the caller can configure while setting up their host. I can share more details, we call it supplemental_version_info there. Thanks to @GeoK for pointing out this similarity.

[rayluo]

Problem statement

Goal

Higher level SDKs provide a hint on their identity: id + version

Dev Experience

request.WithExtraQueryParameters({{ "caller-sdk-id", "41"}, { "caller-sdk-ver", "1.42.0"}}

Note: pls improve WithExtraQueryParameters so that it can be used multiple times, in which case values are appended.

Implementation

The data should be sent to ESTS via the msal-curr header and also captured in the OTEL metrics.

@localden and @neha-bhargava also pointed out the similarity between this "higher level SDK's identity" and the existing x-app-name, x-app-version headers. Shall we consider simply having the msal-curr telemetry include x-app-name and x-app-version while keeping their current API? Besides, the WithExtraQueryParameters() is already a wild card, but using "...QueryParameter..." to mean some new http header seems going a little too far.

[localden]

@localden and @neha-bhargava also pointed out the similarity between this "higher level SDK's identity" and the existing x-app-name, x-app-version headers. Shall we consider simply having the msal-curr telemetry include x-app-name and x-app-version while keeping their current API? Besides, the WithExtraQueryParameters() is already a wild card, but using "...QueryParameter..." to mean some new http header seems going a little too far.

Yeah, overloading WithExtraQueryParameters to say that we're amending headers seems like a less intuitive option for consuming developers 😁 Or are we saying that "query parameters" are more akin to "authentication query settings" rather than literal "URI query parameters"?