Skip to content

Commit 919fa6c

Browse files
committed
Logging improvements
1 parent baf7f98 commit 919fa6c

7 files changed

Lines changed: 24 additions & 27 deletions

File tree

‎src/Exceptionless.Web/Api/Handlers/AuthHandler.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ public async Task<Result<TokenResult>> Handle(RemoveExternalLogin message)
298298
{
299299
var httpContext = message.Context;
300300
var user = httpContext.Request.GetUser();
301-
using var _ = logger.BeginScope(new ExceptionlessState().Tag("External Login").Tag(message.ProviderName).Identity(user.EmailAddress).Property("User", user).Property("Provider User Id", message.ProviderUserId?.Value).SetHttpContext(httpContext));
301+
using var _ = logger.BeginScope(new ExceptionlessState().Tag("External Login").Tag(message.ProviderName).Identity(user.EmailAddress).Property("Provider User Id", message.ProviderUserId?.Value).SetHttpContext(httpContext));
302302

303303
if (String.IsNullOrWhiteSpace(message.ProviderName) || String.IsNullOrWhiteSpace(message.ProviderUserId?.Value))
304304
{
@@ -334,7 +334,7 @@ public async Task<Result<TokenResult>> Handle(ChangePassword message)
334334
var httpContext = message.Context;
335335
var model = message.Model;
336336
var user = httpContext.Request.GetUser();
337-
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Change Password").Identity(user.EmailAddress).Property("User", user).Property("Password Length", model.Password?.Length ?? 0).SetHttpContext(httpContext));
337+
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Change Password").Identity(user.EmailAddress).Property("Password Length", model.Password?.Length ?? 0).SetHttpContext(httpContext));
338338

339339
if (!String.IsNullOrWhiteSpace(user.Password))
340340
{
@@ -436,7 +436,7 @@ public async Task<Result> Handle(ResetPassword message)
436436
var httpContext = message.Context;
437437
var model = message.Model;
438438
var user = await userRepository.GetByPasswordResetTokenAsync(model.PasswordResetToken);
439-
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Reset Password").Identity(user?.EmailAddress).Property("User", user).Property("Password Length", model.Password?.Length ?? 0).SetHttpContext(httpContext));
439+
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Reset Password").Identity(user?.EmailAddress).Property("Password Length", model.Password?.Length ?? 0).SetHttpContext(httpContext));
440440

441441
if (user is null)
442442
{
@@ -496,7 +496,7 @@ public async Task<Result> Handle(CancelResetPassword message)
496496
user.ResetPasswordResetToken();
497497
await userRepository.SaveAsync(user, o => o.Cache());
498498

499-
using (logger.BeginScope(new ExceptionlessState().Tag("Cancel Reset Password").Identity(user.EmailAddress).Property("User", user).SetHttpContext(httpContext)))
499+
using (logger.BeginScope(new ExceptionlessState().Tag("Cancel Reset Password").Identity(user.EmailAddress).SetHttpContext(httpContext)))
500500
logger.UserCanceledResetPassword(user.EmailAddress);
501501

502502
return Result.Success();
@@ -527,7 +527,7 @@ private async Task<Result<TokenResult>> ExternalLoginAsync(ExternalAuthInfo auth
527527
}
528528
catch (Exception ex)
529529
{
530-
logger.LogCritical(ex, "External login failed Code={AuthCode} RedirectUri={AuthRedirectUri}: {Message}", authInfo.Code, authInfo.RedirectUri, ex.Message);
530+
logger.LogCritical(ex, "External login failed RedirectUri={AuthRedirectUri}: {Message}", authInfo.RedirectUri, ex.Message);
531531
throw;
532532
}
533533

@@ -561,7 +561,7 @@ private async Task<User> FromExternalLoginAsync(UserInfo userInfo, string? invit
561561
ArgumentException.ThrowIfNullOrWhiteSpace(userInfo.Email);
562562

563563
var existingUser = await userRepository.GetUserByOAuthProviderAsync(userInfo.ProviderName, userInfo.Id);
564-
using var _ = logger.BeginScope(new ExceptionlessState().Tag("External Login").Property("User Info", userInfo).Property("ExistingUser", existingUser).SetHttpContext(httpContext));
564+
using var _ = logger.BeginScope(new ExceptionlessState().Tag("External Login").Tag(userInfo.ProviderName).Identity(userInfo.Email).SetHttpContext(httpContext));
565565

566566
if (String.IsNullOrWhiteSpace(inviteToken) && httpContext.User.IsUserAuthType())
567567
{
@@ -636,12 +636,12 @@ private async Task AddInvitedUserToOrganizationAsync(string? token, User user, H
636636
if (String.IsNullOrWhiteSpace(token))
637637
return;
638638

639-
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Invite").Identity(user.EmailAddress).Property("User", user).SetHttpContext(httpContext));
639+
using var _ = logger.BeginScope(new ExceptionlessState().Tag("Invite").Identity(user.EmailAddress).SetHttpContext(httpContext));
640640
var organization = await organizationRepository.GetByInviteTokenAsync(token);
641641
var invite = organization?.GetInvite(token);
642642
if (organization is null || invite is null)
643643
{
644-
logger.UnableToAddInvitedUserInvalidToken(user.EmailAddress, token);
644+
logger.UnableToAddInvitedUserInvalidToken(user.EmailAddress);
645645
return;
646646
}
647647

‎src/Exceptionless.Web/Api/Handlers/EventHandler.cs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -658,7 +658,7 @@ public async Task<Result<WorkInProgressResult>> Handle(DeleteEvents message)
658658
foreach (var projectGroup in projectGroups)
659659
{
660660
var ev = projectGroup.First();
661-
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(ev.OrganizationId).Project(ev.ProjectId).Tag("Delete").Identity(currentUser.EmailAddress).Property("User", currentUser).SetHttpContext(httpContext));
661+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(ev.OrganizationId).Project(ev.ProjectId).Tag("Delete").Identity(currentUser.EmailAddress).SetHttpContext(httpContext));
662662
_logger.LogInformation("User {User} deleted {RemovedCount} events in project ({ProjectId})", currentUser.Id, projectGroup.Count(), ev.ProjectId);
663663
}
664664

@@ -720,7 +720,7 @@ private async Task<Result<CountResult>> CountInternalAsync(AppFilter sf, TimeInf
720720
catch (Exception ex)
721721
{
722722
var currentUser = httpContext.Request.GetUser();
723-
using var _ = _logger.BeginScope(new ExceptionlessState().Property("Search Filter", new { SystemFilter = sf, UserFilter = filter, Time = ti, Aggregations = aggregations }).Tag("Search").Identity(currentUser.EmailAddress).Property("User", currentUser).SetHttpContext(httpContext));
723+
using var _ = _logger.BeginScope(new ExceptionlessState().Property("Search Filter", new { SystemFilter = sf, UserFilter = filter, Time = ti, Aggregations = aggregations }).Tag("Search").Identity(currentUser.EmailAddress).SetHttpContext(httpContext));
724724
_logger.LogError(ex, "An error has occurred. Please check your filter or aggregations: {Message}", ex.Message);
725725

726726
throw;
@@ -746,7 +746,6 @@ private async Task<Result<PagedResult<object>>> GetInternalAsync(AppFilter sf, T
746746
})
747747
.Tag("Search")
748748
.Identity(currentUser.EmailAddress)
749-
.Property("User", currentUser)
750749
.SetHttpContext(httpContext)
751750
);
752751

‎src/Exceptionless.Web/Api/Handlers/OrganizationHandler.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,7 @@ public async Task<Result<Invoice>> Handle(GetInvoice message)
203203
if (!options.StripeOptions.EnableBilling)
204204
return Result.NotFound("Organization not found.");
205205

206-
using var _ = _logger.BeginScope(new ExceptionlessState().Tag("Invoice").Identity(GetCurrentUser(message.Context).EmailAddress)
207-
.Property("User", GetCurrentUser(message.Context)).SetHttpContext(message.Context));
206+
using var _ = _logger.BeginScope(new ExceptionlessState().Tag("Invoice").Identity(GetCurrentUser(message.Context).EmailAddress).SetHttpContext(message.Context));
208207

209208
string invoiceId = message.Id;
210209
if (!invoiceId.StartsWith("in_", StringComparison.Ordinal))
@@ -357,7 +356,7 @@ public async Task<Result<ChangePlanResult>> Handle(ChangeOrganizationPlan messag
357356
return Result.NotFound("Organization not found.");
358357

359358
using var _ = _logger.BeginScope(new ExceptionlessState().Tag("Change Plan").Organization(message.Id)
360-
.Identity(GetCurrentUser(message.Context).EmailAddress).Property("User", GetCurrentUser(message.Context)).SetHttpContext(message.Context));
359+
.Identity(GetCurrentUser(message.Context).EmailAddress).SetHttpContext(message.Context));
361360

362361
if (!options.StripeOptions.EnableBilling)
363362
return Result.NotFound("Organization not found.");
@@ -880,7 +879,7 @@ private async Task<IEnumerable<string>> DeleteModelsAsync(ICollection<Organizati
880879
var user = GetCurrentUser(httpContext);
881880
foreach (var organization in organizations)
882881
{
883-
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(organization.Id).Tag("Delete").Identity(user.EmailAddress).Property("User", user).SetHttpContext(httpContext));
882+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(organization.Id).Tag("Delete").Identity(user.EmailAddress).SetHttpContext(httpContext));
884883
_logger.UserDeletingOrganization(user.Id, organization.Name, organization.Id);
885884
await organizationService.SoftDeleteOrganizationAsync(organization, user.Id);
886885
}

‎src/Exceptionless.Web/Api/Handlers/ProjectHandler.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ public async Task<Result<object>> Handle(AddProjectSlack message)
416416
if (project is null)
417417
return Result.NotFound("Project not found.");
418418

419-
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(project.OrganizationId).Project(project.Id).Property("Code", message.Code).Tag("Slack").Identity(GetCurrentUser(message.Context).EmailAddress).Property("User", GetCurrentUser(message.Context)).SetHttpContext(message.Context));
419+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(project.OrganizationId).Project(project.Id).Tag("Slack").Identity(GetCurrentUser(message.Context).EmailAddress).SetHttpContext(message.Context));
420420

421421
if (project.Data is not null && project.Data.ContainsKey(Project.KnownDataKeys.SlackToken))
422422
return new NotModifiedResponse();
@@ -447,7 +447,7 @@ public async Task<Result> Handle(RemoveProjectSlack message)
447447
return Result.NotFound("Project not found.");
448448

449449
var token = project.GetSlackToken(serializer, _logger);
450-
using var _ = _logger.BeginScope(new ExceptionlessState().Property("Token", token).Tag("Slack").Identity(GetCurrentUser(message.Context).EmailAddress).Property("User", GetCurrentUser(message.Context)).SetHttpContext(message.Context));
450+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(project.OrganizationId).Project(project.Id).Tag("Slack").Identity(GetCurrentUser(message.Context).EmailAddress).SetHttpContext(message.Context));
451451

452452
if (token is not null)
453453
await slackService.RevokeAccessTokenAsync(token.AccessToken);
@@ -589,7 +589,7 @@ private async Task<IEnumerable<string>> DeleteModelsAsync(ICollection<Project> p
589589
var user = GetCurrentUser(httpContext);
590590
foreach (var project in projects)
591591
{
592-
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(project.OrganizationId).Project(project.Id).Tag("Delete").Identity(user.EmailAddress).Property("User", user).SetHttpContext(httpContext));
592+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(project.OrganizationId).Project(project.Id).Tag("Delete").Identity(user.EmailAddress).SetHttpContext(httpContext));
593593
_logger.UserDeletingProject(user.Id, project.Name);
594594
await tokenRepository.RemoveAllByProjectIdAsync(project.OrganizationId, project.Id);
595595
}

