Skip to main content

Installation

Getting up and running with SchemaWatcher should take a few minutes (hopefully!).

Requirements

  • Node.js version >= 14 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed
  • Yarn version >= 1.5 (which can be checked by running yarn --version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.
  • CDK v2 version >= 2.0

Installing the construct

To get started with SchemaWatcher you will need to install the construct into your project.

npm i cdk-schema-watcher

Turning on schema discovery

In order to use this construct you need to turn on schema discovery for your EventBridge bus.

You can do this using the AWS console, navigating to your event bus and enabling schema discovery.

Using the construct

Once installed, you will need to import the construct into your project and configure the plugins you want to use.

Plugin Support

At the moment only Slack is supported, looking to release more soon.

If you would like to help write a plugin, you can read the plugin docs.

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';

import { SchemaWatcher } from 'cdk-schema-watcher';
import { SlackNotifier } from 'cdk-schema-watcher/plugins';

export class CdkSchemaWatcherSandboxStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);
    new SchemaWatcher(this, 'MyTeam', {
      type: 'All',
      sources: ['myapp.users', 'myapp.orders'],
      plugins: [
        new SlackNotifier({
          API_KEY: process.env.SLACK_API_KEY,
          CHANNEL_ID: process.env.SLACK_CHANNEL_ID,
        }),
      ],
    });
  }
}

With SchemaWatcher you can listen to a variety of events from the schema registry. You can configure these inside the SchemaWatcher construct. See the guides for more information.