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 request count and duration telemetry #3022

Open
wants to merge 25 commits into
base: dev
Choose a base branch
from
Open

Add request count and duration telemetry #3022

wants to merge 25 commits into from

Conversation

westin-m
Copy link
Contributor

@westin-m westin-m commented Nov 20, 2024 •
edited
Loading

Addresses client telemetry repair item

Add counter for get configuration requests and histogram for total duration of the same requests.

@westin-m westin-m linked an issue Nov 20, 2024 that may be closed by this pull request
Add metadata request time to client telemetry #3023
Open
@westin-m westin-m marked this pull request as ready for review November 21, 2024 23:05
@westin-m westin-m requested a review from a team as a code owner November 21, 2024 23:05
@westin-m westin-m changed the title Add request count and duration telemetry DRAFT Add request count and duration telemetry Nov 21, 2024
GeoK
GeoK reviewed Nov 22, 2024
View reviewed changes
build/dependenciesTest.props Outdated Show resolved Hide resolved
keegan-caruso
keegan-caruso reviewed Nov 23, 2024
View reviewed changes
build/dependencies.props Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Logging/IdentityModelTelemetry.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Logging/IdentityModelTelemetryUtil.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Logging/WatchUtility.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs Outdated Show resolved Hide resolved
.../Microsoft.IdentityModel.Protocols.OpenIdConnect.Tests/ConfigurationManagerTelemetryTests.cs Outdated Show resolved Hide resolved
.../Microsoft.IdentityModel.Protocols.OpenIdConnect.Tests/ConfigurationManagerTelemetryTests.cs Show resolved Hide resolved
src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs Outdated Show resolved Hide resolved
brentschmaltz
brentschmaltz requested changes Dec 5, 2024
View reviewed changes
Copy link
Member

@brentschmaltz brentschmaltz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asking for laying changes.

@pmaytak pmaytak requested review from Copilot and pmaytak December 20, 2024 21:49
Copilot
Copilot AI reviewed Dec 20, 2024
View reviewed changes

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 7 out of 22 changed files in this pull request and generated no comments.

Files not reviewed (15)
  • build/dependencies.props: Language not supported
  • build/dependenciesTest.props: Language not supported
  • src/Microsoft.IdentityModel.JsonWebTokens/InternalAPI.Unshipped.txt: Language not supported
  • src/Microsoft.IdentityModel.Logging/Microsoft.IdentityModel.Logging.csproj: Language not supported
  • src/Microsoft.IdentityModel.Protocols/InternalAPI.Unshipped.txt: Language not supported
  • src/Microsoft.IdentityModel.Tokens/InternalAPI.Unshipped.txt: Language not supported
  • src/System.IdentityModel.Tokens.Jwt/InternalAPI.Unshipped.txt: Language not supported
  • test/Microsoft.IdentityModel.Logging.Tests/Microsoft.IdentityModel.Logging.Tests.csproj: Language not supported
  • test/Microsoft.IdentityModel.Protocols.OpenIdConnect.Tests/Microsoft.IdentityModel.Protocols.OpenIdConnect.Tests.csproj: Language not supported
  • src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.cs: Evaluated as low risk
  • src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs: Evaluated as low risk
  • src/Microsoft.IdentityModel.Protocols/InternalsVisibleTo.cs: Evaluated as low risk
  • src/Microsoft.IdentityModel.Tokens/Telemetry/ITelemetryInstrumentation.cs: Evaluated as low risk
  • src/Microsoft.IdentityModel.Tokens/Telemetry/IdentityModelTelemetry.cs: Evaluated as low risk
  • src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryConstants.cs: Evaluated as low risk
Comments suppressed due to low confidence (2)

src/System.IdentityModel.Tokens.Jwt/JwtSecurityTokenHandler.cs:893

  • Ensure that validationParameters.ConfigurationManager.MetadataAddress is not null or empty before logging it.
