Skip to main content

Getting Started with EventCatalog Reports

warning

This feature is currently in beta. We are looking for beta users to help us improve the tool. Contact us to get access.

@eventcatalog/reports is a powerful CLI tool designed to help you measure and improve the governance of your Event-Driven Architecture (EDA). It generates automated reports that provide a clear understanding of your current governance posture, identify documentation gaps, and offer actionable insights to enhance your EDA's health and maintainability.

Governance Report

With EventCatalog reports, you can:

  • Obtain a quantifiable governance score for your architecture.
  • Pinpoint which parts of your system are well-documented and which require attention.
  • Identify orphan components or undocumented relationships between services and events.
  • Enhance discoverability and foster a shared understanding of your EDA across teams.

Report Types​

The @eventcatalog/reports CLI allows you to generate two main types of reports:

1. Assessment Reports (Free)​

Assessment reports provide a high-level overview of your architecture's governance.

  • Cost: Free
  • Frequency: Can be run at any time.
  • Output: Delivers a governance score and a summary of your architecture's documentation completeness. This is ideal for a quick check-up on your current standing and identifying broad areas for improvement.
  • Example: You can see an example of an Assessment Report here.

2. Full Reports (Paid Feature)​

Full reports offer a comprehensive, deep-dive analysis of your architecture, providing detailed insights and actionable recommendations.

  • Cost: This is a paid feature requiring a valid license.
  • Content:
    • In-depth analysis of your events, services, domains, and flows.
    • Precise identification of gaps in documentation, design, and relationships.
    • Actionable recommendations on how to address these gaps and improve your overall governance score.
    • Detailed insights into data lineage, component dependencies, and potential architectural risks.
  • Example: You can see an example of a Full Report here.

Using the CLI​

To generate reports, you will use the @eventcatalog/reports CLI.

Generate a report​

You will need to run the following command in your EventCatalog directory.

This command will generate a report based on the current state of your EventCatalog.

npx @eventcatalog/reports@latest generate-assessment

Once you run the command you will see a new report created in your directory eventcatalog-assessment-report-{timestamp}.pdf.

Generate a full report​

To generate a full report, you will need to have a valid license.

You can also contact us (at hello@eventcatalog.dev) to generate a full report for you.

We also offer consulting services to help you improve your EventCatalog and governance score.