Spiffy.Monitoring 6.1.0

Install-Package Spiffy.Monitoring -Version 6.1.0
dotnet add package Spiffy.Monitoring --version 6.1.0
<PackageReference Include="Spiffy.Monitoring" Version="6.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Spiffy.Monitoring --version 6.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Spiffy.Monitoring, 6.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Spiffy.Monitoring as a Cake Addin
#addin nuget:?package=Spiffy.Monitoring&version=6.1.0

// Install Spiffy.Monitoring as a Cake Tool
#tool nuget:?package=Spiffy.Monitoring&version=6.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Overview

A structured logging framework for .NET that supports log aggregation, e.g. Splunk.

Handled over 650,000,000,000 production requests (and counting!)

Status

Build status

Package Latest Release
Spiffy.Monitoring NuGet version
Spiffy.Monitoring.Aws NuGet version
Spiffy.Monitoring.NLog NuGet version
Spiffy.Monitoring.Prometheus NuGet version
Spiffy.Monitoring.Splunk NuGet version

Setup

PM> Install-Package Spiffy.Monitoring

Built-In Logging Providers

Spiffy.Monitoring includes "built-in" logging mechanisms (Trace and Console).

There is no default logging behavior, you must initialize provider(s) by calling Spiffy.Monitoring.Configuration.Initialize.

Until initialized, any published EventContext will not be observable, so it is recommended that initialization be as early as possible when your application is starting (i.e. in the entry point).

Example

  Configuration.Initialize(spiffy => { spiffy.Providers.Console(); });

Extended Providers

For extended functionality, you'll need to install a "provider package".

NOTE: the provider package need only be installed for your application's entry point assembly, it need not be installed in library packages.

NLog Provider

PM> Install-Package Spiffy.Monitoring.NLog

Example

    static void Main() {
        // this should be the first line of your application
        Spiffy.Monitoring.Configuration.Initialize(spiffy => {
            spiffy.Providers
                .NLog(nlog => nlog.Targets(t => t.File()));
        });
    }

Multiple Providers

Multiple providers can be provied, for example, this application uses both Console (built-in), as well as File (NLog)

Example

    Spiffy.Monitoring.Configuration.Initialize(spiffy => {
        spiffy.Providers
            .Console()
            .NLog(nlog => nlog.Targets(t => t.File()));
    });

Log

Example Program

        // key-value-pairs set here appear in every event message
        GlobalEventContext.Instance
            .Set("Application", "MyApplication");

        using (var context = new EventContext()) {
            context["Key"] = "Value";

            using (context.Time("LongRunning")) {
                DoSomethingLongRunning();
            }

            try {
                DoSomethingDangerous();
            }
            catch (Exception ex) {
                context.IncludeException(ex);
            }
        }

Normal Entry

[2014-06-13 00:05:17.634Z] Application=MyApplication Level=Info Component=Program Operation=Main TimeElapsed=1004.2 Key=Value TimeElapsed_LongRunning=1000.2

Exception Entry

[2014-06-13 00:12:52.038Z] Application=MyApplication Level=Error Component=Program Operation=Main TimeElapsed=1027.0 Key=Value ErrorReason="An exception has ocurred" Exception_Type=ApplicationException Exception_Message="you were unlucky!" Exception_StackTrace=" at TestConsoleApp.Program.DoSomethingDangerous() in c:\src\git\github\chris-peterson\Spiffy\src\Tests\TestConsoleApp\Program.cs:line 47 at TestConsoleApp.Program.Main() in c:\src\git\github\chris-peterson\Spiffy\src\Tests\TestConsoleApp\Program.cs:line 29" InnermostException_Type=NullReferenceException InnermostException_Message="Object reference not set to an instance of an object." InnermostException_StackTrace={null} Exception="See Exception_* and InnermostException_* for more details" TimeElapsed_LongRunning=1000.0

Hosting Frameworks

Spiffy.Monitoring is designed to be easy to use in any context.

The most basic usage is to instrument a specific method. This can be achieved by "newing up" an EventContext. This usage mode results in Component being set to the containing code's class name, and Operation is set to the containing code's method name

There are times when you may want to instrument something that's not a specific method. One such example is an API -- in this context, you might want to have 1 log event per request. Consider setting Component to be the controller name, and Operation the action name. To acheive this, add middleware that calls EventContext.Initialize with the desired labels.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on Spiffy.Monitoring:

Package Downloads
ConsulRx

A library for consuming consul values in a continuous stream using the Reactive Extensions

Spiffy.Monitoring.NLog

The NLog adapter for Spiffy.Monitoring

Spiffy.Monitoring.Prometheus

The Prometheus provider for Spiffy.Monitoring

Assurance

A library to boost confidence when making code changes

Spiffy.Monitoring.Splunk

The Splunk provider for Spiffy.Monitoring

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.1.0 726 11/2/2021
6.0.8 661 8/9/2021
6.0.7 302 6/15/2021
6.0.6 374 11/12/2020
6.0.5 249 11/10/2020
6.0.3 336 10/30/2020
5.2.0 593 10/18/2019
5.1.2 5,161 11/12/2018
5.1.1 2,121 10/19/2018
5.1.0 10,426 1/15/2018
5.0.0 1,085 10/25/2017
4.0.5 7,927 7/5/2017
4.0.4 861 6/25/2017
4.0.3 928 6/20/2017
4.0.2 1,432 5/23/2017
4.0.1 1,592 4/16/2017
3.1.0 1,682 1/26/2017
3.0.0 3,497 7/27/2016
2.0.1 1,100 6/17/2015
2.0.0 1,399 4/30/2015
1.2.0 1,148 4/6/2015
1.1.0 1,128 3/17/2015
1.0.0 1,302 6/12/2014

Include Ben.Demystifier for tidier exception logging
Add advanced Set overload to control field conflict behavior
Add TrySet to reduce try/catch boilerplate
Rewrite using concurrent collections