diff --git a/content/en/user-guide/tools/event-studio/display-the-connections.png b/content/en/user-guide/tools/event-studio/display-the-connections.png new file mode 100644 index 0000000000..b9b2ce1ef7 Binary files /dev/null and b/content/en/user-guide/tools/event-studio/display-the-connections.png differ diff --git a/content/en/user-guide/tools/event-studio/edit-and-replay.png b/content/en/user-guide/tools/event-studio/edit-and-replay.png new file mode 100644 index 0000000000..2df3116ced Binary files /dev/null and b/content/en/user-guide/tools/event-studio/edit-and-replay.png differ diff --git a/content/en/user-guide/tools/event-studio/index.md b/content/en/user-guide/tools/event-studio/index.md new file mode 100644 index 0000000000..229dc95212 --- /dev/null +++ b/content/en/user-guide/tools/event-studio/index.md @@ -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. + +Listing the local events + +### 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. + +Display the connections + +### 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. + +View Event Details + +### 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. + +Edit & Replay + +## 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/) diff --git a/content/en/user-guide/tools/event-studio/listing-local-events.png b/content/en/user-guide/tools/event-studio/listing-local-events.png new file mode 100644 index 0000000000..02fde3c6f9 Binary files /dev/null and b/content/en/user-guide/tools/event-studio/listing-local-events.png differ diff --git a/content/en/user-guide/tools/event-studio/view-event-details.png b/content/en/user-guide/tools/event-studio/view-event-details.png new file mode 100644 index 0000000000..d080f904bb Binary files /dev/null and b/content/en/user-guide/tools/event-studio/view-event-details.png differ