‎src/Exceptionless.Web/Api/Handlers/StackHandler.cs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,6 @@ public async Task<Result> Handle(PromoteStack message)
274274
.Project(stack.ProjectId)
275275
.Tag("Promote")
276276
.Identity(currentUser.EmailAddress)
277-
.Property("User", currentUser)
278277
.SetHttpContext(httpContext));
279278

280279
var project = await GetProjectAsync(stack.ProjectId, httpContext);
@@ -335,7 +334,7 @@ public async Task<Result<WorkInProgressResult>> Handle(DeleteStacks message)
335334
foreach (var projectStacks in list.GroupBy(ev => ev.ProjectId))
336335
{
337336
var stack = projectStacks.First();
338-
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(stack.OrganizationId).Project(stack.ProjectId).Tag("Delete").Identity(currentUser.EmailAddress).Property("User", currentUser).SetHttpContext(httpContext));
337+
using var _ = _logger.BeginScope(new ExceptionlessState().Organization(stack.OrganizationId).Project(stack.ProjectId).Tag("Delete").Identity(currentUser.EmailAddress).SetHttpContext(httpContext));
339338
_logger.LogInformation("User {User} deleted {RemovedCount} stacks in project ({ProjectId})", currentUser.Id, projectStacks.Count(), stack.ProjectId);
340339
}
341340