_telemetryClient.IncrementConfigurationRefreshRequestCounter(

src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryInstrumentation.cs:48

  • [nitpick] The method name 'RecordConfigurationRetrievalDurationHistogram' is too long and could be simplified to 'RecordRetrievalDuration' for better readability.
IdentityModelTelemetry.RecordConfigurationRetrievalDurationHistogram(durationInMilliseconds, tagList);
pmaytak
pmaytak reviewed Dec 20, 2024
View reviewed changes
build/dependencies.props Outdated Show resolved Hide resolved
brentschmaltz
brentschmaltz reviewed Dec 21, 2024
View reviewed changes
src/Microsoft.IdentityModel.Logging/Microsoft.IdentityModel.Logging.csproj
@@ -32,6 +32,10 @@
</None>
</ItemGroup>

<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework' or '$(TargetFramework)' == 'netstandard2.0' ">
Copy link
Member

@brentschmaltz brentschmaltz Dec 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reference should be in the assembly where the types are used.
Currently this is M.IM.Tokens, which includes this reference, which allows the project to build.

I think the telemetry stuff should be in M.IM.Logging.

brentschmaltz
brentschmaltz requested changes Dec 21, 2024
View reviewed changes
Copy link
Member

@brentschmaltz brentschmaltz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some naming.
Code should live in assembly where dependencies are included.
Why do we need an interface?

pmaytak
pmaytak reviewed Dec 28, 2024
View reviewed changes
src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryConstants.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Tokens/Telemetry/IdentityModelTelemetry.cs Outdated

namespace Microsoft.IdentityModel.Tokens.Telemetry
{
internal class IdentityModelTelemetry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I would rename TelemetryInstrumentation to TelemetryClient and merge this class into it to simplify the logic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As more telemetry gets added, this class and TelemetryClient will grow a lot and I would rather keep them separate and focused in anticipation of that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. My underlying feeling behind the comment was that it's a bit unclear at first glance what the purpose and the difference between the two classes is. Looks like TelemetryInstrumentation prepares the data and IdentityModelTelemetry actually pushes the data. At the very least, I suggest adding class comments to clarify the purpose. And also maybe renaming the class to make it clearer (like TelemetryRecorder, or Uploader or something?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood. I'll add some comments to clarify and think about the name a bit more.

src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryInstrumentation.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryConstants.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Tokens/Telemetry/TelemetryConstants.cs Show resolved Hide resolved
src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Protocols/Configuration/ConfigurationManager.cs Outdated Show resolved Hide resolved
test/Microsoft.IdentityModel.JsonWebTokens.Tests/JsonWebTokenHandlerTelemetryTests.cs Outdated Show resolved Hide resolved
src/Microsoft.IdentityModel.Tokens/Telemetry/IdentityModelTelemetry.cs Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 6, 2025

Summary

Summary
Generated on: 1/6/2025 - 9:00:11 PM
Coverage date: 1/6/2025 - 8:50:27 PM - 1/6/2025 - 8:59:44 PM
Parser: MultiReport (60x Cobertura)
Assemblies: 1
Classes: 7
Files: 2
Line coverage: 80.3% (620 of 772)
Covered lines: 620
Uncovered lines: 152
Coverable lines: 772
Total lines: 483
Branch coverage: 67.8% (228 of 336)
Covered branches: 228
Total branches: 336
Method coverage: Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%
Name Line Branch
Microsoft.IdentityModel.JsonWebTokens 80.3% 67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities 100%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0		 81.4% 67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0		 81.4% 67.6%

@AzureAD AzureAD deleted a comment from github-actions bot Jan 6, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 7, 2025

Summary

Summary
Generated on: 1/7/2025 - 4:38:06 PM
Coverage date: 1/7/2025 - 4:28:47 PM - 1/7/2025 - 4:37:40 PM
Parser: MultiReport (60x Cobertura)
Assemblies: 1
Classes: 7
Files: 2
Line coverage: 80.3% (620 of 772)
Covered lines: 620
Uncovered lines: 152
Coverable lines: 772
Total lines: 483
Branch coverage: 67.8% (228 of 336)
Covered branches: 228
Total branches: 336
Method coverage: Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%
Name Line Branch
Microsoft.IdentityModel.JsonWebTokens 80.3% 67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities 100%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0		 81.4% 67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0		 81.4% 67.6%

@westin-m @keegan-caruso
Apply suggestions from code review
a7f85cf 
Co-authored-by: Keegan <Keegan.Caruso@microsoft.com>
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 7, 2025

Summary

Summary
Generated on: 1/7/2025 - 9:17:22 PM
Coverage date: 1/7/2025 - 9:08:15 PM - 1/7/2025 - 9:16:57 PM
Parser: MultiReport (60x Cobertura)
Assemblies: 1
Classes: 7
Files: 2
Line coverage: 80.3% (620 of 772)
Covered lines: 620
Uncovered lines: 152
Coverable lines: 772
Total lines: 483
Branch coverage: 67.8% (228 of 336)
Covered branches: 228
Total branches: 336
Method coverage: Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%
Name Line Branch
Microsoft.IdentityModel.JsonWebTokens 80.3% 67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities 100%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0		 81.4% 67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0		 81.4% 67.6%

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 7, 2025

Summary

Summary
Generated on: 1/7/2025 - 10:12:44 PM
Coverage date: 1/7/2025 - 10:02:50 PM - 1/7/2025 - 10:12:17 PM
Parser: MultiReport (60x Cobertura)
Assemblies: 1
Classes: 7
Files: 2
Line coverage: 80.3% (620 of 772)
Covered lines: 620
Uncovered lines: 152
Coverable lines: 772
Total lines: 483
Branch coverage: 67.8% (228 of 336)
Covered branches: 228
Total branches: 336
Method coverage: Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%
Name Line Branch
Microsoft.IdentityModel.JsonWebTokens 80.3% 67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities 100%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated 80.3% 67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA
DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0		 81.4% 67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1		 79.2% 68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3
CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0		 81.4% 67.6%

brentschmaltz
brentschmaltz requested changes Jan 9, 2025
View reviewed changes
Copy link
Member

@brentschmaltz brentschmaltz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest putting telemetry code in M.IM.Logging assembly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot Copilot left review comments

@keegan-caruso keegan-caruso keegan-caruso left review comments

@pmaytak pmaytak pmaytak left review comments

@brentschmaltz brentschmaltz brentschmaltz requested changes

@GeoK GeoK GeoK approved these changes

Requested changes must be addressed to merge this pull request.

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

Successfully merging this pull request may close these issues.

Add metadata request time to client telemetry
7 participants
@westin-m @skblr2022 @GeoK @brentschmaltz @pmaytak @keegan-caruso @jennyf19