Implement loggers (#115)

* Implement loggers replacing event based logging

* Add a missing factory

* Cleanup

* Fix a disconnected log

* Improve voice client logs

* Improve RestClient logs

* Improve websocket logs

* Improve rate limited exceptions

* Improve loggers

* Update guides

* Cleanup

* Remove useless code

* Cleanup

* Minor logging improvements

* Improve handler exception logging

* Update logs of ApplicationCommandServiceHostedService

* Improve logging of NetCord.Hosting.AspNetCore

* Normalize exception formatting

Author: KubaZ2

Documentation/guides/basic-concepts/Sharding/Program.cs

@@ -1,13 +1,11 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 
-ShardedGatewayClient client = new(new BotToken("Token from Discord Developer Portal"));
-
-client.Log += (client, message) =>
+ShardedGatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new ShardedGatewayClientConfiguration
 {
-    Console.WriteLine($"#{client.Shard.GetValueOrDefault().Id}\t{message}");
-    return default;
-};
+    LoggerFactory = ShardedConsoleLogger.GetFactory(),
+});
 
 await client.StartAsync();
 await Task.Delay(-1);

Documentation/guides/basic-concepts/Sharding/RegisteringHandlers.cs

@@ -1,19 +1,17 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 
 namespace MyBot;
 
 internal class RegisteringHandlers
 {
     public static async Task RegisterHandlersAsync()
     {
-        ShardedGatewayClient client = new(new BotToken("Token from Discord Developer Portal"));
-
-        client.Log += (client, message) =>
+        ShardedGatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new ShardedGatewayClientConfiguration
         {
-            Console.WriteLine($"#{client.Shard.GetValueOrDefault().Id}\t{message}");
-            return default;
-        };
+            LoggerFactory = ShardedConsoleLogger.GetFactory(),
+        });
 
         client.MessageUpdate += async (client, message) =>
         {

Documentation/guides/basic-concepts/Voice/Program.cs

@@ -1,12 +1,14 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 using NetCord.Rest;
 using NetCord.Services;
 using NetCord.Services.ApplicationCommands;
 
-GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration()
+GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration
 {
     Intents = GatewayIntents.Guilds | GatewayIntents.GuildVoiceStates,
+    Logger = new ConsoleLogger(),
 });
 
 ApplicationCommandService<ApplicationCommandContext> applicationCommandService = new();
@@ -33,11 +35,5 @@
 
 await applicationCommandService.CreateCommandsAsync(client.Rest, client.Id);
 
-client.Log += message =>
-{
-    Console.WriteLine(message);
-    return default;
-};
-
 await client.StartAsync();
 await Task.Delay(-1);

Documentation/guides/basic-concepts/Voice/VoiceModule.cs

@@ -2,6 +2,7 @@
 
 using NetCord;
 using NetCord.Gateway.Voice;
+using NetCord.Logging;
 using NetCord.Rest;
 using NetCord.Services.ApplicationCommands;
 
@@ -35,7 +36,11 @@ public async Task PlayAsync(string track)
         // You also need to add a synchronization here. 'JoinVoiceChannelAsync' should not be used concurrently for the same guild
         var voiceClient = await client.JoinVoiceChannelAsync(
             guild.Id,
-            voiceState.ChannelId.GetValueOrDefault());
+            voiceState.ChannelId.GetValueOrDefault(),
+            new VoiceClientConfiguration
+            {
+                Logger = new ConsoleLogger(),
+            });
 
         // Connect
         await voiceClient.StartAsync();
@@ -122,7 +127,11 @@ public async Task<string> EchoAsync()
         var voiceClient = await client.JoinVoiceChannelAsync(
             guild.Id,
             voiceState.ChannelId.GetValueOrDefault(),
-            new() { RedirectInputStreams = true /* Required to receive voice */ });
+            new VoiceClientConfiguration
+            {
+                RedirectInputStreams = true, // Required to receive voice
+                Logger = new ConsoleLogger(),
+            });
 
         // Connect
         await voiceClient.StartAsync();

Documentation/guides/basic-concepts/sharding.md

