jason-c-daniels / jcd-utilities Goto Github PK

Request

As a developer, I want an easy, and flexible way to override logging from all sources, so that I can have more control over logging, without sacrificing the detail NetCore (specifically Kestrel) already provides.

Details
The need always arises to dramatically alter how/where logs are being sent. In the case of ELK, Splunk, and Linux style log files, these can attach to the STDOUT of the process we're concerned with, but are often limited to putting their output on a single line for a single event.

As well, the default information that gets logged is seldom the full extent that any application will need. By providing simplifying hooks into .Net Core's existing logging facilities, this library can simplify this task for future developers who want detailed control, but don't want to spend forever configuring yet another logging engine.

Acceptance Criteria

• The hook will make the consumer only responsible for implementing a formatting, for text output, or a redirection method in their implementation.
• No more than 3 extension method calls should be necessary to register the custom logging implementation.
• The TState data currently provided by the .Net Core logging will have its information preserved and passed on to the custom implementation.
• The library will provide one example text formatter and one example .

Alternatives

• Serilog, NLog, log4net, and various one off ILoggerAdapter implementations all share a common downside. They're all configuration heavy.
• They try to be all things, logging related, to all people. This is overkill for most people's needs.
• As well, they all seem to be at odds with the existing .Net Core method of configuring logging. (i.e. you have to purge all other loggers, per some of their documentation)
• Or in the case of the one off ILoggerAdapters they don't actually reformat or redirect the logging as much as they provide an abstraction for unit testing. And in the process don't get access to the TState information .Net Core already gathers making them inappropriate for this task.

Task Description
Identify how to suffix release tags from AppVeyor with "-beta" or "-alpha."

Reason
This will clearly identify pre-releases making it easier for others to understand the state of affairs.

Enable nuget packaging in the library project. Then enable and identify it as an artifact in appveyor.

Task Description
Get a certificate to sign nuget packages with. This must come from a source like VeriSign

Reason
This is needed to deploy code to Microsoft's official nuget repository.

Additional Information
See if the package actually MUST be signed under windows, or if it can be done under linux.

Task Description
Look at the naming and other coding styles used. Make them consistent. Update XML documentation to match.

Reason
Mantainability, comprehension.

Describe the bug
GitVersion only works well on windows, fails on linux without a lot of hand holding. It's too immature to use at this time.

Resolution
Find something else to use. Yank it from the build script.