https://github.com/fargito/event-scout
Easy testing and monitoring for events flows on Amazon EventBridge
https://github.com/fargito/event-scout
aws cdk cdk-constructs eventbridge events serverless
Last synced: 4 days ago
JSON representation
Easy testing and monitoring for events flows on Amazon EventBridge
- Host: GitHub
- URL: https://github.com/fargito/event-scout
- Owner: fargito
- License: mit
- Created: 2022-12-19T10:26:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T22:10:52.000Z (5 months ago)
- Last Synced: 2025-05-09T00:02:49.036Z (5 months ago)
- Topics: aws, cdk, cdk-constructs, eventbridge, events, serverless
- Language: TypeScript
- Homepage:
- Size: 5.44 MB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Event Scout
Easy testing and monitoring for events flows on Amazon EventBridge.
## Why EventScout?
Debugging and testing asynchronous flows on Amazon EventBridge is hard, especially since AWS does not provide a simple way to monitor what events have transited through an Event Bus.
EventScout aims to provide this missing piece, both during development and in automated integration tests, by creating **event trails**. These trail record all events with a specific shape. You can then query the trail to see what events have transited through the bus.
For example, in an integration test, this could be used as such:
```mermaid
sequenceDiagram
autonumber
actor Test
participant EventScout
participant EventBridge
Test->>EventScout: Start event trail with this pattern
Test-->>EventBridge: Generate an event matching the pattern
EventBridge-->>EventScout: Receive the monitored event
EventScout->>EventScout: Store the monitored event in the trail
Test->>EventScout: Query the events in the trail
Test->>EventScout: Close the trail
```
## Features
- **Monitor your events easily**: EventScout allows you to create event trails with dynamic filter patterns on EventBridge
- **Scale your integration tests**: EventScout can create unlimited parallel event trails, event with overlapping patterns, so ou can rule all your integration tests in parallel
- **Pay only for what you use**: EventScout implements a fully Serverless architecture
## Installation
In order to properly work, EventScout needs to:
- deploy the necessary resources with [@event-scout/construct](./packages/construct/README.md)
- use event trails in your tests with [@event-scout/client](./packages/client/README.md)
- monitor your events in real-time with [event-scout](./packages/event-scout/README.md) CLI
And you're all set! The power of EventScout is yours!