Removed dependency from Serilog.Sinks.Http + implemented LokiGzipHttpClient + more tests & bugfixes (#33)

* Timer + Batch (+tests) & LokiClient draft

* ExponentialBackoffScheduler + tests

* More draft

* Implemented sink + batch formatter + fixes

* Removed dependency to Serilog.Sinks.Http

* Bugfix

* Utils tests + regroup of existing ones

* Deleted redundant fixture

* Deleted redundant folder

* Fixed doc

* Implemented client with gzip compression

* Updated README.MD

* Added license headers

Author: mishamyte

README.md

@@ -1,147 +1,151 @@
-# Serilog.Sinks.Grafana.Loki
-
-[![Build status](https://github.com/mishamyte/serilog-sinks-grafana-loki/workflows/CI/badge.svg)](https://github.com/mishamyte/serilog-sinks-grafana-loki/actions?query=workflow%3ACI)
-[![NuGet Version](https://img.shields.io/nuget/v/Serilog.Sinks.Grafana.Loki)](https://www.nuget.org/packages/Serilog.Sinks.Grafana.Loki)
-[![Documentation](https://img.shields.io/badge/docs-wiki-blueviolet.svg)](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki)
-
-## Table of contents
-- [What is this sink and Loki?](#what-is-this)
-- [Features](#features)
-- [Comparison with other Loki sinks](#comparison)
-- [Breaking changes](#breaking-changes)
-- [Quickstart](#quickstart)
-- [Custom HTTP Client](#custom-http-client)
-- [Sending json content to Loki](#sending-json-content-to-loki)
-- [Inspiration and Credits](#inspiration-and-credits)
-
-## What is this sink and Loki?
-
-The Serilog Grafana Loki sink project is a sink (basically a writer) for the Serilog logging framework. Structured log events are written to sinks and each sink is responsible for writing it to its own backend, database, store etc. This sink delivers the data to Grafana Loki, a horizontally-scalable, highly-available, multi-tenant log aggregation system. It allows you to use Grafana for visualizing your logs.
-
-You can find more information about what Loki is over on [Grafana's website here](https://grafana.com/loki).
-
-## Features:
-- Formats and batches log entries to Loki via HTTP (using actual API)
-- Global and contextual labels support
-- Labels filtration modes
-- Integration with Serilog.Settings.Configuration
-- Customizable HTTP client
-- Using fast System.Text.Json library for serialization
-
-Coming soon:
-- Improve durable mode (keep labels & etc)
-
-## Comparison
-Features comparison table could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Comparison-with-another-Loki-sinks)
-
-## Breaking changes
-The list of breaking changes could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Breaking-changes)
-
-## Quickstart
-The `Serilog.Sinks.Grafana.Loki` NuGet [package could be found here](https://www.nuget.org/packages/Serilog.Sinks.Grafana.Loki). Alternatively you can install it via one of the following commands below:
-
-NuGet command:
-```bash
-Install-Package Serilog.Sinks.Grafana.Loki
-```
-.NET Core CLI:
-```bash
-dotnet add package Serilog.Sinks.Grafana.Loki
-```
-
-In the following example, the sink will send log events to Loki available on `http://localhost:3100`
-```csharp
-ILogger logger = new LoggerConfiguration()
-    .WriteTo.GrafanaLoki(
-        "http://localhost:3100")
-    .CreateLogger();
-
-logger.Information("The god of the day is {@God}", odin)
-```
-
-Used in conjunction with [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) the same sink can be configured in the following way:
-
-```json
-{
-  "Serilog": {
-    "Using": [
-      "Serilog.Sinks.Grafana.Loki"
-    ],
-    "MinimumLevel": {
-      "Default": "Debug"
-    },
-    "WriteTo": [
-      {
-        "Name": "GrafanaLoki",
-        "Args": {
-          "uri": "http://localhost:3100",
-          "labels": [
-            {
-              "key": "app",
-              "value": "web_app"
-            }
-          ],
-          "outputTemplate": "{Timestamp:dd-MM-yyyy HH:mm:ss} [{Level:u3}] [{ThreadId}] {Message}{NewLine}{Exception}"
-        }
-      }
-    ]
-  }
-}
-```
-
-Description of parameters and configuration details could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Application-settings).
-
-### Custom HTTP Client
-Serilog.Loki.Grafana.Loki is built on top of the popular [Serilog.Sinks.Http](https://github.com/FantasticFiasco/serilog-sinks-http) library.
-In order to use a custom HttpClient you can extend the default HttpClient (`Serilog.Sinks.Grafana.Loki.DefaultLokiHttpClient`), or create one implementing `Serilog.Sinks.Grafana.Loki.ILokiHttpClient` (which extends `Serilog.Sinks.Http.IHttpClient`).
-
-```csharp
-// CustomHttpClient.cs
-
-public class CustomHttpClient : DefaultLokiHttpClient
-{
-    public override Task<HttpResponseMessage> PostAsync(string requestUri, HttpContent content)
-    {
-        return base.PostAsync(requestUri, content);
-    }
-}
-```
-```csharp
-// Usage
-
-Log.Logger = new LoggerConfiguration()
-    .WriteTo.GrafanaLoki(
-         "http://localhost:3100",
-         httpClient: new CustomHttpClient()
-    )
-    .CreateLogger();
-```
-
-### Sending json content to Loki
-Serilog.Sinks.Grafana.Loki can be configured to send json content to Loki, this enables easier filtering in Loki v2, more information about how to filter can be found [here](https://grafana.com/blog/2020/10/28/loki-2.0-released-transform-logs-as-youre-querying-them-and-set-up-alerts-within-loki/)  
-Example configuration:
-```json
-{
-  "Serilog": {
-    "Using": [
-      "Serilog.Sinks.Grafana.Loki"
-    ],
-    "MinimumLevel": {
-      "Default": "Debug"
-    },
-    "WriteTo": [
-      {
-        "Name": "GrafanaLoki",
-        "Args": {
-          "uri": "http://localhost:3100",
-          "textFormatter": "Serilog.Sinks.Grafana.Loki.LokiJsonTextFormatter, Serilog.Sinks.Grafana.Loki"
-        }
-      }
-    ]
-  }
-}
-```
-
-### Inspiration and Credits
-- [Serilog.Sinks.Loki](https://github.com/JosephWoodward/Serilog-Sinks-Loki)
-- [Serilog.Sinks.Http](https://github.com/FantasticFiasco/serilog-sinks-http)
+# Serilog.Sinks.Grafana.Loki
+
+[![Build status](https://github.com/mishamyte/serilog-sinks-grafana-loki/workflows/CI/badge.svg)](https://github.com/mishamyte/serilog-sinks-grafana-loki/actions?query=workflow%3ACI)
+[![NuGet Version](https://img.shields.io/nuget/v/Serilog.Sinks.Grafana.Loki)](https://www.nuget.org/packages/Serilog.Sinks.Grafana.Loki)
+[![Documentation](https://img.shields.io/badge/docs-wiki-blueviolet.svg)](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki)
+
+## Table of contents
+- [What is this sink and Loki?](#what-is-this)
+- [Features](#features)
+- [Comparison with other Loki sinks](#comparison)
+- [Breaking changes](#breaking-changes)
+- [Quickstart](#quickstart)
+- [Custom HTTP Client](#custom-http-client)
+- [Sending json content to Loki](#sending-json-content-to-loki)
+- [Inspiration and Credits](#inspiration-and-credits)
+
+## What is this sink and Loki?
+
+The Serilog Grafana Loki sink project is a sink (basically a writer) for the Serilog logging framework. Structured log events are written to sinks and each sink is responsible for writing it to its own backend, database, store etc. This sink delivers the data to Grafana Loki, a horizontally-scalable, highly-available, multi-tenant log aggregation system. It allows you to use Grafana for visualizing your logs.
+
+You can find more information about what Loki is over on [Grafana's website here](https://grafana.com/loki).
+
+## Features:
+- Formats and batches log entries to Loki via HTTP (using actual API)
+- Global and contextual labels support
+- Labels filtration modes
+- Integration with Serilog.Settings.Configuration
+- Customizable HTTP clients
+- HTTP client with gzip compression
+- Using fast System.Text.Json library for serialization
+- Possibility of sending [json logs](https://grafana.com/blog/2020/10/28/loki-2.0-released-transform-logs-as-youre-querying-them-and-set-up-alerts-within-loki/) to Loki
+- No dependencies on another sinks
+
+## Comparison
+Features comparison table could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Comparison-with-another-Loki-sinks)
+
+## Breaking changes
+The list of breaking changes could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Breaking-changes)
+
+## Quickstart
+The `Serilog.Sinks.Grafana.Loki` NuGet [package could be found here](https://www.nuget.org/packages/Serilog.Sinks.Grafana.Loki). Alternatively you can install it via one of the following commands below:
+
+NuGet command:
+```bash
+Install-Package Serilog.Sinks.Grafana.Loki
+```
+.NET Core CLI:
+```bash
+dotnet add package Serilog.Sinks.Grafana.Loki
+```
+
+In the following example, the sink will send log events to Loki available on `http://localhost:3100`
+```csharp
+ILogger logger = new LoggerConfiguration()
+    .WriteTo.GrafanaLoki(
+        "http://localhost:3100")
+    .CreateLogger();
+
+logger.Information("The god of the day is {@God}", odin)
+```
+
+Used in conjunction with [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) the same sink can be configured in the following way:
+
+```json
+{
+  "Serilog": {
+    "Using": [
+      "Serilog.Sinks.Grafana.Loki"
+    ],
+    "MinimumLevel": {
+      "Default": "Debug"
+    },
+    "WriteTo": [
+      {
+        "Name": "GrafanaLoki",
+        "Args": {
+          "uri": "http://localhost:3100",
+          "labels": [
+            {
+              "key": "app",
+              "value": "web_app"
+            }
+          ],
+          "outputTemplate": "{Timestamp:dd-MM-yyyy HH:mm:ss} [{Level:u3}] [{ThreadId}] {Message}{NewLine}{Exception}"
+        }
+      }
+    ]
+  }
+}
+```
+
+Description of parameters and configuration details could be found [here](https://github.com/mishamyte/serilog-sinks-grafana-loki/wiki/Application-settings).
+
+### Custom HTTP Client
+Serilog.Loki.Grafana.Loki exposes `ILokiHttpClient` interface with the main operations, required for sending logs.
+In order to use a custom HttpClient you can extend of default implementations:
+- `Serilog.Sinks.Grafana.Loki.HttpClients.BaseLokiHttpClient` (implements creation of internal `HttpClient` and setting credentials)
+- `Serilog.Sinks.Grafana.Loki.HttpClients.LokiHttpClient` (default client which sends logs via HTTP)
+- `Serilog.Sinks.Grafana.Loki.HttpClients.LokiGzipHttpClient` (default client which sends logs via HTTP with gzip compression)
+  
+or create one implementing `Serilog.Sinks.Grafana.Loki.ILokiHttpClient`.
+
+```csharp
+// CustomHttpClient.cs
+
+public class CustomHttpClient : BaseLokiHttpClient
+{
+    public override Task<HttpResponseMessage> PostAsync(string requestUri, Stream contentStream);
+    {
+        return base.PostAsync(requestUri, content);
+    }
+}
+```
+```csharp
+// Usage
+
+Log.Logger = new LoggerConfiguration()
+    .WriteTo.GrafanaLoki(
+         "http://localhost:3100",
+         httpClient: new CustomHttpClient()
+    )
+    .CreateLogger();
+```
+
+### Sending json content to Loki
+Serilog.Sinks.Grafana.Loki can be configured to send json content to Loki, this enables easier filtering in Loki v2, more information about how to filter can be found [here](https://grafana.com/blog/2020/10/28/loki-2.0-released-transform-logs-as-youre-querying-them-and-set-up-alerts-within-loki/)  
+Example configuration:
+```json
+{
+  "Serilog": {
+    "Using": [
+      "Serilog.Sinks.Grafana.Loki"
+    ],
+    "MinimumLevel": {
+      "Default": "Debug"
+    },
+    "WriteTo": [
+      {
+        "Name": "GrafanaLoki",
+        "Args": {
+          "uri": "http://localhost:3100",
+          "textFormatter": "Serilog.Sinks.Grafana.Loki.LokiJsonTextFormatter, Serilog.Sinks.Grafana.Loki"
+        }
+      }
+    ]
+  }
+}
+```
+
+### Inspiration and Credits
+- [Serilog.Sinks.Loki](https://github.com/JosephWoodward/Serilog-Sinks-Loki)

sample/Serilog.Sinks.Grafana.Loki.SampleWebApp/Startup.cs

@@ -1,48 +1,41 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Hosting;
-using Microsoft.AspNetCore.HttpsPolicy;
-using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Configuration;
-using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Hosting;
-using Microsoft.Extensions.Logging;
-
-namespace Serilog.Sinks.Grafana.Loki.SampleWebApp
-{
-    public class Startup
-    {
-        public Startup(IConfiguration configuration)
-        {
-            Configuration = configuration;
-        }
-
-        public IConfiguration Configuration { get; }
-
-        // This method gets called by the runtime. Use this method to add services to the container.
-        public void ConfigureServices(IServiceCollection services)
-        {
-            services.AddControllers();
-        }
-
-        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
-        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
-        {
-            if (env.IsDevelopment())
-            {
-                app.UseDeveloperExceptionPage();
-            }
-
-            app.UseHttpsRedirection();
-
-            app.UseRouting();
-
-            app.UseAuthorization();
-
-            app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
-        }
-    }
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+
+namespace Serilog.Sinks.Grafana.Loki.SampleWebApp
+{
+    public class Startup
+    {
+        public Startup(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public IConfiguration Configuration { get; }
+
+        // This method gets called by the runtime. Use this method to add services to the container.
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddControllers();
+        }
+
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            if (env.IsDevelopment())
+            {
+                app.UseDeveloperExceptionPage();
+            }
+
+            app.UseHttpsRedirection();
+
+            app.UseRouting();
+
+            app.UseAuthorization();
+
+            app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
+        }
+    }
 }