CerbiStream.GovernanceAnalyzer 1.0.2

CerbiStream Governance Analyzer

CerbiStream-GovernanceAnalyzer is a Roslyn-based static analysis tool designed to enforce structured logging standards within applications using CerbiStream. It ensures that log messages adhere to governance rules defined in a JSON configuration, reducing runtime validation overhead and improving the developer experience.

🔥 Why Use CerbiStream-GovernanceAnalyzer?

• 🚀 Compile-Time Log Validation – Prevents misformatted logs before deployment.
• 📊 Structured Logging Enforcement – Ensures consistent log structures across teams.
• 🔧 Customizable Rules via JSON – Organizations can define mandatory log fields.
• 🔄 Seamless Integration with CerbiStream – Works alongside CerbiStream for log governance.
• ⚡ Lightweight & Fast – Runs at build time, avoiding runtime performance impact.
• ♻️ Dynamic Governance Reloading – Governance rules auto-reload if the JSON file is updated.

📦 Installation

To add CerbiStream-GovernanceAnalyzer to your project, install it via NuGet:

dotnet add package CerbiStream.GovernanceAnalyzer

📌 How It Works 1️ Governance Rules via JSON Define required and optional logging fields in a cerbi_governance.json file.

{
  "LoggingProfiles": {
    "API": {
      "RequiredFields": ["Timestamp", "LogLevel", "Message", "ApplicationId"],
      "OptionalFields": ["UserId", "TransactionId"],
      "AllowedLevels": ["Information", "Warning", "Error"],
      "EnforcementLevel": "Warning"
    },
    "SecurityLog": {
      "RequiredFields": ["UserId", "IPAddress"],
      "OptionalFields": ["DeviceType"],
      "AllowedLevels": ["Error", "Critical"],
      "EnforcementLevel": "Error"
    }
  }
}

2️ Static Analysis at Build-Time The Governance Analyzer checks log statements during compilation:

✅ Valid Log (meets governance rules):

logger.LogInformation("User login successful | UserId: {UserId}, Timestamp: {Timestamp}", userId, DateTime.UtcNow);

❌ Invalid Log (missing required fields):

logger.LogInformation("User login successful"); // ❌ Missing required metadata

Result: The build will fail or show a warning, depending on EnforcementLevel in cerbi_governance.json.

3️ Enforce or Warn Mode Choose whether governance rules should fail the build (Error Mode) or just warn developers (Warning Mode). This can be configured in cerbi_governance.json per logging profile.

🛠️ Configuration Options

📖 Example Usage 1️ Enabling Governance in CerbiStream In your Program.cs:

var serviceProvider = new ServiceCollection()
    .AddLogging(builder =>
    {
        builder.AddCerbiStream(options =>
        {
            options.EnableGovernance();
        });
    })
    .BuildServiceProvider();

2️ Running the Governance Analyzer The analyzer automatically runs during the build process. If any logs do not meet governance standards, you’ll see build errors or warnings.

3️ Dynamic Governance Reloading

Governance rules auto-reload when the cerbi_governance.json file is updated.

No need to restart the application to apply changes.

🚀 Future Enhancements

• 🔄 Integration with CI/CD Pipelines – Enforce logging rules in GitHub Actions, Azure DevOps, and Jenkins.
• 📊 Dashboard for Governance Management – UI to dynamically modify logging rules.
• 🔀 Multi-Project Support – Apply governance rules across microservices.
• 🧠 AI-Powered Log Insights – Use machine learning to analyze log patterns and recommend governance improvements.

📜 License

CerbiStream-GovernanceAnalyzer is open-source under the MIT License.