@@ -425,7 +424,7 @@ private async Task<Result<PagedResult<object>>> GetInternalAsync(AppFilter sf, T
425424
catch (ApplicationException ex)
426425
{
427426
var currentUser = httpContext.Request.GetUser();
428-
using (_logger.BeginScope(new ExceptionlessState().Property("Search Filter", new { SystemFilter = sf, UserFilter = filter, Time = ti, Page = page, Limit = limit }).Tag("Search").Identity(currentUser?.EmailAddress).Property("User", currentUser).SetHttpContext(httpContext)))
427+
using (_logger.BeginScope(new ExceptionlessState().Property("Search Filter", new { SystemFilter = sf, UserFilter = filter, Time = ti, Page = page, Limit = limit }).Tag("Search").Identity(currentUser?.EmailAddress).SetHttpContext(httpContext)))
429428
_logger.LogError(ex, "An error has occurred. Please check your search filter");
430429

431430
throw;

‎src/Exceptionless.Web/Api/Handlers/UserHandler.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ public async Task<Result<UpdateEmailAddressResult>> Handle(UpdateEmailAddress me
214214
if (user is null)
215215
return Result.NotFound("User not found.");
216216

217-
using var _ = _logger.BeginScope(new ExceptionlessState().Property("User", user).SetHttpContext(HttpContext));
217+
using var _ = _logger.BeginScope(new ExceptionlessState().Identity(user.EmailAddress).SetHttpContext(HttpContext));
218218

219219
string email = message.Email.Trim().ToLowerInvariant();
220220
var currentUser = HttpContext.Request.GetUser();

‎src/Exceptionless.Web/Extensions/LoggerExtensions.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ internal static class LoggerExtensions
9898
new EventId(15, nameof(UserRemovedExternalLogin)),
9999
"{EmailAddress} removed an external login: {ProviderName}");
100100

101-
private static readonly Action<ILogger, string, string, Exception?> _unableToAddInvitedUserInvalidToken =
102-
LoggerMessage.Define<string, string>(
101+
private static readonly Action<ILogger, string, Exception?> _unableToAddInvitedUserInvalidToken =
102+
LoggerMessage.Define<string>(
103103
LogLevel.Information,
104104
new EventId(16, nameof(UnableToAddInvitedUserInvalidToken)),
105-
"Unable to add the invited user {EmailAddress}. Invalid invite token: {Token}");
105+
"Unable to add the invited user {EmailAddress}. Invalid invite token.");
106106

107107
private static readonly Action<ILogger, long, string, Exception?> _removedUserTokens =
108108
LoggerMessage.Define<long, string>(
@@ -158,8 +158,8 @@ public static void MarkedInvitedUserAsVerified(this ILogger logger, string email
158158
public static void UserRemovedExternalLogin(this ILogger logger, string email, string providerName)
159159
=> _userRemovedExternalLogin(logger, email, providerName, null);
160160

161-
public static void UnableToAddInvitedUserInvalidToken(this ILogger logger, string email, string token)
162-
=> _unableToAddInvitedUserInvalidToken(logger, email, token, null);
161+
public static void UnableToAddInvitedUserInvalidToken(this ILogger logger, string email)
162+
=> _unableToAddInvitedUserInvalidToken(logger, email, null);
163163

164164
public static void RemovedUserTokens(this ILogger logger, long total, string email)
165165
=> _removedUserTokens(logger, total, email, null);

0 commit comments

Comments
 (0)
⌂ 换网址