Introducing EventCatalog Reports
I’m excited to announce that EventCatalog now includes Governance Reports! This new feature enables you to generate reports directly from your EventCatalog documentation. Each report provides a Governance Score—a helpful metric to track, measure, and improve the governance of your event-driven architecture.
Lack of governance leads to chaos
Many teams use EventCatalog to avoid the common challenges of managing event-driven architectures—like the chaos of unknown producers and consumers, versioning issues, poor documentation, unclear ownership, and more.
At first, event-driven architectures seem simple. You know who’s producing and consuming events. But as your architecture grows, so does the complexity. Teams multiply, events are raised from many producers, and understanding the distributed landscape becomes increasingly difficult.
This is why teams are using EventCatalog. EventCatalog is designed to help you document your event-driven architecture effectively. With our SDK and integrations, EventCatalog works with any technology stack or broker, letting you sync schemas and documentation seamlessly. This gives your developers and stakeholders the clarity they need.
And now, with EventCatalog Reports, you can measure and track your governance. Our Governance Score highlights areas for improvement, helping you build a more controlled, reliable, and scalable event-driven system.
How does the EventCatalog Report work?
You can use the new @eventcatalog/reports
CLI to generate two types of reports: the Assessment Report and the Full Report.
This CLI tool analyzes your documentation, schemas, and relationships between resources to generate key metrics for your event-driven architecture:
- Message Schema Completeness: Tracks messages (events, commands, queries) with defined schemas.
- Service Specification Completeness: Identifies services with linked API specifications (e.g., OpenAPI, AsyncAPI).
- Ownership Coverage: Shows which resources (domains, services, messages) have assigned owners.
- Orphaned Messages: Detects messages without any producers.
- Service Message Drift: Finds services sending or receiving outdated versions of messages.
- Deprecated Messages: Flags services that are still using deprecated messages.
Together, these metrics form your Governance Score, helping you measure and track your architecture’s health. The Full Report also highlights areas for improvement and provides actionable recommendations to strengthen your governance.
How to get started
If you don’t have an EventCatalog yet, you can get started here.
Once you’ve set up your EventCatalog and added your information—either through markdown files or using our integrations (e.g., OpenAPI, AsyncAPI)—you can run the Assessment Report.
From your EventCatalog directory, run the following command:
npx @eventcatalog/reports@latest generate-assessment
This will generate a free Governance Report, providing you with a Governance Score and highlighting key metrics that may need improvement.
Want to go deeper? We also offer Full Reports for a more comprehensive analysis. If you’d like beta access, reach out to us at hello@eventcatalog.dev—we’d be happy to help!
You can also read our documentation to learn why governance is important and how to get started.
EventCatalog Reports are currently in beta. We would love to hear your feedback! If you would like to get access to the full feature, please reach out to us at hello@eventcatalog.dev. We would love to work with you to improve the feature.
Summary
EventCatalog helps teams avoid the complexity and chaos that often comes with scaling event-driven architectures—like unclear ownership, versioning issues, and poor documentation. It provides a clear, structured way to document your architecture using markdown or integrations with tools like OpenAPI and AsyncAPI.
With the new @eventcatalog/reports
CLI, teams can generate two types of reports:
- The Assessment Report (free), which gives you a Governance Score based on key metrics like schema completeness, ownership coverage, orphaned messages, and service message drift.
- The Full Report (currently in beta), which provides deeper analysis and actionable recommendations for improving governance.
These reports help teams measure, track, and improve their architecture governance, enabling them to scale event-driven systems with confidence.
To get started, teams can install EventCatalog, set up their documentation, and run the generate-assessment
command for their free governance report. For access to the full report, they can reach out via email.