This repository was archived by the owner on Aug 7, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 128
add basic docs on event studio #1564
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| title: "Event Studio" | ||
| weight: 12 | ||
| description: Event Studio allows you to record, trace, debug and replay any events exchanged between AWS services. | ||
| tags: ["Pro image"] | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Event Studio allows users to view, collect, and inspect data exchanges, including event payloads and metadata, between AWS services. | ||
| It enhances system observability by displaying the data exchanged at every stage, facilitating clear understanding of event flows. | ||
| It further centralizes debugging by enabling event replay at any system stage for detailed analysis and troubleshooting. | ||
| In addition, it serves as a single point of truth to understand potential errors, service configuration mismatches and IAM permission issues. | ||
|
|
||
| With Event Studio, you can: | ||
|
|
||
| - Observe and understand the flow of events through your system. | ||
| - Replay events to troubleshoot AWS services involved in your workflow. | ||
| - Identify errors and obtain detailed information for corrections. | ||
| - Get immediate feedback on any misconfigurations in your services. | ||
| - Gain insights into IAM policies and detect missing permissions. | ||
| - Enhance event contexts for advanced flow tracing. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install Event Studio, start your LocalStack container with your `LOCALSTACK_AUTH_TOKEN`: | ||
|
|
||
| {{< command >}} | ||
| $ export LOCALSTACK_AUTH_TOKEN=... | ||
| $ localstack start | ||
| {{< / command >}} | ||
|
|
||
| Event Studio is available as a LocalStack Extension. | ||
| To install it, use the `extensions` sub-command in the `localstack` CLI. | ||
| Run the following command to install Event Studio: | ||
|
|
||
| {{< command >}} | ||
| $ localstack extension install localstack-extension-event-studio | ||
| {{< / command >}} | ||
|
|
||
| Check the LocalStack logs for Event Studio output, where you should see logs like: | ||
|
|
||
| ```bash | ||
| localstack-main | 2024-11-21T08:47:25.688 INFO --- [ MainThread] l.e.patterns.webapp : eventstudio extension available at http://localhost.localstack.cloud:4566/_extension/eventstudio | ||
| localstack-main | 2024-11-21T08:47:25.694 INFO --- [ MainThread] l.e.patterns.webapp : eventstudio extension available at http://eventstudio.localhost.localstack.cloud:4566 | ||
| localstack-main | 2024-11-21T08:47:25.858 INFO --- [ady_monitor)] eventstudio.extension : Extension Loaded | ||
| localstack-main | Ready. | ||
| ``` | ||
|
|
||
| You can navigate to **https://eventstudio.localhost.localstack.cloud:4566** in your browser to view your events. | ||
|
|
||
| ## Features | ||
|
|
||
| ### List the local events | ||
|
|
||
| With Event Studio, you can view a detailed list of events in your application, including event producers, types, and timestamps. | ||
| The interface enables you to trace the flow of events, identify relationships between services, and analyze patterns for debugging or optimization. | ||
|
|
||
| <img src="listing-local-events.png" alt="Listing the local events" title="Listing the local events" width="900px" /> | ||
|
|
||
| ### Display the connections | ||
|
|
||
| By clicking on the events, you can visualize the intricate relationships between AWS services in your event-driven architecture. | ||
| Event Studio offers a clear, interactive graph that shows how different AWS services interact, making it easy to track data flow, identify bottlenecks, and debug issues. | ||
|
|
||
| <img src="display-the-connections.png" alt="Display the connections" title="Display the connections" width="900px" /> | ||
|
|
||
| ### View Event Details | ||
|
|
||
| When you click on the service, you can drill down into the specifics of each event, including the data exchanged between services, detailed payloads, and metadata. | ||
| Event Studio highlights errors, warnings, and potential IAM permission issues, enabling precise debugging and troubleshooting. | ||
| This detailed view ensures complete transparency and insight into system interactions at every step. | ||
|
|
||
| <img src="view-event-details.png" alt="View Event Details" title="View Event Details" width="900px" /> | ||
|
|
||
| ### Edit & Replay | ||
|
|
||
| Finally, you can modify event payloads and metadata directly within the interface to test different scenarios or adjust configurations. | ||
| Replay edited events through your system to analyze workflows, validate fixes, and ensure accurate service interactions. | ||
| This is essential for effectively debugging complex event-driven architectures. | ||
|
|
||
| <img src="edit-and-replay.png" alt="Edit & Replay" title="Edit & Replay" width="900px" /> | ||
|
|
||
| ## Supported Services | ||
|
|
||
| The following services are supported on Event Studio: | ||
|
|
||
| - [S3](https://docs.localstack.cloud/user-guide/aws/s3/) | ||
| - [SQS](https://docs.localstack.cloud/user-guide/aws/sqs/) | ||
| - [SNS](https://docs.localstack.cloud/user-guide/aws/sns/) | ||
| - [DynamoDB](https://docs.localstack.cloud/user-guide/aws/dynamodb/) | ||
| - [Lambda](https://docs.localstack.cloud/user-guide/aws/lambda/) | ||
| - [EventBridge](https://docs.localstack.cloud/user-guide/aws/events/) | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.