bitwarden/server
1
0
Fork 0
mirror of https://github.com/bitwarden/server synced 2025-12-26 05:03:18 +00:00
Code Issues Releases Wiki Activity

[PM-17562] Update logs to use custom categories (#6145)

Browse Source 
* [PM-17562] Update logs to use custom categories

* Added tests to verify hardcoded names match the real type
This commit is contained in:
Brant DeBow
2025-08-01 08:46:00 -04:00
committed by GitHub
parent 6f4a0c4a61
commit ccedefb8b8
10 changed files with 192 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Core/AdminConsole/Services/EventLoggingListenerService.cs
View File

@@ -10,9 +10,9 @@ namespace Bit.Core.Services;
public abstract class EventLoggingListenerService : BackgroundService
{
protected readonly IEventMessageHandler _handler;
protected ILogger<EventLoggingListenerService> _logger;
protected ILogger _logger;
protected EventLoggingListenerService(IEventMessageHandler handler, ILogger<EventLoggingListenerService> logger)
protected EventLoggingListenerService(IEventMessageHandler handler, ILogger logger)
{
_handler = handler;
_logger = logger;

9
src/Core/AdminConsole/Services/Implementations/EventIntegrations/AzureServiceBusEventListenerService.cs
View File

@@ -16,7 +16,8 @@ public class AzureServiceBusEventListenerService<TConfiguration> : EventLoggingL
TConfiguration configuration,
IEventMessageHandler handler,
IAzureServiceBusService serviceBusService,
ILogger<AzureServiceBusEventListenerService<TConfiguration>> logger) : base(handler, logger)
ILoggerFactory loggerFactory)
: base(handler, CreateLogger(loggerFactory, configuration))
{
_processor = serviceBusService.CreateProcessor(
topicName: configuration.EventTopicName,
@@ -39,6 +40,12 @@ public class AzureServiceBusEventListenerService<TConfiguration> : EventLoggingL
await base.StopAsync(cancellationToken);
}
private static ILogger CreateLogger(ILoggerFactory loggerFactory, TConfiguration configuration)
{
return loggerFactory.CreateLogger(
categoryName: $"Bit.Core.Services.AzureServiceBusEventListenerService.{configuration.EventSubscriptionName}");
}
internal Task ProcessErrorAsync(ProcessErrorEventArgs args)
{
_logger.LogError(

7
src/Core/AdminConsole/Services/Implementations/EventIntegrations/AzureServiceBusIntegrationListenerService.cs
View File

@@ -14,16 +14,17 @@ public class AzureServiceBusIntegrationListenerService<TConfiguration> : Backgro
private readonly IAzureServiceBusService _serviceBusService;
private readonly IIntegrationHandler _handler;
private readonly ServiceBusProcessor _processor;
private readonly ILogger<AzureServiceBusIntegrationListenerService<TConfiguration>> _logger;
private readonly ILogger _logger;
public AzureServiceBusIntegrationListenerService(
TConfiguration configuration,
IIntegrationHandler handler,
IAzureServiceBusService serviceBusService,
ILogger<AzureServiceBusIntegrationListenerService<TConfiguration>> logger)
ILoggerFactory loggerFactory)
{
_handler = handler;
_logger = logger;
_logger = loggerFactory.CreateLogger(
categoryName: $"Bit.Core.Services.AzureServiceBusIntegrationListenerService.{configuration.IntegrationSubscriptionName}");
_maxRetries = configuration.MaxRetries;
_serviceBusService = serviceBusService;

9
src/Core/AdminConsole/Services/Implementations/EventIntegrations/RabbitMqEventListenerService.cs
View File

@@ -19,7 +19,8 @@ public class RabbitMqEventListenerService<TConfiguration> : EventLoggingListener
IEventMessageHandler handler,
TConfiguration configuration,
IRabbitMqService rabbitMqService,
ILogger<RabbitMqEventListenerService<TConfiguration>> logger) : base(handler, logger)
ILoggerFactory loggerFactory)
: base(handler, CreateLogger(loggerFactory, configuration))
{
_queueName = configuration.EventQueueName;
_rabbitMqService = rabbitMqService;
@@ -66,4 +67,10 @@ public class RabbitMqEventListenerService<TConfiguration> : EventLoggingListener
}
base.Dispose();
}
private static ILogger CreateLogger(ILoggerFactory loggerFactory, TConfiguration configuration)
{
return loggerFactory.CreateLogger(
categoryName: $"Bit.Core.Services.RabbitMqEventListenerService.{configuration.EventQueueName}");
}
}

7
src/Core/AdminConsole/Services/Implementations/EventIntegrations/RabbitMqIntegrationListenerService.cs
View File

