Skip to content

Commit 7e638a2

Browse files
sommmensommmen
committed
feat: Added multi-log table support
1 parent 4434538 commit 7e638a2

File tree

23 files changed

+401
-40
lines changed

23 files changed

+401
-40
lines changed

‎samples/SampleWebApp/Properties/launchSettings.json‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
{
2-
"iisSettings": {
3-
"windowsAuthentication": false,
4-
"anonymousAuthentication": true,
5-
"iisExpress": {
6-
"applicationUrl": "http://localhost:7501",
7-
"sslPort": 44377
8-
}
9-
},
1+
{
102
"profiles": {
113
"IIS Express": {
124
"commandName": "IISExpress",
@@ -17,12 +9,21 @@
179
},
1810
"SampleWebApp": {
1911
"commandName": "Project",
20-
"dotnetRunMessages": "true",
2112
"launchBrowser": true,
22-
"applicationUrl": "https://localhost:5001;http://localhost:5000",
13+
"launchUrl": "https://localhost:5001/serilog-ui",
2314
"environmentVariables": {
2415
"ASPNETCORE_ENVIRONMENT": "Development"
25-
}
16+
},
17+
"dotnetRunMessages": "true",
18+
"applicationUrl": "https://localhost:5001;http://localhost:5000"
19+
}
20+
},
21+
"iisSettings": {
22+
"windowsAuthentication": false,
23+
"anonymousAuthentication": true,
24+
"iisExpress": {
25+
"applicationUrl": "http://localhost:7501",
26+
"sslPort": 44377
2627
}
2728
}
28-
}
29+
}

‎samples/SampleWebApp/Services/HostedServices/SecondLogDummyLogGeneratorBackgroundService.cs‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
using System;
2+
using System.Diagnostics;
3+
using System.Threading;
4+
using System.Threading.Tasks;
5+
using Microsoft.Extensions.Configuration;
6+
using Microsoft.Extensions.Hosting;
7+
using Serilog;
8+
using Serilog.Events;
9+
10+
namespace SampleWebApp.Services.HostedServices;
11+
12+
/// <summary>
13+
/// A background service that generates some dummy logs every 5 seconds.
14+
/// </summary>
15+
public class SecondLogDummyLogGeneratorBackgroundService : BackgroundService
16+
{
17+
private readonly IConfiguration _configuration;
18+
19+
public SecondLogDummyLogGeneratorBackgroundService(IConfiguration configuration)
20+
{
21+
_configuration = configuration;
22+
}
23+
24+
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
25+
{
26+
// Create the logger
27+
var logger = new LoggerConfiguration()
28+
.ReadFrom
29+
.Configuration(_configuration, "Serilog2")
30+
.CreateLogger()
31+
.ForContext<SecondLogDummyLogGeneratorBackgroundService>();
32+
33+
var rand = new Random();
34+
35+
// Lets not generate too much data per run.
36+
const int limit = 10;
37+
38+
var count = 0;
39+
while (++count <= limit)
40+
{
41+
// Stop when the application is stopping.
42+
stoppingToken.ThrowIfCancellationRequested();
43+
44+
// Get a random level
45+
var level = (LogEventLevel) rand.NextInt64((long)LogEventLevel.Fatal + 1L);
46+
47+
// Get a random number
48+
var n = rand.NextInt64(0, 101);
49+
50+
Exception exception = null;
51+
52+
if (level >= LogEventLevel.Error)
53+
{
54+
exception = GetException();
55+
}
56+
57+
logger.Write(level, exception, "Here's a random value: {n}", n);
58+
59+
await Task.Delay(TimeSpan.FromSeconds(5), stoppingToken);
60+
}
61+
62+
}
63+
64+
[DebuggerHidden]
65+
private static Exception GetException()
66+
{
67+
try
68+
{
69+
throw new TestException();
70+
}
71+
catch (Exception e)
72+
{
73+
return e;
74+
}
75+
}
76+
77+
/// <summary>
78+
/// Feel free to disable breaking on this exception in your debugger settings.
79+
/// </summary>
80+
private class TestException : Exception
81+
{
82+
public TestException()
83+
: base("This is a test exception.")
84+
{
85+
}
86+
}
87+
}

‎samples/SampleWebApp/Startup.cs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
using Microsoft.IdentityModel.Tokens;
1010
using SampleWebApp.Authentication.Jwt;
1111
using SampleWebApp.Data;
12+
using SampleWebApp.Services.HostedServices;
1213
using Serilog.Ui.MsSqlServerProvider;
1314
using Serilog.Ui.Web;
1415

@@ -44,9 +45,14 @@ public void ConfigureServices(IServiceCollection services)
4445
authOption.AuthenticationType = AuthenticationType.Jwt;
4546
authOption.Usernames = new[] { "[email protected]" };
4647
})
47-
.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"), "Logs"));
48+
.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"), "Logs")
49+
.UseSqlServer(Configuration.GetConnectionString("SecondLogConnection"), "Logs2")
50+
);
4851

