FormatLog 1.0.7

FormatLog Logging Component Solution

Language Switch

English | 简体中文

Solution Overview

This solution contains two projects:

• FormatLog: A high-performance structured logging component supporting parameterization, format deduplication, caller context, batch writing, and cursor-based pagination queries.
• DemoWPF: A WPF demo project showcasing log writing, querying, rich text rendering, and more.

FormatLog Component Core

Main Features

• Structured Log Format: Unique constraint via Format, parameterized log content for easy search and analysis.
• Parameterized Logging: Log supports up to 10 parameters, auto-archives parameter table to avoid duplicate storage.
• Caller Context Tracking: CallerInfo records member, file, and line number for easy location.
• High-Performance Batch Writing: FLog uses double-buffered queue + background thread, auto batch writes to SQLite, auto flush on process exit.
• Efficient Pagination Query: Supports cursor pagination, bidirectional paging, and conditional filtering (level, time, format, parameters, caller, etc.).
• Exception Persistence: Flush exceptions are automatically saved as JSON/TXT for troubleshooting.

Component Structure

• FormatLog/Format.cs: Log format definition, uniqueness constraint, batch SQL insert.
• FormatLog/Log.cs: Main log entity, includes format, parameters, caller context, creation time, etc.
• FormatLog/Argument.cs: Log parameter entity, uniqueness constraint.
• FormatLog/CallerInfo.cs: Caller context entity, uniqueness constraint.
• FormatLog/LogDbContext.cs: EF Core database context, auto table creation, daily database partitioning.
• FormatLog/FLog.cs: Log pool management, batch writing, exception handling, pagination query.
• Other helper classes: QueryModel, FlushInfo, KeysetPage.

Quick Start

1. Write log

FLog.Add(new Log(LogLevel.Info, "User login: {0}@{1}", userName, domain).WithCallerInfo());

2. Query logs (pagination, filtering)

var query = new QueryModel()
    .WithLevel(LogLevel.Info)
    .WithFormat("Login")
    .OrderBy(OrderType.OrderByIdDescending)
    .WithNextCursorTick(nextCursorTick);

var page = await query.KeysetPaginationAsync();

Design Highlights

• Format Deduplication: Log format, parameters, and caller context are automatically deduplicated to save storage.
• Batch Efficiency: Double-buffered queue + batch SQL insert greatly improves write performance.
• Easy Extension: Supports custom filtering, pagination, and exception handling.
• Database Partitioning: Daily partitioning for easy archiving and maintenance.

Application Scenarios

• Desktop/server applications with high-concurrency log writing
• Structured log analysis and search systems
• Debugging/operation scenarios requiring caller context and parameter tracking

Dependencies

• .NET 8
• Microsoft.EntityFrameworkCore.Sqlite

DemoWPF Demo Project

Main Features

• Log Writing Demo: Supports batch writing of various log types (system info, multiplication, division, random string, long/short text, timestamp, user/disk/network info, etc.).
• Log Query & Filtering: Supports multi-condition filtering by format, parameters, caller, level, time range, etc.; supports cursor pagination and bidirectional paging.
• Rich Text Rendering: Log content parameters are highlighted, supports segmented rich text.
• Performance Statistics: Real-time display of log write performance (time per 100 entries).

Main Interfaces

• Log Writing Page: Select log type and level, batch write demo.
• Log Query Page: Multi-condition filtering, paginated browsing, rich text highlighting.

How to Run

1. Install .NET 8 SDK.
2. Run the DemoWPF project (WinExe, WPF).
3. Depends on MahApps.Metro (UI beautification), FormatLog (logging core).

Integrate FormatLog Steps

1. Reference the FormatLog project or NuGet package.
2. Use FLog.Add(new Log(...).WithCallerInfo()) to write logs.
3. Use QueryModel for pagination queries.
4. WPF can use LogViewModel for segmented rich text rendering.

Directory Structure

FormatLog/
  ├─ Format.cs
  ├─ Log.cs
  ├─ Argument.cs
  ├─ CallerInfo.cs
  ├─ LogDbContext.cs
  ├─ FLog.cs
DemoWPF/
  ├─ LogViewModel.cs
  ├─ LogTextSegment.cs
  ├─ MainWindow.xaml(.cs)

Dependencies

• .NET 8
• Microsoft.EntityFrameworkCore.Sqlite
• MahApps.Metro (DemoWPF UI)

FAQ

• Log write exceptions are automatically persisted to JSON/TXT files for troubleshooting.
• Log database is partitioned daily for easy archiving and maintenance.

For detailed API documentation or secondary development advice, please refer to the source code comments or contact the maintainer.