CerbiStream 1.0.5

CerbiStream Logging Library

CerbiStream is a next-generation logging solution built for structured logs, governance enforcement, and multi-destination routing. It ensures secure, consistent, and high-performance logging for cloud, on-prem, and hybrid environments.

🚀 What's New?

• Governance Enforcement – Define and enforce structured logging standards dynamically.
• Governance Analyzer – Uses Roslyn to validate logs at build time, reducing runtime validation overhead.
• Dynamic Governance Reload – Governance rules can now reload in real time when the JSON config changes.
• Log Level Enforcement – Restrict logging to allowed levels for better control.
• Plug-and-Play Cloud Detection – Auto-detects environment (AWS, Azure, GCP, On-Prem).
• Dev Mode – Prevents logs from being sent to external queues while debugging.
• Secure & NPI-Free Data Collection – Captures useful metadata without storing sensitive user data.

If you want Governance Enforcement, also install:

dotnet add package CerbiStream.GovernanceAnalyzer

📦 Installation

Install CerbiStream from NuGet:

dotnet add package CerbiStream

📦 Installation

Install CerbiStream from NuGet:

dotnet add package CerbiStream

If you want Governance Enforcement, also install:

dotnet add package CerbiStream.GovernanceAnalyzer

⚡ Quick Start (Minimal Setup) With CerbiStream, you can integrate logging in seconds.

using System;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using CerbiStream.Logging.Extensions;

```csharp
class Program
{
    static void Main()
    {
        var serviceProvider = new ServiceCollection()
            .AddLogging(builder =>
            {
                builder.AddConsole();
                builder.AddCerbiStream(options =>
                {
                    options.SetQueue("RabbitMQ", "localhost", "logs-queue");
                    options.EnableDevMode();
                    options.EnableGovernance();
                });
            })
            .BuildServiceProvider();

        var logger = serviceProvider.GetRequiredService<ILogger<Program>>();

        logger.LogInformation("Application started successfully!");
        logger.LogError("This is a test error log.");
        logger.LogWarning("Potential issue detected.");
        logger.LogCritical("Critical failure occurred!");
    }
}

🛠️ Advanced Configuration

If you need more control, you can configure CerbiStream dynamically.

var config = new CerbiStreamOptions();
config.SetQueue("Kafka", "kafka://broker-url", "app-logs");
config.DisableDevMode();
config.EnableGovernance();
config.IncludeAdvancedMetadata();

var logger = new CerbiStreamLogger(config);

🌐 Supported Logging Destinations

🔍 Automatic Metadata (No Setup Required)

🔐 Governance & Structured Logging

Governance allows organizations to enforce structured logging signatures by:

• ✅ Defining required fields (e.g., every log must include UserId, RequestId, etc.).
• ✅ Allowing optional fields that developers can extend dynamically.
• ✅ Using a governance configuration file (cerbi_governance.json) for dynamic updates. Example Governance JSON:

{
  "LoggingProfiles": {
    "TransactionLog": {
      "RequiredFields": ["TransactionId", "UserId", "Amount"],
      "OptionalFields": ["DiscountCode"]
    },
    "SecurityLog": {
      "RequiredFields": ["UserId", "IPAddress"],
      "OptionalFields": ["DeviceType"]
    }
  }
}

If GovernanceEnabled = true, logs must match the configured structure.

✅ Governance Analyzer (Build-Time Validation)

CerbiStream GovernanceAnalyzer uses Roslyn to validate log compliance at build time. This ensures structured logs without runtime overhead.

🛠 Debug Mode (Local Development) CerbiStream prevents queue logging while debugging. This is enabled by default (EnableDevMode = true).

var config = new CerbiStreamOptions();
config.EnableDevMode();

var logger = new CerbiStreamLogger(config);
await logger.LogEventAsync("Debugging locally", LogLevel.Debug);

📊 Meta Data Sharing (Opt-In)

CerbiStream collects aggregate trends across applications for AI-powered insights. ✅ No Personally Identifiable Information (PII) is stored.

If enabled, your logs contribute to global analytics (Error Trends, Cloud Performance, API Response Issues). If disabled, your logs remain 100% private.

var config = new CerbiStreamOptions();
config.IncludeAdvancedMetadata();
config.IncludeSecurityMetadata();

🔥 Why Use CerbiStream?

• ✅ No External Dependencies – Just install & start logging.
• 🚀 Optimized Performance – Logs lightweight metadata automatically.
• 🔒 Security First – Encrypts fields and ensures NPI-free logging.
• 🌍 Global Insights – Identify patterns across industries (if opted-in).
• ⚡ Minimal Setup – Works out-of-the-box with simple constructor injection.

📜 License CerbiStream is open-source and available under the MIT License.