nlog/nlog.targets.redis

NLog Target for writing to Redis

NLog.Targets.Redis

This project provides a custom target for the NLog framework to allow a user to send log messages to a Redis server. The target supports sending log messages to a Redis list or to a pub/sub channel.

Installation

NLog.Targets.Redis is available as a NuGet Package. Type the following command into the Nuget Package Manager Console window to install it:

Install-Package NLog.Targets.Redis

Usage

The <target /> configuration section contains five required fields and one optional field.

• host (required): The host name or IP Address of the Redis server.
• port (required): The port the Redis server is listening on, defaults to 6379.
• key (required): The key that should be used to identify the Redis list or the pub/sub channel to which the log messages are being delivered.
• dataType (optional): The Redis data type that should be used to store the log messages. This can be either list or channel, defaults to list.
• channelPattern (optional): The Redis Channel Pattern to use when dataType = channel. This can be either literal or pattern, defaults to auto.
• layout (required): The layout that defines the format of the message to be sent to the Redis target.
• db (optional): The Redis database id to store the log messages in, if the Redis database type list is chosen.
• clientName (optional): The Client name to use for all Redis connections.
• configurationOptions (optional): Additional configuration options (comma delimited). See Configuration Options

Config File

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" throwExceptions="true">
  <extensions>
    <add assembly="NLog.Targets.Redis" />
  </extensions>
  <targets>
    <target xsi:type="Redis" name="redis" host="127.0.0.1" port="6379" db="0" 
            key="logKey" dataType="list" 
            layout="${longdate} ${level:uppercase=true} ${message} ${exception:format=tostring}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Info" writeTo="redis" />
  </rules>
</nlog>

Notes

This is a fork of https://github.com/richclement/NLog.Redis

Admin

How to release

1. Create a new release with a new tag
2. Wait for the build

nlog.targets.redis's Issues

Convert RedisTarget Parameters to use Layouts

With the move to .Net Core we can pull variables in from the appsettings.json files. So, for the RedisTarget, should all of the parameters also be using Layouts like the key?

Update nlog-project.org's targets page with new NLog.Redis link

The page https://nlog-project.org/config/?tab=targets still links to the old repo.

Add unit tests

The current unit tests are integration tests so they need Redis running.

That isn't really needed.

1. Make RedisTarget mockable
2. Create mock that writes into memory
3. Inject mocks in unit tests
4. Copy tests, keep needed, and change to unit test

Strong name code

Like all NLog libs, with the same key

fix assembly version to 1.0.0.0?

Fix line endings

e.g. see

from https://github.com/NLog/NLog.Redis/pull/16/files

Change DataType property to enum

Add SourceLink and deterministic build

rename repo to NLog.Targets.Redis?

Maybe we should rename this repo to NLog.Targets.Redis

That's more transparant I think.

(note: github will create a redirect for NLog.redis then)

Rename csproj to NLog.Targets.Redis

Change namespace to NLog.Redis?

Currently NLog.Targets

Consider Embedding the SE.Redis Library

We should consider embedding the Redis library into the assembly - functionally this will reduce the API surface area. This would be similar to how Hangfire inlines the same package into Hangfire.Pro.Redis (sorry, only example I could think of).

Readme Config File Redis Port Wrong

change 3679 to 6379

Merge support for multiple servers?

Maybe we should merge this one, before release

richclement/NLog.Redis#4

Update README with Name Change Explanation

Titles says it all.

Add Nuget Badge to Readme

The specified NuGet API key is invalid or has expired - Ver. 3.1.0

Believe the nuget-API-key needs to be updated:

• https://ci.appveyor.com/project/nlog/nlog-redis/builds/48075990

Maybe consider changing so NLog.Targets.Redis uses the same API-key as the other NLog-projects (But it also seems the Nuget-API-key for the other NLog-projects has also expired)

Nuget/Project Name

We need a name to publish Nuget packages under, suggestions:

• NLog.Redis (https://www.nuget.org/packages/NLog.Redis/) - owned by richclement, failed to get in contact. Preferred.
• NLog.Targets.Redis (https://www.nuget.org/packages/NLog.Targets.Redis/) - owned by @diadistis, might require backwards compatibility.
• NLog.Target.Redis - breaks namespace conventions, might be too similar to the above suggestion.
• NLog.Contrib.Redis - wierd naming, unlike other NLog packages.

We might be able to petition Microsoft/Nuget to get contributor access to NLog.Redis.

How to configure the expiration time of this data included in redis in NLog.config file of asp.net?

I tried to add the expireSeconds field in the configuration file.

But I checked redis and found that ttl is still -1 instead of 60.

Remove .nuget references in .sln

Change Password, Db and Host to Layout

Release 3.0

Fix snupkg upload

• Manual upload
• fix script

Update Nuget API Key

Regarding deployments we need a valid Nuget API key.

Update packagename, info, urls, readme

+move to version 1.0

Fix build of PRs

Something wrong with the webhook