LaCorridor.Logging.AzureEventHubs 0.1.5

.NET Core ILogger Provider for Azure EventHubs

Install-Package LaCorridor.Logging.AzureEventHubs -Version 0.1.5
dotnet add package LaCorridor.Logging.AzureEventHubs --version 0.1.5
<PackageReference Include="LaCorridor.Logging.AzureEventHubs" Version="0.1.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LaCorridor.Logging.AzureEventHubs --version 0.1.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Logging.EventHubs

Logging.EventHubs implements logger providers for .NET Core 2.0 applications. It intends to provide a simple way to write .NET Core application logs into EventHubs.

Getting Started

Install the package

  • Install the NuGet Package by .NET CLI:
dotnet add package LaCorridor.Logging.AzureEventHubs

Or

  • Install the NuGet Package by Package Manager:
Install-Package LaCorridor.Logging.AzureEventHubs

Inject the logger

  • For .NET Core 2.0 Websites, Update BuildWebHost method in Program.cs, appending calling to ConfgureLogging():
using LaCorridor.Logging.AzureEventHubs;

namespace WebExample
{
    public class Program
    {
        // ... Main methods ...
        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .ConfigureLogging(builder =>
                {
                    builder.AddEventHub(
                        "EventHub connection string",
                        LogLevel.Warning);
                })
                .UseStartup<Startup>()
                .Build();
    }
}
  • For .NET Core 1.x Websites, Update Configure method in 'Startup.cs':
using LaCorridor.Logging.AzureEventHubs;
// ...
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    loggerFactory.AddConsole(Configuration.GetSection("Logging"));
    loggerFactory.AddDebug();
    loggerFactory.AddEventHub(
        "EvetHub connection string", 
        LogLevel.Debug
    );
    // ...
}
  • For .NET Core Console Application, there are various of ways to do the injection. Here's an example:
class Program
{
    static void Main(string[] args)
    {
        ServiceCollection services = new ServiceCollection();
        services.AddTransient<Runner>();
        services.AddSingleton<ILoggerFactory, LoggerFactory>();
        services.AddSingleton(typeof(ILogger<>), typeof(Logger<>));
        services.AddLogging(builder => builder.SetMinimumLevel(LogLevel.Debug)
            .AddEventHub("EventHubs connection string", LogLevel.Debug));

        ServiceProvider serviceProvider = services.BuildServiceProvider();

        Runner runner = serviceProvider.GetService<Runner>();
        runner.Run();
        
        Console.WriteLine("Press any key to continue . . .");
        Console.ReadKey(true);
    }
}

Runner is a class that consumes ILogger<Runner>:

public class Runner
{
    ILogger _logger;
    public Runner(ILogger<Runner> logger)
    {
        _logger = logger;
    }

    public void Run()
    {
        _logger.LogDebug("A Debug Message");
    }
}

Use configuration file

Providing connection string through configuration file is supported. Take .NET Core 2.0 ASP.NET Website as an example, Program.cs:

