feat: add logging section for .NET SDK

Author: Odonno

bun.lockb

@@ -29,8 +29,8 @@ We have added a new Connection String called <code>SurrealDB</code> with the def
   "AllowedHosts": "*",
   "Logging": {
     "LogLevel": {
-    "Default": "Information",
-    "Microsoft.AspNetCore": "Warning"
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
     }
   },
   "ConnectionStrings": {
@@ -143,4 +143,4 @@ Then make sure your SurrealDB server is running on <code>127.0.0.1:8000</code> a
 
 ```sh
 dotnet run
-```
+```

src/assets/img/dotnet-logging-console.png

@@ -17,5 +17,4 @@ In this section, we will go over the core concepts of the SurrealDB SDK for .NET
 - [Run SurrealQL queries](/docs/sdk/dotnet/core/writing-surrealql)
 - [Connection Strings](/docs/sdk/dotnet/core/connection-strings)
 - [Dependency Injection](/docs/sdk/dotnet/core/dependency-injection)
-
-
+- [Logging](/docs/sdk/dotnet/core/logging)

src/content/doc-sdk-dotnet/core/dependency-injection.mdx

@@ -0,0 +1,68 @@
+---
+sidebar_position: 9
+sidebar_label: Logging
+title: Logging | .NET | SDK | Concepts
+description: In case you need to understand what your application is doing, the SurrealDB SDK has a built-in logging mechanism.
+---
+
+import Image from "@components/Image.astro";
+import LoggingConsoleImg from "@img/dotnet-logging-console.png";
+
+# Logging
+
+Logging is an important part of any application to understand what is happening. The .NET SDK supports the built-in logging API offered by the `Microsoft.Extensions.Logging` NuGet package.
+
+## Logging categories
+
+The SurrealDB SDK for .NET has a set of logging categories so that you can pick what you want to display, using the respective `LogLevel`.
+
+Example:
+
+```bash
+{
+  "Logging": {
+    "LogLevel": {
+      "SurrealDB.Connection": "Information",
+      "SurrealDB.Method": "Information",
+      "SurrealDB.Query": "Information",
+      "SurrealDB.Serialization": "Debug"
+    }
+  }
+}
+```
+
+This example will enable the following logging features:
+
+* `Connection` - Logger category for messages related to connection operations.
+* `Method` - Logger category for method execution, excluding `Connect` method.
+* `Query` - Logger category for messages related to written or generated queries, that can be executed within `Query` or `RawQuery`.
+* `Serialization` - Logger category for data serialization and deserialization, e.g. hexa CBOR format exchanged between the client and a SurrealDB instance.
+
+> [!IMPORTANT]
+> `Serialization` logs are only displayed when on `Debug` level to prevent data exchanges exposure. Please be sure to only enable this feature when you can guarantee that no sensitive data will be exposed.
+
+## Sensitive data
+
+To prevent data leakage, the property <code>SensitiveDataLoggingEnabled</code> of <code>SurrealDbLoggingOptions</code> is set to <code>true</code> by default.
+
+When the feature is enabled, any data that is passed to a SurrealDB method is replaced by the placeholder value `?`. Example:
+
+<Image
+    alt="Logging displayed from a console application"
+    src={LoggingConsoleImg}
+/>
+
+If needed, you can override this option using the <code>EnableSensitiveDataLogging</code> when building a new <code>SurrealDbOptions</code> instance.
+
+```csharp
+services.AddSurreal(
+  SurrealDbOptions
+    .Create()
+    .FromConnectionString(configuration.GetConnectionString("SurrealDB")!)
+    .EnableSensitiveDataLogging(false)
+    .Build()
+);
+```
+
+> [!IMPORTANT]
+> Please be sure to only enable this feature when you can guarantee that no sensitive data will be exposed.