Read the Docs | Edit the Docs | View Demo

Core Features

• 📃 Document domains, services and messages from your Amazon EventBridge schema registries (example)
• 📊 Visualise your architecture (demo)
• ⭐ Download your event schemas from EventCatalog (e.g JSONDraft, OpenAPI) (demo)
• 💅 Custom MDX components (read more)
• 🗄️ Auto versioning of your domains, services and events
• 🗄️ Matches versioning from your EventBridge registry
• ⭐ Discoverability feature (search, filter and more) (demo)
• ⭐ And much more...

How it works

EventCatalog is technology agnostic, meaning it can integrate with any schemas, specs or brokers.

EventCatalog supports generators. Generators are scripts are run to pre build to generate content in your catalog. Generators can use the EventCatalog SDK.

With this EventBridge plugin you can connect your schema registries to your catalog. You can map your events to your domains and services and also filter (suffix, prefix, exact matching, source filtering) for your events.

This is done by defining your generators in your eventcatlaog.config.js file.

...
generators: [
    [
      '@eventcatalog/generator-eventbridge',
      {
        region: 'us-east-1',
        registryName: 'discovered-schemas',
        services: [
          // Maps exact events to the service
          { id: 'Orders Service', version: '1.0.0', sends: [{ detailType: ['OrderPlaced', 'OrderUpdated'], receives:["InventoryAdjusted"]}] },
          // Filter by source (all events that match the source get assigned). This example shows any event matching the source
          // "myapp.orders" will be assigned to the inventory service. The inventory service will publish these events.
          { id: 'Inventory Service', version: '1.0.0', sends: [{ source: "myapp.orders"}], receives:[{ detailType: "UserCheckedOut"}] },
          // This service sends events that match the SchemaName prefixing myapp, and will receive events that end with Payment
          { id: 'Payment Service', version: '1.0.0', sends: [{ prefix: "myapp"}], receives:[{ suffix: "Payment" }] }
        ],
        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
      },
    ],
    // Example of saving all messages directly into EventCatalog without services or domains
    // All events in registry will be added to the Catalog.
    [
      '@eventcatalog/generator-eventbridge',
      {
        region: 'us-east-1',
        registryName: 'discovered-schemas'
      },
    ],
    // Example using optional credentials
    [
      '@eventcatalog/generator-eventbridge',
      {
        region: 'us-east-1',
        registryName: 'discovered-schemas',
        credentials: {
          accessKeyId: 'X',
          secretAccessKey: 'X',
          accountId: 'X',
        },
      },
    ],
  ],
...

In this example we have two types of usecases for the generator:

1. Map events to services and domains using custom filters.
2. Add all events to EventCatalog regardless of the service or domain.

You can see an example in the eventcatalog-eventbridge-example repo

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

@eventcatalog/generator-eventbridge

2. Configure your eventcatalog.config.js file (see example)

3. Run the generate command

npm run generate

4. See your new domains, services and messages, run

npm run dev

Found a problem?

Raise a GitHub issue on this project, or contact us on our Discord server.

Sponsors

Thank you to our project sponsors.

Gold sponsors

Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or visit our sponsor page.

Enterprise support

Interested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.

Find more details on our services page.

Contributing

If you have any questions, features or issues please raise any issue or pull requests you like. We will try my best to get back to you.

You can find the contributing guidelines here.

Running the project locally

1. Clone the repo
2. Install required dependencies pnpm i
3. Run tests pnpm run tests

Commercial Use

This project is governed by a dual-license. To ensure the sustainability of the project, you can freely make use of this software if your projects are Open Source. Otherwise for proprietary systems you must obtain a commercial license.

If you would like to obtain a Commercial License, you can purchase a license at https://dashboard.eventcatalog.dev or email us at [email protected]