public static IWebHost BuildWebHost(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .ConfigureLogging((hostContext, builder) =>
        {
            builder.AddEventHub(hostContext.Configuration);
        })
        .UseStartup<Startup>()
        .Build();

Example of appsettings.json:

{
  "Logging": {
    "IncludeScopes": true,
    "LogLevel": {
      "Default": "Debug"
    },
    "EventHubs": {
      "ConnectionString": "EventHubs connection string",
      "LogLevel": "Error"
    }
  }
}

Details for settings:

| Name | Type | Required | Value | Description |
| -----|------|:--------:|-------|-------------|
|ConnectionString| String | yes | EventHubs Connection String |EventHubs connection you can get from the Azure portal or the EventHub Viewer. |
|LogLevel| Enum | no | One of the following: Trace | Debug | Information | Warning | Error | Critical | None | Minimal logging level. In those values, Trace provides most chatty logs while None provides no logs. |

Consumes the logger

  • Get the ILogger service, for example, in HomeController:
public class HomeController : Controller
{
    private readonly ILogger _logger;
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    // ...
}
  • Use the logger:
public class HomeController : Controller
{
    // ...
    public IActionResult Index()
    {
        _logger.LogWarning("Entering Index.");
        return View();
    }
    // ...
}

Result Example:

Example Result Image

Logging.EventHubs

Logging.EventHubs implements logger providers for .NET Core 2.0 applications. It intends to provide a simple way to write .NET Core application logs into EventHubs.

Getting Started

Install the package

  • Install the NuGet Package by .NET CLI:
dotnet add package LaCorridor.Logging.AzureEventHubs

Or

  • Install the NuGet Package by Package Manager:
Install-Package LaCorridor.Logging.AzureEventHubs

Inject the logger

  • For .NET Core 2.0 Websites, Update BuildWebHost method in Program.cs, appending calling to ConfgureLogging():
using LaCorridor.Logging.AzureEventHubs;

namespace WebExample
{
    public class Program
    {
        // ... Main methods ...
        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .ConfigureLogging(builder =>
                {
                    builder.AddEventHub(
                        "EventHub connection string",
                        LogLevel.Warning);
                })
                .UseStartup<Startup>()
                .Build();
    }
}
  • For .NET Core 1.x Websites, Update Configure method in 'Startup.cs':
using LaCorridor.Logging.AzureEventHubs;
// ...
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    loggerFactory.AddConsole(Configuration.GetSection("Logging"));
    loggerFactory.AddDebug();
    loggerFactory.AddEventHub(
        "EvetHub connection string", 
        LogLevel.Debug
    );
    // ...
}
  • For .NET Core Console Application, there are various of ways to do the injection. Here's an example:
class Program
{
    static void Main(string[] args)
    {
        ServiceCollection services = new ServiceCollection();
        services.AddTransient<Runner>();
        services.AddSingleton<ILoggerFactory, LoggerFactory>();
        services.AddSingleton(typeof(ILogger<>), typeof(Logger<>));
        services.AddLogging(builder => builder.SetMinimumLevel(LogLevel.Debug)
            .AddEventHub("EventHubs connection string", LogLevel.Debug));

        ServiceProvider serviceProvider = services.BuildServiceProvider();

        Runner runner = serviceProvider.GetService<Runner>();
        runner.Run();
        
        Console.WriteLine("Press any key to continue . . .");
        Console.ReadKey(true);
    }
}

Runner is a class that consumes ILogger<Runner>:

public class Runner
{
    ILogger _logger;
    public Runner(ILogger<Runner> logger)
    {
        _logger = logger;
    }

    public void Run()
    {
        _logger.LogDebug("A Debug Message");
    }
}

Use configuration file

Providing connection string through configuration file is supported. Take .NET Core 2.0 ASP.NET Website as an example, Program.cs:

public static IWebHost BuildWebHost(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .ConfigureLogging((hostContext, builder) =>
        {
            builder.AddEventHub(hostContext.Configuration);
        })
        .UseStartup<Startup>()
        .Build();

Example of appsettings.json:

{
  "Logging": {
    "IncludeScopes": true,
    "LogLevel": {
      "Default": "Debug"
    },
    "EventHubs": {
      "ConnectionString": "EventHubs connection string",
      "LogLevel": "Error"
    }
  }
}

Details for settings:

| Name | Type | Required | Value | Description |
| -----|------|:--------:|-------|-------------|
|ConnectionString| String | yes | EventHubs Connection String |EventHubs connection you can get from the Azure portal or the EventHub Viewer. |
|LogLevel| Enum | no | One of the following: Trace | Debug | Information | Warning | Error | Critical | None | Minimal logging level. In those values, Trace provides most chatty logs while None provides no logs. |

Consumes the logger

  • Get the ILogger service, for example, in HomeController:
public class HomeController : Controller
{
    private readonly ILogger _logger;
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    // ...
}
  • Use the logger:
public class HomeController : Controller
{
    // ...
    public IActionResult Index()
    {
        _logger.LogWarning("Entering Index.");
        return View();
    }
    // ...
}

Result Example:

Example Result Image

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.1.5 707 12/5/2017
0.1.4 319 11/22/2017
0.1.3 240 11/14/2017
0.1.2 249 11/9/2017
0.1.1 274 11/9/2017
0.1.0 238 11/9/2017