Cerbi.Serilog.GovernanceAnalyzer 1.0.0

Cerbi Serilog Governance Analyzer

🧪 Compile-Time Governance for Serilog

Cerbi.Serilog.GovernanceAnalyzer is a Roslyn analyzer that validates your log statements at compile-time to ensure they meet governance policies. Whether you need to enforce required fields, block sensitive data, or maintain consistency across teams — this analyzer helps shift governance left into your IDE and CI pipelines.

Disclaimer: Cerbi LLC is not affiliated with or endorsed by the maintainers of Serilog. This analyzer is a third-party tool designed to work alongside Serilog for governance enforcement.

📦 Installation

dotnet add package Cerbi.Serilog.GovernanceAnalyzer

🚀 Key Features

• 🚫 Flags missing required fields
• 🔒 Prevents forbidden keys (e.g., SSN, CreditCard)
• ⚠️ Warns on advisory or incorrect enum values
• 🔁 Supports live reload of cerbi_governance.json
• 🧩 Pluggable validation via ICustomGovernancePlugin

🔧 Setup + Usage

1️⃣ Install Serilog and Cerbi Analyzer

dotnet add package Serilog

Already covered: dotnet add package Cerbi.Serilog.GovernanceAnalyzer

2️⃣ Add Governance Config to Your Project

Create config/cerbi_governance.json:

{
  "EnforcementMode": "Strict",
  "LoggingProfiles": {
    "default": {
      "FieldSeverities": {
        "userId": "Required",
        "ssn": "Forbidden"
      }
    }
  }
}

Update .csproj to include:

<None Include="config\cerbi_governance.json">
  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>

3️⃣ Configure Serilog with Governance

using Serilog;
using Cerbi.Serilog.GovernanceAnalyzer;

Log.Logger = new LoggerConfiguration()
    .Filter.WithCerbiGovernance("config/cerbi_governance.json", "default")
    .WriteTo.Console()
    .CreateLogger();

4️⃣ Example Log (✅ Passes Governance)

Log.Information("User created| userId={UserId}", "abc-123");

5️⃣ Example Log (❌ Fails Governance)

Log.Information("SSN submitted| ssn={ssn}", "123-45-6789");

Triggers:

[CERBI002] Forbidden Field: 'ssn' is not allowed in profile 'default'

🧩 Quick Start (Minimal Working Example)

// Program.cs
using Serilog;
using Cerbi.Serilog.GovernanceAnalyzer;

Log.Logger = new LoggerConfiguration()
    .Filter.WithCerbiGovernance("config/cerbi_governance.json", "default")
    .WriteTo.Console()
    .CreateLogger();

Log.Information("User signed in| userId={UserId}", "abc-123");

.csproj snippet:

<None Include="config\cerbi_governance.json">
  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>

🧠 IDE Tip: Violations will appear directly in Visual Studio, Rider, or in CI builds using dotnet build. Strict mode causes compile failure.

🧠 Governance Enforcement Example

(see above config)

👥 Plugin Support (Advanced)

Create custom enforcement logic with ICustomGovernancePlugin:

public class TeamIdPlugin : ICustomGovernancePlugin
{
    public string Id => "plugin.teamid.required";
    public string Description => "Requires TeamId in Production";
    public PluginCategory Category => PluginCategory.Compliance;
    public string[] AppliesToProfiles => new[] { "*" };

    public bool Validate(string profileName, Dictionary<string, object> data, out List<string> failures, out int impact)
    {
        failures = new(); impact = 0;
        if (data.TryGetValue("Environment", out var env) &&
            env?.ToString() == "Production" &&
            !data.ContainsKey("TeamId"))
        {
            failures.Add("Missing TeamId in Production logs");
            impact = 5;
            return false;
        }
        return true;
    }
}

📄 License & Support

• License: MIT (cerbi.io/licenses)
• Website: cerbi.io
• Contact: hello@cerbi.io

Cerbi LLC is not affiliated with or endorsed by Serilog or its maintainers. Serilog is a separate open-source project governed by its own license and maintainers.

⚖️ Secure • 📊 Structured • ✅ Compliant Cerbi Governance Analyzer for Serilog — by Cerbi LLC