Introduction

This is a modified version of the spring-petclinic-microservices Spring Boot sample application. Our modifications focus on showcasing the capabilities of Application Signals within a Spring Boot environment. If your interest lies in exploring the broader aspects of the Spring Boot stack, we recommend visiting the original repository at spring-petclinic-microservices.

In the following, we will focus on how customers can set up the current sample application to explore the features of Application Signals.

Disclaimer

This code for sample application is intended for demonstration purposes only. It should not be used in a production environment or in any setting where reliability/security is a concern.

Prerequisite

Option 1: Using AWS CodeBuild (Recommended - No Local Setup Required)

• AWS CLI 2.x is installed. For more information about installing the AWS CLI, see Install or update the latest version of the AWS CLI.
• AWS CDK >= v2.1024.0 is installed - https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install
• Node.js >= v18.0.0 is installed.

Option 2: Local Build Environment

• A Linux machine with x86-64 (AMD64) architecture is required for building Docker images for the sample application.
• Docker is installed and running on the machine.
• AWS CLI 2.x is installed. For more information about installing the AWS CLI, see Install or update the latest version of the AWS CLI.
• Golang is installed.

Additional Prerequisites for Deployment

• kubectl is installed - https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html
• eksctl is installed - https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html
• jq is installed - https://jqlang.github.io/jq/download/
• AWS CDK >= v2.1024.0 is installed - https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install
• Node.js >= v18.0.0 is installed.
• Golang is installed.
• [Optional] If you plan to install the infrastructure resources using Terraform, terraform cli is required. https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli
• [Optional] If you want to try out AWS Bedrock/GenAI support with Application Signals, enable Amazon Titian, Anthropic Claude, Meta Llama foundation models by following the instructions in https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html

EKS demo

Deploy via Shell Scripts

Note that if you want to run the scripts in a shell inside an AWS Cloud9 environment, you need to ensure the environment has sufficient disk space, as building images can consume a lot of space. To increase the disk size to 50 GB, follow the instructions here: Resize Cloud9 Environment. Additionally, you need to disable AWS managed temporary credentials to avoid credential renewal interfering with script execution. Instructions can be found here: Disable AWS managed temporary credentials.

Build the sample application images and push to ECR

Option 1: Using AWS CodeBuild (Recommended - No Local Build Environment Required)

AWS CodeBuild eliminates the need for local Docker and build tools. The build process runs entirely in AWS.

1. Deploy the CodeBuild infrastructure. Replace region-name with your desired AWS region (e.g., us-east-1):

cd cdk/codebuild
npm install
export AWS_REGION=region-name  # Set your desired region
cdk bootstrap  # First time only - bootstraps CDK in the specified region
cdk deploy     # Deploys the CodeBuild stack to the specified region

To clean up the CodeBuild infrastructure when no longer needed:

cd cdk/codebuild
export AWS_REGION=region-name  # Use the same region where you deployed
cdk destroy

This will remove the CodeBuild project, S3 bucket, IAM roles, and CloudWatch logs. Note: ECR repositories with Docker images are not deleted automatically.

2. Trigger a build to create and push all images to ECR. Replace region-name with the region you choose (e.g. us-east-1)

./scripts/trigger-build.sh --region=region-name 

For more details, see the CodeBuild README.

Option 2: Local Build

1. Build container images for each micro-service application

./mvnw clean install -P buildDocker

2. Create an ECR repo for each micro service and push the images to the relevant repos. Replace the aws account id and the AWS Region.

export ACCOUNT=`aws sts get-caller-identity | jq .Account -r`
export REGION='us-east-1'
./push-ecr.sh

Try Application Signals with the sample application

1. Set up a EKS cluster and deploy sample app. Replace region-name with the region you choose.

   cd scripts/eks/appsignals && ./setup-eks-demo.sh --region=region-name

2. Access the EKS cluster using kubectl to check pod status and logs:

   # Configure kubectl to use the EKS cluster
   aws eks update-kubeconfig --name eks-pet-clinic-demo --region <your-region> --role-arn arn:aws:iam::<your-account>:role/PetClinicEksClusterRole
   
   # View the microservices pods
   kubectl get pods -n pet-clinic
   
   # Get the ingress URL
   kubectl get svc -n ingress-nginx | grep "ingress-nginx" | awk '{print $4}'

3. Clean up after you are done with the sample app. Replace region-name with the same value that you use in previous step.

   cd scripts/eks/appsignals/ && ./setup-eks-demo.sh --operation=delete --region=region-name
   

Please be aware that this sample application includes a publicly accessible Application Load Balancer (ALB), enabling easy interaction with the application. If you perceive this public ALB as a security risk, consider restricting access by employing security groups.

EC2 Demo

The following instructions describe how to set up the pet clinic sample application on EC2 instances. You can run these steps in your personal AWS account to follow along (Not recommended for production usage).

1. Create resources and deploy sample app. Replace region-name with the region you choose.

   cd scripts/ec2/appsignals/ && ./setup-ec2-demo.sh --region=region-name
   

2. Clean up after you are done with the sample app. Replace region-name with the same value that you use in previous step.

   cd scripts/ec2/appsignals/ && ./setup-ec2-demo.sh --operation=delete --region=region-name
   

K8s Demo

The following instructions set up an kubernetes cluster on 2 EC2 instances (one master and one worker node) with kubeadmin and deploy the pet clinic sample application to the cluster. You can run these steps in your personal AWS account to follow along (Not recommended for production usage).

1. Build container images and push them to public ECR repo

   ./mvnw clean install -P buildDocker && ./push-public-ecr.sh

2. Set up a kubernetes cluster and deploy sample app. Replace region-name with the region you choose.

   cd scripts/k8s/appsignals/ && ./setup-k8s-demo.sh --region=region-name

3. Clean up after you are done with the sample app. Replace region-name with the same value that you use in previous step.

   cd scripts/k8s/appsignals/ && ./setup-k8s-demo.sh --operation=delete --region=region-name
   
   
   

ECS Demo

The following instructions set up an ECS cluster with all services running in Fargate. You can run these steps in your personal AWS account to follow along (Not recommended for production usage).

1. Build container images and push them to private ECR repo. Replace region-name with the region you choose.

   export ACCOUNT=`aws sts get-caller-identity | jq .Account -r`
   export REGION=region-name

   ./mvnw clean install -P buildDocker && ./push-ecr.sh

2. Set up a ECS cluster and deploy sample app. Replace region-name with the region you choose.

   cd scripts/ecs/appsignals && ./setup-ecs-demo.sh --region=region-name

3. Clean up after you are done with the sample app. Replace region-name with the same value that you use in previous step.

   cd scripts/ecs/appsignals/ && ./setup-ecs-demo.sh --operation=delete --region=region-name