CerbiStream: Dev-Friendly Logging for .NET

🚀 View CerbiStream Benchmarks

Compare against Serilog, NLog, and others. CerbiStream is tuned for performance, governance, and enterprise-scale routing.

---

✅ Highlights

• Works with ILogger<T>
• Structured logging enforcement
• Supports RabbitMQ, Kafka, Azure, AWS, GCP queues
• Flexible encryption (None, Base64, AES)
• Schema enforcement with GovernanceAnalyzer
• 🔁 Queue-first architecture (sink-agnostic)

---

✨ What's New in v1.0.11

• New presets: BenchmarkMode(), EnableDeveloperModeWithTelemetry()
• Toggle: telemetry, console, metadata, governance
• JSON conversion with encryption
• Queue routing using enums

---

🧰 Install

dotnet add package CerbiStream

Optional governance analyzer:

dotnet add package CerbiStream.GovernanceAnalyzer

---

⚡ Quick Start

builder.Logging.AddCerbiStreamWithRouting(options =>
{
    options.WithQueue("RabbitMQ", "localhost", "logs-queue")
           .EnableDeveloperModeWithoutTelemetry()
           .WithEncryptionMode(EncryptionType.Base64);
});

---

🔐 Runtime Encryption

options.WithEncryptionMode(EncryptionType.AES)
       .WithEncryptionKey(myKey, myIV);

Default (lazy) test keys:

var (key, iv) = EncryptionHelpers.GetInsecureDefaultKeyPair();
options.WithEncryptionKey(key, iv);

KeyVault example:

var key = Convert.FromBase64String(await secretClient.GetSecret("CerbiKey"));
var iv = Convert.FromBase64String(await secretClient.GetSecret("CerbiIV"));

---

🛠️ Preset Modes

Method	Description
EnableDeveloperModeWithTelemetry()	Console + telemetry + metadata
EnableDeveloperModeWithoutTelemetry()	Console + metadata, no telemetry
EnableDevModeMinimal()	Console only
EnableBenchmarkMode()	Silent mode (no telemetry, queue, or console)

---

🔁 Retry Example

Policy
  .Handle<Exception>()
  .WaitAndRetry(3, _ => TimeSpan.FromSeconds(1), (ex, _, attempt, _) =>
  {
      TelemetryContext.IsRetry = true;
      TelemetryContext.RetryAttempt = attempt;
  });

---

🔧 Configuration Options

Option	Description
.WithQueue(...)	Configure queue host, name, and type
.DisableQueue()	Stops sending logs to queues
.WithTelemetryProvider()	Set custom telemetry provider
.IncludeSecurityMetadata()	Adds IP/UserID info
.EnableTelemetryLogging()	Sends to telemetry even if queue is disabled

---

📊 Telemetry Provider Support

Provider	Supported
OpenTelemetry	✅
Azure App Insights	✅
AWS CloudWatch	✅
GCP Trace	✅
Datadog	✅

---

📘 Code Samples

CerbiLoggerBuilder

var logger = new CerbiLoggerBuilder()
    .UseAzureServiceBus("<conn>", "<queue>")
    .EnableDebugMode()
    .Build(logger, new ConvertToJson(), new NoOpEncryption());

Fluent API

var options = new CerbiStreamOptions()
    .WithEncryptionMode(EncryptionType.Base64)
    .WithQueue("RabbitMQ", "localhost", "logs");

AddCerbiStreamWithRouting (DI)

builder.Logging.AddCerbiStreamWithRouting(options =>
{
    options.WithQueue("AzureServiceBus", "sb://...", "queue")
           .WithEncryptionMode(EncryptionType.AES);
});

---

🧪 Unit Test Example

var mockQueue = Substitute.For<IQueue>();
var logger = new Logging(Substitute.For<ILogger<Logging>>(), mockQueue, new ConvertToJson(), new NoOpEncryption());

var result = await logger.LogEventAsync("Test", LogLevel.Information);
Assert.True(result);

---

🌐 Supported Queues

• RabbitMQ
• Kafka
• Azure Queue / Service Bus
• AWS SQS / Kinesis
• Google Pub/Sub

---

🧵 Queue-First Logging (Sink-Agnostic)

CerbiStream does not directly send logs to sinks like Splunk, Elastic, or Blob.

Instead:

• 🔁 Logs are emitted to queues only (Kafka, RabbitMQ, Azure, etc.)
• 🧠 CerbIQ reads from these queues and sends logs to sinks
• ✅ Keeps log generation decoupled from log delivery

This design gives you:

• Better performance
• Retry-friendly resilience
• Pluggable downstream integrations

➡️ Add CerbIQ to handle routing and sink delivery.

---

🔐 Governance Enforcement (Optional)

{
  "LoggingProfiles": {
    "SecurityLog": {
      "RequiredFields": ["UserId", "IPAddress"],
      "OptionalFields": ["DeviceType"]
    }
  }
}

---

📜 License

MIT

---

Star the repo ⭐ — Contribute 🔧 — File issues 🐛

Created by @Zeroshi