Getting started
eventcatalog@2.6.0Dual-licenseAmazon EventBridge is an AWS service that helps developers build event-driven applications at scale. Amazon EventBridge offers mutiple solutions including Event Bus, Amazon EventBridge Pipes and Amazon EventBridge Scheduler.
Amazon EventBridge also offers a schema registry. This registry help you store your events in JSON and OpenAPI formats, give you the ability to download code bindings and also manage schema versions with automatic schema discovery.
Using the schema discovery feature, as events are put onto the event bus they are versioned and stored in the registry. These schemas can be used to help you and your teams understand and discover events in your event-driven architecture.
Although EventBridge offers managed schema solutions, there is a still an issue of discoverabilty and documentation for your events, services and domains. It still remains difficult to organize your event-driven architecture for governance.
Why use EventCatalog with EventBridge?
Using the EventCatalog EventBridge generator you can automate and generate your EventCatalog. Enable your teams to quickly find events from EventBridge, what services they belong too and how to start consuming them.
Core Features
The EventCatalog Amazon EventBridge plugin can provide you with many features:
- ⭐️ Generate domains, services, channels and messages into your catalog
- ⭐️ Automatically version your changes in EventCatalog in sync with your registry versions
- ⭐️ Allow you to write and persist custom markdown between changes
- ⭐️ Display your JSONDraft and OpenAPI schemas for each event in EventCatalog
- ⭐️ Filter events to match to your services
- ⭐️ Visualize your architecture
- ⭐️ Download schemas and code bindings
- ⭐️ and more....
How it works
EventCatalog supports generators. These are scripts or plugins that can be run to integrate with any external API, system or specification files. EventCatalog also provides an SDK to give developers easier access to their catalogs through custom scripts or generators.
The EventCatalog EventBridge plugin let's you map your events into domains and services. You can use custom filters (prefix, suffix, detailType and source) to map which events you want your service to produce and consume.
You can also use the EventCatalog plugin to map ALL events from your registry into your system and not map them into services if you wish to have a direct import.