https://github.com/backslashspace/logging-cs

Simple CLI and file logging for .Net Framework
https://github.com/backslashspace/logging-cs

cli colors debug file logging netframework threadsafe

Last synced: 6 months ago
JSON representation

Simple CLI and file logging for .Net Framework

• Host: GitHub
• URL: https://github.com/backslashspace/logging-cs
• Owner: backslashspace
• License: mit
• Created: 2024-10-05T15:01:23.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-02-05T07:25:34.000Z (about 1 year ago)
• Last Synced: 2025-03-22T04:09:48.635Z (about 1 year ago)
• Topics: cli, colors, debug, file, logging, netframework, threadsafe
• Language: C#
• Homepage:
• Size: 122 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# What is this?

A simple, readable and thread safe runtime and debug logging implementation.

### Features

- Automatic Console allocation for non-Console apps in Debug mode

- Clear log format with configurable padding

- Thread safe (normal locking)

- Easy to use

Note: Whether the applications is currently running in debug mode is determined by `#if DEBUG ... #endif` and the `[Conditional("DEBUG")]` method attribute, which prevents code from getting compiled into release binaries.

# Sample Debug Output

![Image](./readmeAssets/debug_cli_preview.png)

# Sample Log file Output

![Image](./readmeAssets/sampleLogFile.png)

# Getting Started

1. Copy the `Logging` directory into your solution

2. Add `using BSS.Logging;` to your `.cs` file to import the namespace

3. Initialize the `Log` class with `Log.Initialize();` (you may want to pass a path to the log output directory (default is ./logs) and/or the padding width)

Now, for example, you can call:

>    Log.FastLog("Info message from ThreadPool", LogSeverity.Info, "ThreadPool");

This will output to the log file, and in debug mode, write to the console.

Or to just write to the console in debug mode:

>    xDebug.WriteLine("direct console write");

---

Note: You can manually invoke the initialization of the `xDebug` class, but this should normally not be necessary (static constructor)

`xDebug.IsInitialized` should always return `true` (checking this value will initialize the class)