Serilog.Sinks.Railtown 2.0.0

dotnet add package Serilog.Sinks.Railtown --version 2.0.0
                    
NuGet\Install-Package Serilog.Sinks.Railtown -Version 2.0.0
                    
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="Serilog.Sinks.Railtown" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Serilog.Sinks.Railtown" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Serilog.Sinks.Railtown" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Serilog.Sinks.Railtown --version 2.0.0
                    
#r "nuget: Serilog.Sinks.Railtown, 2.0.0"
                    
#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.
#:package Serilog.Sinks.Railtown@2.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Serilog.Sinks.Railtown&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Serilog.Sinks.Railtown&version=2.0.0
                    
Install as a Cake Tool

Serilog.Sinks.Railtown

A Serilog sink that forwards your application's log events to Railtown.ai.

Add the sink to your logger configuration and every event Serilog already captures is also delivered to your Railtown project, where it is grouped, enriched and surfaced alongside the rest of your telemetry.

Getting started

Sign in to the Railtown dashboard at cndr.railtown.ai to create a project and grab the Railtown key for your environment, then follow the steps below to start sending logs.

Installation

dotnet add package Serilog.Sinks.Railtown

The package targets .NET Standard 2.0, so it works with both .NET Framework and modern .NET applications.

Configuration

Add the sink with the WriteTo.Railtown(...) extension method when building your logger:

using Serilog;

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Railtown(railtownKey: "[Copy from your Railtown Project settings page]")
    .CreateLogger();

Getting your Railtown key

The Railtown key is found on your Railtown Project settings page. Each environment has its own key — copy the one for the environment you are configuring.

Supplying the key via a config file

If you do not pass railtownKey to WriteTo.Railtown(), the sink looks for a Railtown.config file next to the running assembly and reads the key from it. The file's entire contents are treated as the key:

[Copy from your Railtown Project settings page]

Troubleshooting

The sink fails quietly if it cannot be configured. To see why, enable Serilog's self log before building your logger:

Serilog.Debugging.SelfLog.Enable(Console.Error);

How it works

RailtownSink writes events asynchronously so logging does not block your application. The build version and machine name are captured automatically and reported with each event.

Railtown also publishes log-forwarding integrations for other frameworks:

  • NLog.Railtown.Ingest.Logs.Target
  • log4net.Railtown.Ingest.Logs.Appender
  • ApplicationInsights.Railtown
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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.

Compatible with railtown.ai gateway v2