@@ -20,14 +20,14 @@ public class RabbitMqIntegrationListenerService<TConfiguration> : BackgroundServ
private readonly IIntegrationHandler _handler;
private readonly Lazy<Task<IChannel>> _lazyChannel;
private readonly IRabbitMqService _rabbitMqService;
private readonly ILogger<RabbitMqIntegrationListenerService<TConfiguration>> _logger;
private readonly ILogger _logger;
private readonly TimeProvider _timeProvider;
public RabbitMqIntegrationListenerService(
IIntegrationHandler handler,
TConfiguration configuration,
IRabbitMqService rabbitMqService,
ILogger<RabbitMqIntegrationListenerService<TConfiguration>> logger,
ILoggerFactory loggerFactory,
TimeProvider timeProvider)
{
_handler = handler;
@@ -36,9 +36,10 @@ public class RabbitMqIntegrationListenerService<TConfiguration> : BackgroundServ
_retryQueueName = configuration.IntegrationRetryQueueName;
_queueName = configuration.IntegrationQueueName;
_rabbitMqService = rabbitMqService;
_logger = logger;
_timeProvider = timeProvider;
_lazyChannel = new Lazy<Task<IChannel>>(() => _rabbitMqService.CreateChannelAsync());
_logger = loggerFactory.CreateLogger(
categoryName: $"Bit.Core.Services.RabbitMqIntegrationListenerService.{configuration.IntegrationQueueName}"); ;
}
public override async Task StartAsync(CancellationToken cancellationToken)

12
src/SharedWeb/Utilities/ServiceCollectionExtensions.cs
View File

@@ -890,7 +890,7 @@ public static class ServiceCollectionExtensions
configuration: listenerConfiguration,
handler: provider.GetRequiredKeyedService<IEventMessageHandler>(serviceKey: listenerConfiguration.RoutingKey),
serviceBusService: provider.GetRequiredService<IAzureServiceBusService>(),
logger: provider.GetRequiredService<ILogger<AzureServiceBusEventListenerService<TListenerConfig>>>()
loggerFactory: provider.GetRequiredService<ILoggerFactory>()
)
)
);
@@ -900,7 +900,7 @@ public static class ServiceCollectionExtensions
configuration: listenerConfiguration,
handler: provider.GetRequiredService<IIntegrationHandler<TConfig>>(),
serviceBusService: provider.GetRequiredService<IAzureServiceBusService>(),
logger: provider.GetRequiredService<ILogger<AzureServiceBusIntegrationListenerService<TListenerConfig>>>()
loggerFactory: provider.GetRequiredService<ILoggerFactory>()
)
)
);
@@ -941,7 +941,7 @@ public static class ServiceCollectionExtensions
handler: provider.GetRequiredService<EventRepositoryHandler>(),
configuration: repositoryConfiguration,
rabbitMqService: provider.GetRequiredService<IRabbitMqService>(),
logger: provider.GetRequiredService<ILogger<RabbitMqEventListenerService<RepositoryListenerConfiguration>>>()
loggerFactory: provider.GetRequiredService<ILoggerFactory>()
)
)
);
@@ -958,7 +958,7 @@ public static class ServiceCollectionExtensions
configuration: repositoryConfiguration,
handler: provider.GetRequiredService<AzureTableStorageEventHandler>(),
serviceBusService: provider.GetRequiredService<IAzureServiceBusService>(),
logger: provider.GetRequiredService<ILogger<AzureServiceBusEventListenerService<RepositoryListenerConfiguration>>>()
loggerFactory: provider.GetRequiredService<ILoggerFactory>()
)
)
);
@@ -992,7 +992,7 @@ public static class ServiceCollectionExtensions
handler: provider.GetRequiredKeyedService<IEventMessageHandler>(serviceKey: listenerConfiguration.RoutingKey),
configuration: listenerConfiguration,
rabbitMqService: provider.GetRequiredService<IRabbitMqService>(),
logger: provider.GetRequiredService<ILogger<RabbitMqEventListenerService<TListenerConfig>>>()
loggerFactory: provider.GetRequiredService<ILoggerFactory>()
)
)
);
@@ -1002,7 +1002,7 @@ public static class ServiceCollectionExtensions
handler: provider.GetRequiredService<IIntegrationHandler<TConfig>>(),
configuration: listenerConfiguration,
rabbitMqService: provider.GetRequiredService<IRabbitMqService>(),
logger: provider.GetRequiredService<ILogger<RabbitMqIntegrationListenerService<TListenerConfig>>>(),
loggerFactory: provider.GetRequiredService<ILoggerFactory>(),
timeProvider: provider.GetRequiredService<TimeProvider>()
)
)