@@ -41,4 +41,4 @@ When creating event handlers, implement @NetCord.Hosting.Gateway.IShardedGateway
 ### [Bare Bones](#tab/bare-bones)
 
 For bare-bones setups, adding event handlers is straightforward. Each handler has an additional parameter for the @NetCord.Gateway.GatewayClient that received the event.
-[!code-cs[Program.cs](Sharding/RegisteringHandlers.cs#L18-L21)]
+[!code-cs[Program.cs](Sharding/RegisteringHandlers.cs#L16-L19)]

Documentation/guides/basic-concepts/voice.md

@@ -10,7 +10,7 @@ Follow the [installation guide](installing-native-dependencies.md) to install th
 > In the following examples streams and @NetCord.Gateway.Voice.VoiceClient instances are not disposed because they should be stored somewhere and disposed later.
 
 ### Sending Voice
-[!code-cs[VoiceModule.cs](Voice/VoiceModule.cs#L12-L105)]
+[!code-cs[VoiceModule.cs](Voice/VoiceModule.cs#L13-L110)]
 
 ### Receiving Voice
-[!code-cs[VoiceModule.cs](Voice/VoiceModule.cs#L107-L146)]
+[!code-cs[VoiceModule.cs](Voice/VoiceModule.cs#L112-L155)]

Documentation/guides/getting-started/Coding/Program.cs

@@ -1,13 +1,11 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 
-GatewayClient client = new(new BotToken("Token from Discord Developer Portal"));
-
-client.Log += message =>
+GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration
 {
-    Console.WriteLine(message);
-    return default;
-};
+    Logger = new ConsoleLogger(),
+});
 
 await client.StartAsync();
 await Task.Delay(-1);

Documentation/guides/getting-started/making-a-bot.md

@@ -72,13 +72,12 @@ For better configuration management, store the token in an `appsettings.json` fi
 #### [Bare Bones](#tab/bare-bones)
 
 To create the @NetCord.Gateway.GatewayClient manually, add the following lines to your `Program.cs` file.
-[!code-cs[Program.cs](Coding/Program.cs#L1-L4)]
+[!code-cs[Program.cs](Coding/Program.cs#L1-L8)]
 
-Next, you can add logging to track your bot's activity.
-[!code-cs[Program.cs](Coding/Program.cs#L6-L10)]
+We have also added a console logger to log messages to the console. This is useful for debugging and monitoring your bot's activity.
 
 Finally, start your bot with the following lines.
-[!code-cs[Program.cs](Coding/Program.cs#L12-L13)]
+[!code-cs[Program.cs](Coding/Program.cs#L10-L11)]
 
 #### The Final Product
 [!code-cs[Program.cs](Coding/Program.cs)]

Documentation/guides/services/application-commands/Introduction/Program.cs

@@ -1,12 +1,14 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 using NetCord.Rest;
 using NetCord.Services;
 using NetCord.Services.ApplicationCommands;
 
-GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration()
+GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration
 {
     Intents = default,
+    Logger = new ConsoleLogger(),
 });
 
 // Create the application command service
@@ -47,11 +49,5 @@
 // Create the commands so that you can use them in the Discord client
 await applicationCommandService.CreateCommandsAsync(client.Rest, client.Id);
 
-client.Log += message =>
-{
-    Console.WriteLine(message);
-    return default;
-};
-
 await client.StartAsync();
 await Task.Delay(-1);

Documentation/guides/services/application-commands/Localizations/Program.cs

@@ -1,12 +1,14 @@
 using NetCord;
 using NetCord.Gateway;
+using NetCord.Logging;
 using NetCord.Rest;
 using NetCord.Services;
 using NetCord.Services.ApplicationCommands;
 
-GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration()
+GatewayClient client = new(new BotToken("Token from Discord Developer Portal"), new GatewayClientConfiguration
 {
     Intents = default,
+    Logger = new ConsoleLogger(),
 });
 
 ApplicationCommandService<ApplicationCommandContext> applicationCommandService = new(ApplicationCommandServiceConfiguration<ApplicationCommandContext>.Default with
@@ -37,11 +39,5 @@
 
 await applicationCommandService.CreateCommandsAsync(client.Rest, client.Id);
 
-client.Log += message =>
-{
-    Console.WriteLine(message);
-    return default;
-};
-
 await client.StartAsync();
 await Task.Delay(-1);