Skip to content

chore: Refine documentation and add CloudWatch dashboard#55

Merged
micro-jumbo merged 4 commits intomainfrom
docs
Aug 8, 2025
Merged

chore: Refine documentation and add CloudWatch dashboard#55
micro-jumbo merged 4 commits intomainfrom
docs

Conversation

@micro-jumbo
Copy link
Owner


Summary

This pull request includes the following changes:

  1. Documentation Enhancements:

    • Comprehensive updates to the jack-in-the-cloud and jimmy-the-deckhand README files, including installation steps, usage examples, and integration guidelines.
    • Expanded documentation to detail architecture, services, utilities, and environment variable requirements.
    • Updated assets with new illustrative images for jimmy-the-deckhand.
    • Added local development instructions and onboarding information.
  2. Feature Addition:

    • Introduced a new CloudWatch monitoring dashboard for jack-in-the-cloud using the JackInTheCloudDashboard construct.
    • Integrated monitoring for Lambda functions (invocations, errors, duration), DynamoDB, SNS, and Step Functions metrics.
    • Refactored timer-related Lambda functions to expose them in the API for improved observability.
    • Enhanced state machine visibility by exporting Lambda references.

Checklist

  • Tests added or updated (if applicable)
  • Documentation updated
  • Code changes reviewed and approved
  • Existing functionality remains unaffected

- Introduce `JackInTheCloudDashboard` construct to enhance observability.
- Integrate Lambda metrics (invocations, errors, duration), DynamoDB, SNS, and Step Functions metrics into the dashboard.
- Refactor timer-related Lambda functions to expose them in the API.
- Update state machine and export Lambda references for better traceability.
- Expand README files for `jack-in-the-cloud`, `jimmy-the-deckhand`, and their submodules.
- Add installation, usage examples, and integration guidelines.
- Provide detailed explanations for architecture, services, and utilities.
- Include environment variable expectations and local development instructions.
- Update assets with new illustrative images for `jimmy-the-deckhand`.
@micro-jumbo micro-jumbo self-assigned this Aug 8, 2025
@micro-jumbo micro-jumbo changed the title (docs): Refine documentation and add CloudWatch dashboard (chore): Refine documentation and add CloudWatch dashboard Aug 8, 2025
@micro-jumbo micro-jumbo changed the title (chore): Refine documentation and add CloudWatch dashboard chore: Refine documentation and add CloudWatch dashboard Aug 8, 2025
- Replace `metricThrottledRequests` with `metricThrottledRequestsForOperations` for finer-grained monitoring.
- Clean up commented-out code and enable timer cancellation in examples.
- Disable CLI telemetry in `cdk.context.json`.
@micro-jumbo micro-jumbo merged commit 0d75476 into main Aug 8, 2025
6 checks passed
@micro-jumbo micro-jumbo deleted the docs branch August 8, 2025 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant