Conversation
sheltongraves
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
Deploying localstack-docs with
|
| Latest commit: |
8e90021
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://72e75304.localstack-docs.pages.dev |
| Branch Preview URL: | https://sheltongraves-patch-4.localstack-docs.pages.dev |
peter-smith-phd
left a comment
peter-smith-phd
left a comment
There was a problem hiding this comment.
Thanks for this... I've made a number of suggestions, largely about wording/phrasing, but I've also identified some missing sections.
I was also hoping for a guided walkthrough, similar to what AWS typically has in their documentation. I know we haven't traditionally done this in the past, but this is an opportunity to start moving in that direction.
I had added some suggestions to the linear issue here: https://linear.app/localstack/issue/DOC-13/docs-app-inspector-launch-v2-docs-for-event-studio-rebranding
|
|
||
| App Inspector 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. |
There was a problem hiding this comment.
Replay won't be supported in the first release.
|
|
||
| With App Inspector, you can: | ||
|
|
||
| - Observe and understand the flow of events through your system. |
There was a problem hiding this comment.
Let's stay away from using "event", but instead say "flow of operations". We found that "event" is too heavily associated with event-driven development, and was making non-EDD people feel it wasn't for them.
| - 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. |
There was a problem hiding this comment.
I'm not sure what this bullet point means. I suggest removing it, unless you can use simpler language here.
|
|
||
| ## Use Cases | ||
|
|
||
| **Debugging event routing failures** |
There was a problem hiding this comment.
This whole sub-section needs to be rephrased. It should be focused on "flow of information between services", which is a key selling point of App Inspector.
The current explanation is too focused on events / EventBridge, which makes it feels like a point solution for events, rather than a general solution for understanding flow of information.
|
|
||
| **Verifying service-to-service payloads** | ||
|
|
||
| Inspect the exact data passed between services at every hop of your workflow. This is especially useful for confirming that a Lambda is passing the right payload to SNS, or that an SQS message body matches what the downstream consumer expects — before it becomes a production issue. |
There was a problem hiding this comment.
Instead of "This is especially useful", I'd suggest "For example".
That is, the Lambda -> SNS example is just one use case, rather than a special case.
|
|
||
| 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. | ||
|
|
There was a problem hiding this comment.
I feel we need a lot more detail here. In particular:
- What each field on the table represents (e.g. Producer, Consumer, Action, etc).
- The fact that some operations have errors associated with them.
- How you can click on the "View Graph" to switch to a graph view.
|
|
||
|  | ||
|
|
||
| ### View Event Details |
There was a problem hiding this comment.
Before talking about the "View Operation Details" page, we should talk about the Graph view, and how it can be navigated.
Alternatively, rename this section "The Graph View" and merge the content for both the Graph and the Operation Detail panel into a single narrative.
|
|
||
| | Feature | Hobby | Base / Ultimate / Enterprise | | ||
| |---|---|---| | ||
| | Maximum events stored | 10 | 1,000 | |
There was a problem hiding this comment.
Please change "events" to "operations"
We also need a discussion about selecting "Clear Operations" to make room for more operations to be stored.
|
|
||
| ## Supported Services | ||
|
|
||
| The following services are supported on App Inspector: |
There was a problem hiding this comment.
This is where we need more detail on what "supported" actually means. In theory, all operations for all services should appear, but the services in this list have been optimized to improve their visual layout.
|
|
||
| The following services are supported on App Inspector: | ||
|
|
||
| - [S3](/aws/services/s3) |
There was a problem hiding this comment.
API Gateway V1 should be on this list.
API Gateway V2 will be added, assuming we get it done in time.
- Added Peters Suggestions - Clear spans suggestions for users - Added API gateway v1 support - Added requirements for localstack minimum version
2 participants
Adding App Inspector Docs page.