Merge pull request #374 from askrinnik/GrafanaLoki

Logging to Grafana Loki

Author: dodyg

README.md

@@ -30,7 +30,7 @@ Greetings from Cairo, Egypt. You can [sponsor](https://github.com/sponsors/dodyg
 | [Health Check](/projects/health-check)                          | 6   |                                                                              |
 | [IHttpClientFactory](/projects/httpclientfactory)               | 4   |                                                                              |
 | [IHostedService](/projects/ihosted-service)                     | 2   |                                                                              |
-| [Logging](/projects/logging)                                    | 3   |                                                                              |
+| [Logging](/projects/logging)                                    | 4   |                                                                              |
 | [Localization and Globalization](/projects/localization)        | 6   |                                                                              |
 | [Middleware](/projects/middleware)                              | 14  |                                                                              |
 | [Mini Apps](/projects/mini)                                     | 2   |                                                                              |

projects/logging/README.md

@@ -1,4 +1,4 @@
-# Logging (3)
+# Logging (4)
 
 * [Basic Logging](/projects/logging/logging-1)
 
@@ -12,4 +12,8 @@
 
   This example shows how to display log to console in structured JSON logs.
 
+* [Logging to Grafana Loki](/projects/logging/logging-Loki)
+
+  This example shows how to log to [Grafana Loki](https://grafana.com/oss/loki/).
+
   dotnet6

projects/logging/logging-Loki/Program.cs

@@ -0,0 +1,25 @@
+using LokiLoggingProvider.Options;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Logging.AddLoki(configure =>
+{
+    configure.Client = PushClient.Grpc;
+    configure.StaticLabels.JobName = "LokiWebApplication";
+});
+
+var app = builder.Build();
+
+app.MapGet("/test", (ILoggerFactory loggerFactory) =>
+{
+    var logger = loggerFactory.CreateLogger("Start");
+    logger.LogTrace("Trace message");
+    logger.LogDebug("Debug message");
+    logger.LogInformation("Information message");
+    logger.LogWarning("Warning message");
+    logger.LogError("Error message");
+    logger.LogCritical("Critical message");
+    return "OK";
+});
+
+app.Run();

projects/logging/logging-Loki/README.md

@@ -0,0 +1,20 @@
+# Log into Grafana Loki 
+
+This example shows how to log to [Grafana Loki](https://grafana.com/oss/loki/). The Docker is used for the software hosting.
+
+ - open a command-line window in the folder and execute:
+ 
+ ```sh
+docker compose up
+ ```
+  - make sure that [Grafana Loki](https://grafana.com/oss/loki/) and [Grafana Dashboard](https://grafana.com/grafana/) containers are succesfully installed
+  - Compile and run the application
+ ```sh
+ dotnet build
+ dotnet run
+  ```
+  - Navigate to /test endpoint. The response should be 'OK'. The console window should contain **info**, **warn**, **fail** and **crit** log messages.
+  - Navigate in a browser to the Grafana Dashboard website: <http://localhost:3000/>
+  - Add a loki data source <http://loki:3100>
+  - Go to the 'Explore data' page and add Label filter:  ``job="LokiWebApplication"``. Press the 'Run query' button
+  - Log messages should be shown

projects/logging/logging-Loki/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3.7'
+
+volumes:
+    grafana: ~
+    loki: ~
+
+services:
+    loki:
+        image: "grafana/loki:latest"
+        hostname: logs
+        command: -config.file=/etc/loki/local-config.yaml
+        volumes:
+            - loki:/loki
+        ports:
+            - "3100:3100" # http and Grafana data source
+            - "9095:9095" # grpc
+    grafana:
+        image: grafana/grafana-oss:latest-ubuntu
+        hostname: grafana
+        ports: 
+            - "3000:3000" #UI
+        volumes:
+            - grafana:/var/lib/grafana
+        environment:
+            - GF_AUTH_ANONYMOUS_ENABLED=true
+            - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+            - GF_AUTH_DISABLE_LOGIN_FORM=true
+        depends_on:
+            - loki

projects/logging/logging-Loki/logging-Loki.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="LokiLoggingProvider" Version="1.0.0" />
+  </ItemGroup>
+
+</Project>