Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add caller sdk id and version to telemetry server side and client side #4864

Merged
merged 24 commits into from
Sep 16, 2024
Merged

Add caller sdk id and version to telemetry server side and client side #4864

merged 24 commits into from
Sep 16, 2024

Conversation

neha-bhargava
Copy link
Contributor

Fixes #4863

Changes proposed in this request
Add caller sdk details to client side and server side telemetry

Testing
Unit and integration tests

Performance impact

Documentation

  • All relevant documentation is updated.

@rayluo rayluo mentioned this pull request Aug 1, 2024
Closed
@bgavrilMS bgavrilMS mentioned this pull request Aug 11, 2024
Draft
@neha-bhargava neha-bhargava marked this pull request as ready for review August 14, 2024 09:50
@neha-bhargava neha-bhargava requested a review from a team as a code owner August 14, 2024 09:50
@TimHannMSFT
Copy link
Contributor

Thanks @neha-bhargava! Can you help me understand how these fields are meant to interact with the supplemental-version-info currently getting sent in client telemetry we discussed?

As we discussed, please be sure to update the schema here once this is finalized: https://eng.ms/docs/microsoft-security/identity/entra-developer-application-platform/id4s-identity-for-services/authn-middleware-sdk-microsoft-identity-service-essentials/microsoft-identity-service-essentials/articles/using-mise/telemetry-schema

@neha-bhargava @TimHannMSFT
Update src/client/Microsoft.Identity.Client/Platforms/Features/OpenTe…
f13b88d 
…lemetry/OtelInstrumentation.cs

Co-authored-by: Tim Hannifin <87669370+TimHannMSFT@users.noreply.github.com>
neha-bhargava and others added 3 commits August 17, 2024 10:53
@neha-bhargava @TimHannMSFT
Update src/client/Microsoft.Identity.Client/Platforms/Features/OpenTe…
747b5e2 
…lemetry/OtelInstrumentation.cs

Co-authored-by: Tim Hannifin <87669370+TimHannMSFT@users.noreply.github.com>
@neha-bhargava @TimHannMSFT
Update src/client/Microsoft.Identity.Client/AppConfig/ApplicationConf…
476d338 
…iguration.cs

Co-authored-by: Tim Hannifin <87669370+TimHannMSFT@users.noreply.github.com>
@neha-bhargava @TimHannMSFT
Update src/client/Microsoft.Identity.Client/AppConfig/ApplicationConf…
b0ebbff 
…iguration.cs

Co-authored-by: Tim Hannifin <87669370+TimHannMSFT@users.noreply.github.com>
@neha-bhargava
Copy link
Contributor Author

Thanks @neha-bhargava! Can you help me understand how these fields are meant to interact with the supplemental-version-info currently getting sent in client telemetry we discussed?

As we discussed, please be sure to update the schema here once this is finalized: https://eng.ms/docs/microsoft-security/identity/entra-developer-application-platform/id4s-identity-for-services/authn-middleware-sdk-microsoft-identity-service-essentials/microsoft-identity-service-essentials/articles/using-mise/telemetry-schema

Since this value is to recognize the API used, this value can be added per request too. So, the supplemental-version-info could not be used in this case. Also we need to send this information to server side telemetry hence using this API.

gladjohn
gladjohn approved these changes Sep 11, 2024
View reviewed changes
src/client/Microsoft.Identity.Client/AppConfig/BaseAbstractApplicationBuilder.cs Outdated Show resolved Hide resolved
src/client/Microsoft.Identity.Client/AppConfig/BaseAbstractApplicationBuilder.cs Outdated Show resolved Hide resolved
src/client/Microsoft.Identity.Client/Internal/Requests/RequestBase.cs Show resolved Hide resolved
src/client/Microsoft.Identity.Client/TelemetryCore/TelemetryConstants.cs Show resolved Hide resolved
tests/Microsoft.Identity.Test.Unit/TelemetryTests/HttpTelemetryTests.cs Outdated Show resolved Hide resolved
tests/Microsoft.Identity.Test.Unit/TelemetryTests/HttpTelemetryTests.cs Show resolved Hide resolved
tests/Microsoft.Identity.Test.Unit/TelemetryTests/HttpTelemetryTests.cs Show resolved Hide resolved
tests/Microsoft.Identity.Test.Unit/TelemetryTests/HttpTelemetryTests.cs Show resolved Hide resolved
neha-bhargava and others added 5 commits September 12, 2024 09:49
@neha-bhargava @gladjohn
Update src/client/Microsoft.Identity.Client/AppConfig/BaseAbstractApp…
b980895 
…licationBuilder.cs

Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
@neha-bhargava @gladjohn
Update src/client/Microsoft.Identity.Client/AppConfig/BaseAbstractApp…
c1e38c2 
…licationBuilder.cs

Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
@neha-bhargava
Address comments
c93c8ce
@neha-bhargava
Merge branch 'main' into nebharg/ztaSupportSdkInfo
7c8fc52
@neha-bhargava
Merge branch 'main' into nebharg/ztaSupportSdkInfo
ea52b17
@neha-bhargava neha-bhargava merged commit c1ecec7 into main Sep 16, 2024
6 checks passed
@neha-bhargava neha-bhargava deleted the nebharg/ztaSupportSdkInfo branch September 16, 2024 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bgavrilMS bgavrilMS bgavrilMS approved these changes

@localden localden localden left review comments

@TimHannMSFT TimHannMSFT TimHannMSFT left review comments

@gladjohn gladjohn gladjohn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature Request] Caller SDK details in ExtraQueryParams
5 participants
@neha-bhargava @TimHannMSFT @bgavrilMS @localden @gladjohn