4952
services.AddSwaggerGen();
53+
54+
// Generate some dummy logs
55+
services.AddHostedService<SecondLogDummyLogGeneratorBackgroundService>();
5056
}
5157

5258
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.

‎samples/SampleWebApp/appsettings.json‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"ConnectionStrings": {
3-
"DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=aspnet-SampleWebApp-93B544DE-DDCF-47C1-AD8A-BC87C4D6B954;Trusted_Connection=True;MultipleActiveResultSets=true"
3+
"DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=aspnet-SampleWebApp-93B544DE-DDCF-47C1-AD8A-BC87C4D6B954;Trusted_Connection=True;MultipleActiveResultSets=true",
4+
"SecondLogConnection": "Server=(localdb)\\mssqllocaldb;Database=aspnet-SampleWebApp-93B544DE-DDCF-47C1-AD8A-BC87C4D6B954;Trusted_Connection=True;MultipleActiveResultSets=true"
45
},
56

67
"AllowedHosts": "*",
@@ -34,5 +35,22 @@
3435
}
3536
}
3637
]
38+
},
39+
40+
"Serilog2": {
41+
"Using": [ "Serilog.Sinks.MSSqlServer" ],
42+
"MinimumLevel": "Debug",
43+
"WriteTo": [
44+
{
45+
"Name": "MSSqlServer",
46+
"Args": {
47+
"connectionString": "SecondLogConnection",
48+
"sinkOptionsSection": {
49+
"tableName": "Logs2",
50+
"autoCreateSqlTable": true
51+
}
52+
}
53+
}
54+
]
3755
}
3856
}

‎src/Serilog.Ui.Core/AggregateDataProvider.cs‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Threading.Tasks;
5+
6+
namespace Serilog.Ui.Core.Services
7+
{
8+
/// <summary>
9+
/// Aggregates multiple <see cref="IDataProvider"/> into one instance.
10+
/// </summary>
11+
public class AggregateDataProvider : IDataProvider
12+
{
13+
/// <summary>
14+
/// <inheritdoc cref="IDataProvider.Name"/>
15+
/// NOTE We assume only one Aggregate provider, so the name is static.
16+
/// </summary>
17+
public string Name => nameof(AggregateDataProvider);
18+
19+
private IDataProvider _dataProvider;
20+
21+
/// <summary>
22+
/// If there is only one data provider, this is it.
23+
/// If there are multiple, this is the current data provider.
24+
/// </summary>
25+
public IDataProvider DataProvider => _dataProvider;
26+
27+
private readonly Dictionary<string, IDataProvider> _dataProviders = new Dictionary<string, IDataProvider>();
28+
29+
public AggregateDataProvider(IEnumerable<IDataProvider> dataProviders)
30+
{
31+
if (dataProviders == null) throw new ArgumentNullException(nameof(dataProviders));
32+
33+
foreach (var grouped in dataProviders
34+
.GroupBy(c => c.Name, e => e, (k, e) => e.ToList()))
35+
{
36+
var name = grouped[0].Name;
37+
38+
if (grouped.Count == 1)
39+
{
40+
_dataProviders.Add(name, grouped[0]);
41+
}
42+
else
43+
{
44+
// When providers with the same name are registered, we ensure uniqueness by generating a key
45+
// I.e. ["MSSQL.dbo.logs", "MSSQL.dbo.logs"] => ["MSSQL.dbo.logs[0]", "MSSQL.dbo.logs[1]"]
46+
for (var i = 0; i < grouped.Count; i++)
47+
{
48+
var dataProvider = grouped[i];
49+
_dataProviders.Add($"{name}[{i}]", dataProvider);
50+
}
51+
}
52+
}
53+
54+
_dataProvider = _dataProviders.First(c => true).Value;
55+
}
56+
57+
public void SwitchToProvider(string key)
58+
=> _dataProvider = _dataProviders[key];
59+
60+
public IEnumerable<string> Keys => _dataProviders.Keys;
61+
62+
#region Delegating members of IDataProvider
63+
64+
public async Task<(IEnumerable<LogModel>, int)> FetchDataAsync(int page, int count, string level = null, string searchCriteria = null, DateTime? startDate = null, DateTime? endDate = null)
65+
{
66+
return await DataProvider.FetchDataAsync(page, count, level, searchCriteria, startDate, endDate);
67+
}
68+
69+
#endregion
70+
71+
}
72+
}

‎src/Serilog.Ui.Core/Extensions/RelationalDbOptionsExtensions.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
namespace Serilog.Ui.Core.Extensions
2+
{
3+
public static class RelationalDbOptionsExtensions
4+
{
5+
public static string ToDataProviderName(this RelationalDbOptions options, string providerName)
6+
=> string.Join(".", "MSSQL", options.Schema, options.TableName);
7+
}
8+
}

