CerbiStream.GovernanceAnalyzer 1.0.1

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 JSON configurations, reducing runtime validation overhead and improving 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 – Allows organizations to define mandatory fields for logs.
• Seamless Integration with CerbiStream – Works alongside CerbiStream for log governance.
• Lightweight & Fast – Runs at build time, avoiding runtime performance impact.

🚀 Installation

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

 dotnet add package CerbiStream.GovernanceAnalyzer

Or update your .csproj:

<ItemGroup>
    <PackageReference Include="CerbiStream.GovernanceAnalyzer" Version="1.0.0" />
</ItemGroup>

📌 How It Works

1. Governance Rules via JSON

   • Define required and optional logging fields in a cerbi_governance.json file.
   • Example:

   {
      "LoggingProfiles": {
          "Default": {
              "RequiredFields": ["Timestamp", "LogLevel", "Message", "ApplicationId"],
              "OptionalFields": ["UserId", "TransactionId"]
          }
      }
   }
   

2. Static Analysis at Build-Time

   • The analyzer verifies that logs match the governance profile during compilation.
   • Example of a valid log:

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

   • Example of an invalid log (missing required fields):

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

   • The build will fail with a warning/error indicating missing required fields.

3. Enforce or Warn Mode

   • Choose whether governance rules should fail the build (Error Mode) or just warn developers (Warning Mode).
   • This can be controlled via the cerbi_governance.json file.

🛠️ 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.

🎯 Future Enhancements

• Integration with CI/CD Pipelines – Enforce logging rules in GitHub Actions/Azure DevOps.
• Dashboard for Governance Management – UI to configure log governance dynamically.
• Multi-Project Support – Apply governance rules across microservices.

📜 License

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

📬 Contact & Contributions

We welcome contributions! Submit an issue or a pull request on GitHub.

Start enforcing structured logs today with CerbiStream-GovernanceAnalyzer! 🚀