LogReceiverService target

Sends log messages to a NLog Receiver Service (using WCF or Web Services). 

Configuration Syntax

Parameters

• General Options
• 
  name - Name of the target.
• Connection Options
• 
  endpointConfigurationName - Name of the endpoint configuration in WCF configuration file.

  This parameter is not supported in:

  • NLog v2.0 for .NET Compact Framework 2.0
  • NLog v2.0 for .NET Compact Framework 3.5
  • NLog v2.0 for .NET Framework 2.0
• 
  endpointAddress - Endpoint address. Required.
• Payload Options
• 
  useBinaryEncoding - Indicates whether to use binary message encoding.Boolean

  This parameter is not supported in:

  • NLog v2.0 for .NET Compact Framework 2.0
  • NLog v2.0 for .NET Compact Framework 3.5
  • NLog v2.0 for .NET Framework 2.0
  • NLog v2.0 for Silverlight 2.0
• 
  parameters - The list of parameters.Collection
  Each collection item is represented by <parameter /> element with the following attributes:
  • 
    layout - Layout that should be use to calcuate the value for the parameter.Layout Required.
  • 
    name - Name of the parameter.
  • 
    type - Type of the parameter.System.Type
• 
  clientId - Client ID.Layout
• 
  includeEventProperties - Indicates whether to include per-event properties in the payload sent to the server.Boolean

Example - Passing Parameters

Parameters are passed to the WCF LogReceiverService target using one or more configuration lines such as:

<parameter name="MyParameter" layout="My Value!" />
<parameter name="nlogdir" layout="${nlogdir}" />

These parameters are passed over the network to the service and can be accessed by emitting events from your receiver application.

Example - Application for receiving events

namespace MyLogReceiverApp
{
   using System;
   using NLog;
   using NLog.LogReceiverService;

   /// <summary>
   /// Log service server object that logs messages.
   /// </summary>
   public class LogReceiverServer : ILogReceiverServer
   {
       public void ProcessLogMessages(NLogEvents nevents)
       {
           var events = nevents.ToEventInfo("Client.");
           Console.WriteLine("in: {0} {1}", nevents.Events.Length, events.Count);

           foreach (var ev in events)
           {
               var logger = LogManager.GetLogger(ev.LoggerName);
               logger.Log(ev);
           }
       }
   }
}

The line:

logger.Log(ev);

emits each event to the appropriate targets defined in the server side NLog.config file.

Example - Accessing Custom Values

On the server side NLog.config file, you may use the ${event-context} layout renderer to access any parameters passed from the client side config. A line such as:

<target name="c" xsi:type="ColoredConsole" layout="testing ${event-context:item=MyParameter}" />

would print to the console:

testing My Value!