NLog.Contrib.Targets.WebSocketServer.Core 1.0.1

.NET 7.0 
dotnet add package NLog.Contrib.Targets.WebSocketServer.Core --version 1.0.1
NuGet\Install-Package NLog.Contrib.Targets.WebSocketServer.Core -Version 1.0.1
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.Contrib.Targets.WebSocketServer.Core" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add NLog.Contrib.Targets.WebSocketServer.Core --version 1.0.1
#r "nuget: NLog.Contrib.Targets.WebSocketServer.Core, 1.0.1"
#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.Contrib.Targets.WebSocketServer.Core as a Cake Addin
#addin nuget:?package=NLog.Contrib.Targets.WebSocketServer.Core&version=1.0.1

// Install NLog.Contrib.Targets.WebSocketServer.Core as a Cake Tool
#tool nuget:?package=NLog.Contrib.Targets.WebSocketServer.Core&version=1.0.1

Broadcast your servers´ logs to websocket connections in real-time with minimal effort.

Features:

  • Fully integrated with NLog: it does not require changes in your application code beyond the configuration.
  • Optional integrated log viewer SPA: To view log events in real-time.
  • Scalable: NLog and WebSocketServer components are decoupled by a producer-consumer pattern, so NLog will append the log entries to WebSocketTarget in O(1) time always, and another thread/threads are responsible of distributing that log entry to the clients. Still, if the component has a big number of connected clients, it may interfere with your application performance. See the MaxConnectedClients configuration setting. The queue is configured to have a bounding capacity of 1000 items, if the queue gets full, items will start to be discarded.

As said, it includes a SPA-Webclient to view the logs directly, featuring:

  • Simplified live log monitoring with a simple web browser app.
  • Filter by log levels.
  • Deactivate or replace it with your own.
  • Not a replacement of a proper monitoring tool, but handy for watching over logs with little logistic effort.

NLog.Contrib.Targets.WebSocketServer.Core is a NLog target that instead of writing on a file, or showing the log on the console, broadcasts the log events to the connected websocket connections.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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. 
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
1.0.1 124 10/3/2023
1.0.0 94 9/28/2023