Guidance, links, utilities, and additional logger providers for .NET Microsoft.Extensions.Logging

• PS> dotnet add package Essential.LoggerProvider.Elasticsearch
• PS> dotnet add package Essential.LoggerProvider.RollingFile
• PS> dotnet add package Syslog.StructuredData

General Microsoft.Extensions.Logging:

• Getting Started
• Hello Logging

Essential logging Essential.LoggerProvider:

• Hello Rolling File
• Hello Elasticsearch

• Theory of Event IDs
• Logging Levels

From Microsoft:

• High performance logging
• Logging Fundamentals -- scroll down to see the built in system categories and the built-in logging providers.

• .NET Core 3.1 development tools

• PowerShell Core, to run scripts
• An editor, e.g. VS Code, if you want to contribute

To test:

dotnet test test/Essential.LogTemplate.Tests

Run examples and check the output:

dotnet run --project examples/HelloRollingFile

Versioning is done automatically with GitVersion, so you can determine the build / package number based on the git branch.

The libraries can be easily packaged for release.

If you do this on a branch, it will have a pre-release version. Once merged to master, it will have the correct GitVersion (including any +major or +minor version bumps).

dotnet pack src/Essential.LogTemplate -c Release --output pack
dotnet pack src/Essential.LoggerProvider.RollingFile -c Release --output pack

The results will output to the pack folder in the project, with the reference from the LoggerProvider to the LogTemplate automatically converted to a package dependency (with the same version number across both).

To turn off the automatic GitVersion numbering, and override with a specific package version (e.g. if you want to update and test package references before release):

dotnet pack src/Essential.LogTemplate -p:GetVersion=false -p:PackageVersion=1.0.0 --output pack
dotnet pack src/Essential.LoggerProvider.RollingFile -p:GetVersion=false -p:PackageVersion=1.0.0 --output pack

There is a nuget.config file in the root of the project that adds the pack directory as a source, so that the examples can use it to reference the built packages.

Note that during development you may test multiple builds of the same version, so you need to clear out the NuGet cache (delete from the .nuget/packages folder) and force restore of packages before running:

Get-ChildItem (Join-Path $ENV:HOME '.nuget/packages/essential.logging.*') | Remove-Item -Recurse -Force
dotnet restore examples/HelloRollingFile --force --no-cache

• Rolling log file, by Andrew Lock

dotnet add package NetEscapades.Extensions.Logging.RollingFile

Project repository at: https://github.com/andrewlock/NetEscapades.Extensions.Logging

• Syslog, by mguinness

dotnet add package Syslog.Framework.Logging

Project repository at: https://github.com/mguinness/syslog-framework-logging

• Logstash (and Graylog), by Matt Cole

dotnet add package Gelf.Extensions.Logging

Project repository at: https://github.com/mattwcole/gelf-extensions-logging

• Seq

https://github.com/datalust/seq-extensions-logging

• add unit tests for rolling file (copy from ED)
• v1.1 of rolling file, with structured data support, facility support (to give full syslog format)
• add readme to LogTemplate project and move template details there
• FormattableString, that allows substring, ellipses, uppercase, lowercase, etc
• rename ColoredConsole to LoggerProvider, and implement (copy from ED initially)
• formats to match existing, e.g. values for Systemd, ScopeLine (with newline at end), MessageLine, ExceptionLine
• Elasticsearch provider, with examples, tests, etc. This needs a batching mechanism (similar to ED Seq)
• Other providers -- database,

For local build infrastructure (to test builds), there is a docker compose file in build/docker that will create a Jenkins instance and associated docker-in-docker container, to run agents.

Start the docker system:

docker-compose up -d

You can use Jenkins Blue Ocean to create a pipeline pointing to the Github (or local) repository. There is a Jenkinsfile that defines a pipeline to check compilation, run tests (with -v normal output), and then run a build script.

The build script, build.ps1 can also run locally and uses GitVersion.Tool to generate version numbers, then package a release version of the components.

Some references:

• https://jenkins.io/doc/pipeline/tour/getting-started/
• https://hub.docker.com/r/jenkinsci/blueocean/
• https://docs.docker.com/install/linux/linux-postinstall/

Copyright (C) 2019 Gryphon Technology Pty Ltd

This library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License and GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License and GNU General Public License along with this library. If not, see https://www.gnu.org/licenses/.