Identity v2 logging impovements #45296
Open
+440
−438
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lmolkova
requested review from
joshfree,
srnagar,
anuchandy,
conniey and
JonathanGiles
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR introduces logging improvements for Identity v2 by switching to the new throwableAt* methods, using structured logging, and consolidating duplicate exception logs. Key changes include:
- Replacing the old logThrowableAs* methods with the new logAndThrowTokenError and throwableAt* variants.
- Updating structured logging usage across multiple credential implementations.
- Minor cleanup in logging and exception handling and a dependency version bump in pom.xml.
Reviewed Changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| ManagedIdentityCredential.java | Updates logging for unavailable credentials and exception handling using throwableAt* |
| InteractiveBrowserCredentialBuilder.java | Uses throwableAtError().log in place of logThrowableAsError for URI syntax issues |
| InteractiveBrowserCredential.java | Changes catch blocks to RuntimeException and updates logging for interactive authentication requirements |
| EnvironmentCredential.java | Updates structured logging and exception logging for different authentication flows |
| DeviceCodeCredential.java | Standardizes exception logging with throwableAt* methods |
| DefaultAzureCredentialBuilder.java | Enforces single identity configuration via updated exception logging |
| ClientSecretCredential.java, ClientCertificateCredential.java, ClientAssertionCredential.java | Standardizes exception logging using logAndThrowTokenError for authentication errors |
| ChainedTokenCredential.java | Refactors cached credential logging and exception handling with structured logging |
| AzureToolkitCredential.java, AzurePowerShellCredential.java, AzurePipelinesCredential.java, AzureDeveloperCliCredential.java, AzureCliCredential.java, AuthorizationCodeCredentialBuilder.java, AuthorizationCodeCredential.java | Updates logging throughout to adopt the new logging patterns |
| pom.xml | Bumps clientcore dependency version from beta.9 to beta.10 |
| checkstyle-suppressions.xml | Adds a new suppression entry for throw-from-client-logger checks across credential files |
Comments suppressed due to low confidence (1)
sdk/identity-v2/azure-identity/src/main/java/com/azure/v2/identity/ManagedIdentityCredential.java:102
- [nitpick] Consider enhancing structured logging here by including key-value pairs (for example, adding the managedIdentitySourceType as a key-value) instead of relying solely on string concatenation for increased clarity and consistency.
LOGGER.atError().log("ManagedIdentityCredential authentication unavailable. " + "the ManagedIdentityCredentialBuilder.");
g2vinay
reviewed
May 20, 2025
...dentity-v2/azure-identity/src/main/java/com/azure/v2/identity/AzurePowerShellCredential.java
Show resolved
Hide resolved
g2vinay
reviewed
May 23, 2025
sdk/identity-v2/azure-identity/src/main/java/com/azure/v2/identity/DeviceCodeCredential.java
Outdated
Show resolved
Hide resolved
g2vinay
reviewed
May 23, 2025
...tity-v2/azure-identity/src/main/java/com/azure/v2/identity/InteractiveBrowserCredential.java
Outdated
Show resolved
Hide resolved
g2vinay
reviewed
May 23, 2025
...dentity-v2/azure-identity/src/main/java/com/azure/v2/identity/ManagedIdentityCredential.java
Outdated
Show resolved
Hide resolved
lmolkova
commented
May 23, 2025
...2/azure-identity/src/main/java/com/azure/v2/identity/implementation/client/PublicClient.java
Outdated
Show resolved
Hide resolved
g2vinay
reviewed
May 23, 2025
| } | ||
|
|
||
| if (output.contains("Run Connect-AzAccount to login")) { | ||
| LoggingUtil.logCredentialUnavailableException(LOGGER, | ||
| new CredentialUnavailableException("Run Connect-AzAccount to login to Azure account in PowerShell.")); | ||
| LOGGER.atError().log("Run Connect-AzAccount to login to Azure account in PowerShell."); |
There was a problem hiding this comment.
We need to throw the Credential Unavailable exception here too.
g2vinay
reviewed
May 23, 2025
| LoggingUtil.logCredentialUnavailableException(LOGGER, | ||
| new CredentialUnavailableException("Az.Account module with version >= 2.2.0 is not installed. " | ||
| + "It needs to be installed to use Azure PowerShell " + "Credential.")); | ||
| LOGGER.atError() |
There was a problem hiding this comment.
need to throw cred unavailable exception
g2vinay
reviewed
May 23, 2025
| @@ -152,8 +147,9 @@ private AccessToken getAccessTokenFromPowerShell(TokenRequestContext request, Po | |||
| OffsetDateTime expiresOn = OffsetDateTime.parse(time).withOffsetSameInstant(ZoneOffset.UTC); | |||
| return new AccessToken(accessToken, expiresOn); | |||
| } catch (IOException e) { | |||
| LoggingUtil.logCredentialUnavailableException(LOGGER, new CredentialUnavailableException( | |||
| "Encountered error when deserializing response from Azure Power Shell.", e)); | |||
| LOGGER.atError() | |||
There was a problem hiding this comment.
same, need to throw cred unavilable exception.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
throwableAt*instead oflogThrowableAs*- the new one creates exception message with contextRelated to #45136