Skip to content

an easy to use yet highly extensible logging library with support of logging to log files, the terminal output, a similar output or to a server via various protocols

License

Notifications You must be signed in to change notification settings

FaolanBig/BigLog

Repository files navigation

BigLog – Overview

BigLog is a flexible logging library for C#. It supports output to console and file, with configurable prefixes, timestamps, log levels, and optional colors.

ℹ️ Colors are only applied to console output. When logging to a file or using the cache, colored output is disabled. If cache logging is flushed to the terminal, Color_fallback is used.

ℹ️ By default, all log levels are enabled. You can set minimum log levels for both terminal and file outputs to filter messages.

ℹ️ Logging to services like Azure Application Insights or Seq is not supported in this version but it is under development.


Quick Start

using BigLog;

class Program
{
    static void Main()
    {
        Logger logger = new Logger()
        {
            LogToFile = true,
            UseShortPrefix = true
        };

        logger.Inf("Program started");
        logger.Suc("Operation successful");
        logger.War("Low memory warning");
        logger.Err("Failed to open file");
        logger.Ctm("Custom log message");
    }
}

Log Levels

Method Method long Meaning Example Output
Trc() Trace() Trace log: 2025-11-05 13:30:01.1234 :: trc: Initializing...
Dbg() Debug() Debug log: ... :: dbg: Variable x = 42
Inf() Info() Information log: ... :: inf: Server started
Suc() Success() Success log: ... :: suc: File saved
War() Warning() Warning log: ... :: war: Low disk space
Err() Error() Error log: ... :: err: Connection failed
Ctc() Critical() Critical log: ... :: ctc: System integrity compromised
Fat() Fatal() Fatal log: ... :: fat: Unrecoverable failure
Ctm() Custom() Custom log: ... :: ctm: Test output

All methods accept either a string or an Exception.

Example:

try
{
    throw new Exception("File read error");
}
catch (Exception ex)
{
    logger.Err(ex);
}

Settings

General

Property Type Description Default
AutoFlush bool If true, logs are written immediately. If false, logs are cached until flushCache() is called. Set false for high performance logging. true
LogToTerminal bool Enables console output. true
LogToFile bool Enables file output. false
FileName string File path for logging. "log.txt"
UseDefaultEncoding bool Use system default encoding. true
Encoding Encoding Custom encoding (disables UseDefaultEncoding). Encoding.Default
MinLogLevel LogLevel Global minimum log level. Applies to both terminal and file unless overridden by the more specific properties. LogLevel.Trace
MinLogLevelTerminal LogLevel Minimum log level specifically for terminal output. LogLevel.Trace
MinLogLevelFile LogLevel Minimum log level specifically for file output. LogLevel.Trace

ℹ️ Log levels in increasing order are: Trace < Debug < Info < Success < Warning < Error < Critical < Fatal < Custom

ℹ️ Changing MinLogLevel sets both MinLogLevelTerminal and MinLogLevelFile to the same value.


Timestamp and Formatting

Property Type Description Default
PrintTimeStamp bool Adds a timestamp to each log. true
PrintTimeStampBeforeLevel bool Positions timestamp before log level. true
TimeStampPrefix string Text before timestamp. "log: "
TimeFormat string .NET timestamp format. "yyyy-MM-dd HH:mm:ss.ffff K"
PrePrefix string Separator between timestamp and prefix. " :: "
UseShortPrefix bool Short (inf:) or long (info:) prefixes. true

Prefixes

Log Type Short Long
Trace trc: trace:
Debug dbg: debug:
Info inf: info:
Success suc: success:
Warning war: warning:
Error err: error:
Critical ctc: critical:
Fatal fat: fatal:
Custom ctm: custom:

Example:

logger.PrefixInf = "[INFO] ";
logger.PrefixErr = "[ERROR] ";

Colors

Property Type Description Default
ColorAll bool Colors the entire console line (only console output). false
ColorMessage bool Colors only the message text (only console output). true
ColorLevelPrefix bool Colors only the prefix (only console output). false
EnableDefaultColors bool Enables default colors per log level. true
Color_fallback ConsoleColor Default color when no color mode or cache logging to terminal. White

Default colors per level (console only):

Level Color
Trace Gray
Debug Grey
Info White
Success Green
Warning Yellow
Error Magenta
Critical Red
Fatal DarkRed
Custom Cyan

Note: Colors cannot be used when logging to a file or when messages are cached. When cached messages are flushed to the terminal, Color_fallback is applied.

Example:

logger.ColorWar = ConsoleColor.Magenta;
logger.ColorErr = ConsoleColor.DarkRed;

Cache

If AutoFlush = false, messages are cached instead of being written immediately.

Logger logger = new Logger()
{
    AutoFlush = false,
    LogToFile = true
};

logger.Inf("Batch started...");
logger.War("Minor warning...");
logger.flushCache(); // writes all cached logs and clears cache afterwards

Additional cache commands:

logger.ClearCache(); // clears the cache without writing

Common Configurations

Console output with colors

Logger logger = new Logger()
{
    LogToFile = false,
    ColorAll = true
};

File logging

Logger logger = new Logger()
{
    LogToTerminal = false,
    LogToFile = true,
};

Minimal output

Logger logger = new Logger()
{
    PrintTimeStamp = false,
    UseShortPrefix = true
};

License

This project is licensed under the GNU Affero General Public License (AGPL). See LICENSE for details.

Copyright Notice

Copyright © 2025 by Carl Öttinger

Contact

You can contact me via email at carl@oettinger.cloud or visit my website at bigvault.cloud.

Contributing

Contributions are welcome! Please open issues or pull requests on the GitHub repository.

About

an easy to use yet highly extensible logging library with support of logging to log files, the terminal output, a similar output or to a server via various protocols

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages