Read the Docs | Edit the Docs | View Demo

Core Features

• 📃 Document domains, services and event schemas from your AWS Glue Schema Registry
• Sync your schemas to EventCatalog with auto versioning from AWS Glue Schema Registry
• Map your schemas to your domains and services, and filter schemas using multiple criteria
• 📊 Visualise your event-driven architecture (demo)
• ⭐ Download your event schemas from EventCatalog (Avro, JSON Schema, Protocol Buffers) (demo)
• 💅 Custom MDX components (read more)
• 🗄️ Auto versioning of your domains, services and events
• ⭐ Discoverability feature (search, filter and more) (demo)
• 🔗 Direct links to AWS Glue console for schema management
• 🏷️ Support for schema evolution, compatibility modes, and metadata
• 📋 Support for multiple schema formats: Avro, JSON Schema, and Protocol Buffers
• ⭐ 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 run during pre-build to generate content in your catalog. Generators can use the EventCatalog SDK.

With this AWS Glue Schema Registry plugin you can connect your Glue Schema Registry to your catalog. You can map your schemas to your domains and services and also filter (prefix, suffix, exact matching, data format filtering) for your schemas.

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

...
generators: [
    [
      '@eventcatalog/generator-aws-glue',
      {
        region: 'us-east-1',
        registryName: 'my-event-registry',
        services: [
          // Maps exact schemas to the service
          { id: 'Orders Service', version: '1.0.0', sends: [{ schemaName: ['OrderCreated', 'OrderUpdated'] }], receives: [{ schemaName: 'InventoryUpdated' }] },
          // Filter by schema name prefix (all schemas that match the prefix get assigned). This example shows any schema matching the prefix
          // "Customer" will be assigned to the customer service. The customer service will publish these schemas.
          { id: 'Customer Service', version: '1.0.0', sends: [{ prefix: "Customer" }], receives: [{ suffix: "Event" }] },
          // This service sends schemas that match certain data formats, and will receive schemas with specific tags
          { id: 'Analytics Service', version: '1.0.0', sends: [{ dataFormat: "AVRO" }], receives: [{ tags: { "team": "analytics" } }] }
        ],
        domain: { id: 'ecommerce', name: 'E-commerce', version: '1.0.0' },
      },
    ],
    // Example of saving all schemas directly into EventCatalog without services or domains
    // All schemas in registry will be added to the Catalog.
    [
      '@eventcatalog/generator-aws-glue',
      {
        region: 'us-east-1',
        registryName: 'central-event-registry'
      },
    ],
    // Example using registry ARN and credentials
    [
      '@eventcatalog/generator-aws-glue',
      {
        region: 'us-east-1',
        registryName: 'shared-registry',
        registryArn: 'arn:aws:glue:us-east-1:123456789012:registry/shared-registry',
        credentials: {
          accessKeyId: 'X',
          secretAccessKey: 'X',
        },
      },
    ],
  ],
...

In this example we have multiple use cases for the generator:

1. Map schemas to services and domains using custom filters.
2. Add all schemas to EventCatalog regardless of the service or domain.
3. Use cross-account registry access with registryArn.

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

npm install @eventcatalog/generator-aws-glue

2. Configure your eventcatalog.config.js file

3. Run the generate command

npm run generate

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

npm run dev

Configuration Options

Required Options

• region (string): AWS region where your Glue Schema Registry is located
• registryName (string): Name of the Glue Schema Registry to scan for schemas

Optional Options

• registryArn (string): ARN of the Schema Registry (for cross-account access)
• services (array): Map schemas to specific services using filters
• domain (object): Optional domain to group your services under
• credentials (object): AWS credential override (accessKeyId, secretAccessKey)
• writeFilesToRoot (boolean): Write files to root instead of domain/service folders
• format ('md' | 'mdx'): Output format for generated files

Service Configuration

Each service can define sends and receives arrays with filter objects:

Filter Options

• schemaName: Exact schema name(s) to match
• prefix: Schemas starting with this prefix
• suffix: Schemas ending with this suffix
• includes: Schemas containing this substring
• dataFormat: Schemas with specific format (AVRO, JSON, PROTOBUF)
• registryName: Filter by specific registry name
• tags: Object with key-value pairs that must match schema tags

Example Service Configuration

{
  id: 'Event Processing Service',
  version: '1.0.0',
  sends: [
    { prefix: 'Order' },                // Schemas starting with 'Order'
    { dataFormat: 'AVRO' },            // All Avro schemas
    { schemaName: ['UserEvent'] }      // Specific schema
  ],
  receives: [
    { suffix: 'Command' },              // Schemas ending with 'Command'
    { tags: { source: 'kafka' } },     // Schemas tagged with source=kafka
    { includes: 'Customer' }            // Schemas containing 'Customer'
  ]
}

Schema Formats

The generator supports three schema formats:

• AVRO: Apache Avro schemas (.avsc files)
• JSON: JSON Schema definitions (.json files)
• PROTOBUF: Protocol Buffer definitions (.proto files)

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://eventcatalog.cloud or email us at [email protected].