Skip to content

Commit

Permalink
add basic docs on event studio
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper committed Nov 21, 2024
1 parent 082676d commit c66ec0d
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 0 deletions.
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.
93 changes: 93 additions & 0 deletions content/en/user-guide/tools/event-studio/index.md
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 debug, profile, and test events locally while developing event-driven applications!
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.

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.

0 comments on commit c66ec0d

Please sign in to comment.