‎src/Serilog.Ui.Core/IDataProvider.cs‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,13 @@ public interface IDataProvider
2727
DateTime? startDate = null,
2828
DateTime? endDate = null
2929
);
30+
31+
/// <summary>
32+
/// Name of the provider, used to identify this provider when using multiple.
33+
/// </summary>
34+
string Name { get; }
3035
}
31-
}
36+
}
37+
namespace Serilog.Ui.Core.Services
38+
{
39+
}

‎src/Serilog.Ui.ElasticSearchProvider/ElasticSearchDbDataProvider.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@ namespace Serilog.Ui.ElasticSearchProvider
1010
{
1111
public class ElasticSearchDbDataProvider : IDataProvider
1212
{
13+
public string Name { get; set; }
14+
1315
private readonly IElasticClient _client;
1416
private readonly ElasticSearchDbOptions _options;
15-
17+
1618
public ElasticSearchDbDataProvider(IElasticClient client, ElasticSearchDbOptions options)
1719
{
1820
_client = client ?? throw new ArgumentNullException(nameof(client));
1921
_options = options ?? throw new ArgumentNullException(nameof(options));
22+
Name = string.Join("ES", _options.IndexName);
2023
}
2124

2225
public Task<(IEnumerable<LogModel>, int)> FetchDataAsync(

‎src/Serilog.Ui.ElasticSearchProvider/Extensions/SerilogUiOptionBuilderExtensions.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
using Nest;
44
using Serilog.Ui.Core;
55
using System;
6+
using System.Linq;
67

78
namespace Serilog.Ui.ElasticSearchProvider
89
{
@@ -34,6 +35,11 @@ public static void UseElasticSearchDb(this SerilogUiOptionsBuilder optionsBuilde
3435

3536
var builder = ((ISerilogUiOptionsBuilder)optionsBuilder);
3637

38+
// TODO Fixup ES to allow multiple registrations.
39+
// Think about multiple ES clients (singletons) used in data providers (scoped)
40+
if (builder.Services.Any(c => c.ImplementationType == typeof(ElasticSearchDbDataProvider)))
41+
throw new NotSupportedException($"Adding multiple registrations of '{typeof(ElasticSearchDbDataProvider).FullName}' is not (yet) supported.");
42+
3743
builder.Services.AddSingleton(options);
3844

3945
var pool = new SingleNodeConnectionPool(endpoint);

‎src/Serilog.Ui.MongoDbProvider/Extensions/SerilogUiOptionBuilderExtensions.cs‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
using MongoDB.Driver;
44
using Serilog.Ui.Core;
55
using System;
6+
using System.Linq;
67

78
namespace Serilog.Ui.MongoDbProvider
89
{
@@ -38,9 +39,16 @@ string collectionName
3839
CollectionName = collectionName
3940
};
4041

41-
((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddSingleton(mongoProvider);
42-
((ISerilogUiOptionsBuilder)optionsBuilder).Services.TryAddSingleton<IMongoClient>(o => new MongoClient(connectionString));
43-
((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddScoped<IDataProvider, MongoDbDataProvider>();
42+
var builder = ((ISerilogUiOptionsBuilder)optionsBuilder);
43+
44+
// TODO Fixup MongoDb to allow multiple registrations.
45+
// Think about multiple ES clients (singletons) used in data providers (scoped)
46+
if (builder.Services.Any(c => c.ImplementationType == typeof(MongoDbDataProvider)))
47+
throw new NotSupportedException($"Adding multiple registrations of '{typeof(MongoDbDataProvider).FullName}' is not (yet) supported.");
48+
49+
builder.Services.AddSingleton(mongoProvider);
50+
builder.Services.TryAddSingleton<IMongoClient>(o => new MongoClient(connectionString));
51+
builder.Services.AddScoped<IDataProvider, MongoDbDataProvider>();
4452
}
4553

4654
/// <summary>
@@ -76,6 +84,13 @@ string collectionName
7684
CollectionName = collectionName
7785
};
7886

87+
var builder = ((ISerilogUiOptionsBuilder)optionsBuilder);
88+
89+
// TODO Fixup MongoDb to allow multiple registrations.
90+
// Think about multiple ES clients (singletons) used in data providers (scoped)
91+
if (builder.Services.Any(c => c.ImplementationType == typeof(MongoDbDataProvider)))
92+
throw new NotSupportedException($"Adding multiple registrations of '{typeof(MongoDbDataProvider).FullName}' is not (yet) supported.");
93+
7994
((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddSingleton(mongoProvider);
8095
((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddSingleton<IMongoClient>(o => new MongoClient(connectionString));
8196
((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddScoped<IDataProvider, MongoDbDataProvider>();

0 commit comments

Comments
 (0)