NLog.Targets.Loki.gRPC 0.1.0-preview6

This is a prerelease version of NLog.Targets.Loki.gRPC.
dotnet add package NLog.Targets.Loki.gRPC --version 0.1.0-preview6
NuGet\Install-Package NLog.Targets.Loki.gRPC -Version 0.1.0-preview6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NLog.Targets.Loki.gRPC" Version="0.1.0-preview6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NLog.Targets.Loki.gRPC --version 0.1.0-preview6
#r "nuget: NLog.Targets.Loki.gRPC, 0.1.0-preview6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NLog.Targets.Loki.gRPC as a Cake Addin
#addin nuget:?package=NLog.Targets.Loki.gRPC&version=0.1.0-preview6&prerelease

// Install NLog.Targets.Loki.gRPC as a Cake Tool
#tool nuget:?package=NLog.Targets.Loki.gRPC&version=0.1.0-preview6&prerelease

NLog Loki gRPC Target

This library is not production ready. This is a work in progress!

Build NuGet codecov

This is an NLog target that sends messages to Loki using Loki's with a gRPC client.

Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate.

Installation

The NLog.Loki NuGet package can be found here. You can install it via one of the following commands below:

NuGet command:

Install-Package NLog.Targets.Loki.gRPC

.NET Core CLI command:

dotnet add package NLog.Targets.Loki.gRPC

Usage

Under .NET Core, remember to register NLog.Loki as an extension assembly with NLog. You can now add a Loki target to your configuration file:

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  
  <extensions>
    <add assembly="NLog.Loki.gRPC" />
  </extensions>

  
  <targets>
    <target 
      name="loki" 
      xsi:type="loki.grpc"
      batchSize="200"
      taskDelayMilliseconds="500"
      endpoint="http://localhost:3100"
      orderWrites="true"
      layout="${level}|${message}${onexception:|${exception:format=type,message,method:maxInnerExceptionLevel=5:innerFormat=shortType,message,method}}|source=${logger}">
      
      <label name="app" layout="my-app-name" />
      <label name="server" layout="${hostname:lowercase=true}" />
    </target>
  </targets>

  <rules>
    <logger name="*" minlevel="Info" writeTo="loki" />
  </rules>

</nlog>

endpoint must resolve to a fully-qualified absolute URL of the Loki Server when running in a Single Proccess Mode or of the Loki Distributor when running in Microservices Mode.

orderWrites - Orders the logs by timestamp before sending them to loki when logs are batched in a single HTTP call. This is required if you use Loki v2.3 or below. But it is not required if you use Loki v2.4 or above (see out-of-order writes). You are strongly advised to set this value to false when using Loki v2.4+ since it reduces allocations by about 20% by the serializer (default true).

label elements can be used to enrich messages with additional labels. label/@layout support usual NLog layout renderers.

Async Target

NLog.Loki.gRPC is an async target. You should not wrap it in an AsyncWrapper target. The following configuration options are supported. Make sure to adjust them to the expected throughput and criticality of your application's logs, especially the batch size, retry count and task delay.

taskTimeoutSeconds - How many seconds a Task is allowed to run before it is cancelled (default 150 secs).

retryDelayMilliseconds - How many milliseconds to wait before next retry (default 500ms, and will be doubled on each retry).

retryCount - How many attempts to retry the same Task, before it is aborted (default 0, meaning no retry).

batchSize - Gets or sets the number of log events that should be processed in a batch by the lazy writer thread (default 1).

taskDelayMilliseconds - How many milliseconds to delay the actual write operation to optimize for batching (default 1 ms).

queueLimit - Gets or sets the limit on the number of requests in the lazy writer thread request queue (default 10000).

overflowAction - Gets or sets the action to be taken when the lazy writer thread request queue count exceeds the set limit (default Discard).

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.0-preview6 262 5/30/2022
0.1.0-preview5 104 5/30/2022
0.1.0-preview4 102 5/30/2022
0.1.0-preview3 109 5/30/2022
0.1.0-preview1 108 5/26/2022
0.0.1-preview1 97 5/26/2022