one-observability-demo

About one-observability-demo

Sample microservice based application demonstrating observability capabilities on AWS

a

Published by

aws-samples

Visit View Profile

README.md

View on GitHub

One Observability Demo

This repo contains a sample application which is used in the One Observability Demo workshop here - https://observability.workshop.aws/

Documentation

Full documentation is published at the GitHub Pages site.

Guides

Guide	Description
Architecture Overview	System architecture, microservices, pipeline stages, and observability design
Deployment Template	CodeBuild CDK deployment parameters and advanced usage
Cleanup Script	Post-workshop resource cleanup instructions and troubleshooting
CDK Cleanup	CDK-specific stack teardown procedures
Seeding Guide	Database and application seeding instructions
Image Generation	Pet food image generation setup
Application Redeployment	How to redeploy individual microservices
CodeConnection Setup	GitHub CodeConnection and Parameter Store integration
ECS Port Forwarding	Local access to ECS services via port forwarding

API Reference

The CDK construct library API reference is available at the API Reference page, or browse the source under src/cdk/lib/.

Security

See CONTRIBUTING for more information.

Deployment Instructions

Prerequisites

IAM role with elevated privileges
AWS CLI installed and configured
Appropriate AWS permissions for CloudFormation, CodeBuild, and related services

CloudFormation Templates

This repository provides CloudFormation templates for automated deployment:

codebuild-deployment-template.yaml - CodeBuild CDK deployment template with intelligent retry handling

Quick Start

Deploy the workshop using the CodeBuild CDK deployment template:

aws cloudformation create-stack \
  --stack-name OneObservability-Workshop-CDK \
  --template-body file://src/templates/codebuild-deployment-template.yaml \
  --capabilities CAPABILITY_NAMED_IAM \
  --parameters \
    ParameterKey=pOrganizationName,ParameterValue=aws-samples \
    ParameterKey=pRepositoryName,ParameterValue=one-observability-demo \
    ParameterKey=pBranchName,ParameterValue=main \
    ParameterKey=pWorkingFolder,ParameterValue=src/cdk

For detailed parameter descriptions and advanced usage, refer to the full documentation.

Cleanup

After completing the workshop, clean up your AWS resources to avoid ongoing charges.

For comprehensive cleanup instructions, troubleshooting, and safety guidelines, see:

🧹 Cleanup Script Documentation

License

This library is licensed under the MIT-0 License. See the LICENSE file.