Scheduled Health Checker

Tip

To deploy this project using GUI-based flow, navigate to console

Uptime monitoring service with scheduled health checks.
A Lambda runs every 5 minutes to check all monitored URLs, recording status, latency, and response codes in DynamoDB.
Manage monitors and view check history via the REST API.
This project includes a pre-configured stacktape.yml configuration. The configured infrastructure is described in the stack description section

Prerequisites

AWS account. If you don't have one, create new account here.
Stacktape account. If you don't have one, create new account here.
Stacktape installed.

Install on Windows (Powershell)

iwr https://installs.stacktape.com/windows.ps1 -useb | iex

Install on Linux

curl -L https://installs.stacktape.com/linux.sh | sh

Install on MacOS

curl -L https://installs.stacktape.com/macos.sh | sh

Install on MacOS ARM (Apple silicon)

curl -L https://installs.stacktape.com/macos-arm.sh | sh

1. Generate your project

To initialize the project, use

stacktape init --starterId scheduled-health-checker

2. Deploy your stack

The deployment will take ~5-15 minutes. Subsequent deploys will be significantly faster.

Deploy from local machine

The deployment from local machine will build and deploy the application from your system. This means you also need to have:

Docker. To install Docker on your system, you can follow this guide.- Node.js installed.

To perform the deployment, use the following command:

stacktape deploy --projectName <<project-name>> --stage <<stage>> --region <<region>>

stage is an arbitrary name of your environment (for example staging, production or dev-john)

region is the AWS region, where your stack will be deployed to. All the available regions are listed below.

projectName is the name of your project. You can create it in the console or interactively using CLI.

Region name & Location	code
Europe (Ireland)	eu-west-1
Europe (London)	eu-west-2
Europe (Frankfurt)	eu-central-1
Europe (Milan)	eu-south-1
Europe (Paris)	eu-west-3
Europe (Stockholm)	eu-north-1
US East (Ohio)	us-east-2
US East (N. Virginia)	us-east-1
US West (N. California)	us-west-1
US West (Oregon)	us-west-2
Canada (Central)	ca-central-1
Africa (Cape Town)	af-south-1
Asia Pacific (Hong Kong)	ap-east-1
Asia Pacific (Mumbai)	ap-south-1
Asia Pacific (Osaka-Local)	ap-northeast-3
Asia Pacific (Seoul)	ap-northeast-2
Asia Pacific (Singapore)	ap-southeast-1
Asia Pacific (Sydney)	ap-southeast-2
Asia Pacific (Tokyo)	ap-northeast-1
China (Beijing)	cn-north-1
China (Ningxia)	cn-northwest-1
Middle East (Bahrain)	me-south-1
South America (São Paulo)	sa-east-1

Deploy using AWS CodeBuild pipeline

Deployment using AWS CodeBuild will build and deploy your application inside AWS CodeBuild pipeline. To perform the deployment, use

stacktape codebuild:deploy --stage <<stage>> --region <<region>> --projectName <<project-name>>

stage is an arbitrary name of your environment (for example staging, production or dev-john)

region is the AWS region, where your stack will be deployed to. All the available regions are listed below.

projectName is the name of your project. You can create it in the console or interactively using CLI.

Region name & Location	code
Europe (Ireland)	eu-west-1
Europe (London)	eu-west-2
Europe (Frankfurt)	eu-central-1
Europe (Milan)	eu-south-1
Europe (Paris)	eu-west-3
Europe (Stockholm)	eu-north-1
US East (Ohio)	us-east-2
US East (N. Virginia)	us-east-1
US West (N. California)	us-west-1
US West (Oregon)	us-west-2
Canada (Central)	ca-central-1
Africa (Cape Town)	af-south-1
Asia Pacific (Hong Kong)	ap-east-1
Asia Pacific (Mumbai)	ap-south-1
Asia Pacific (Osaka-Local)	ap-northeast-3
Asia Pacific (Seoul)	ap-northeast-2
Asia Pacific (Singapore)	ap-southeast-1
Asia Pacific (Sydney)	ap-southeast-2
Asia Pacific (Tokyo)	ap-northeast-1
China (Beijing)	cn-north-1
China (Ningxia)	cn-northwest-1
Middle East (Bahrain)	me-south-1
South America (São Paulo)	sa-east-1

Deploy using Github actions CI/CD pipeline

If you don't have one, create a new repository at https://github.com/new
Create Github repository secrets: https://docs.stacktape.com/user-guides/ci-cd/#2-create-github-repository-secrets
Replace <<stage>> and <<region>> in the .github/workflows/deploy.yml file.
git init --initial-branch=main
git add .
git commit -m "setup stacktape project"
git remote add origin git@github.com:<<namespace-name>>/<<repo-name>>.git
git push -u origin main
To monitor the deployment progress, navigate to your github project and select the Actions tab

stage is an arbitrary name of your environment (for example staging, production or dev-john)

region is the AWS region, where your stack will be deployed to. All the available regions are listed below.

projectName is the name of your project. You can create it in the console or interactively using CLI.

Region name & Location	code
Europe (Ireland)	eu-west-1
Europe (London)	eu-west-2
Europe (Frankfurt)	eu-central-1
Europe (Milan)	eu-south-1
Europe (Paris)	eu-west-3
Europe (Stockholm)	eu-north-1
US East (Ohio)	us-east-2
US East (N. Virginia)	us-east-1
US West (N. California)	us-west-1
US West (Oregon)	us-west-2
Canada (Central)	ca-central-1
Africa (Cape Town)	af-south-1
Asia Pacific (Hong Kong)	ap-east-1
Asia Pacific (Mumbai)	ap-south-1
Asia Pacific (Osaka-Local)	ap-northeast-3
Asia Pacific (Seoul)	ap-northeast-2
Asia Pacific (Singapore)	ap-southeast-1
Asia Pacific (Sydney)	ap-southeast-2
Asia Pacific (Tokyo)	ap-northeast-1
China (Beijing)	cn-north-1
China (Ningxia)	cn-northwest-1
Middle East (Bahrain)	me-south-1
South America (São Paulo)	sa-east-1

Deploy using Gitlab CI pipeline

If you don't have one, create a new repository at https://gitlab.com/projects/new
Create Gitlab repository secrets: https://docs.stacktape.com/user-guides/ci-cd/#2-create-gitlab-repository-secrets
replace <<stage>> and <<region>> in the .gitlab-ci.yml file.
git init --initial-branch=main
git add .
git commit -m "setup stacktape project"
git remote add origin git@gitlab.com:<<namespace-name>>/<<repo-name>>.git
git push -u origin main
To monitor the deployment progress, navigate to your gitlab project and select CI/CD->jobs

stage is an arbitrary name of your environment (for example staging, production or dev-john)

region is the AWS region, where your stack will be deployed to. All the available regions are listed below.

projectName is the name of your project. You can create it in the console or interactively using CLI.

Region name & Location	code
Europe (Ireland)	eu-west-1
Europe (London)	eu-west-2
Europe (Frankfurt)	eu-central-1
Europe (Milan)	eu-south-1
Europe (Paris)	eu-west-3
Europe (Stockholm)	eu-north-1
US East (Ohio)	us-east-2
US East (N. Virginia)	us-east-1
US West (N. California)	us-west-1
US West (Oregon)	us-west-2
Canada (Central)	ca-central-1
Africa (Cape Town)	af-south-1
Asia Pacific (Hong Kong)	ap-east-1
Asia Pacific (Mumbai)	ap-south-1
Asia Pacific (Osaka-Local)	ap-northeast-3
Asia Pacific (Seoul)	ap-northeast-2
Asia Pacific (Singapore)	ap-southeast-1
Asia Pacific (Sydney)	ap-southeast-2
Asia Pacific (Tokyo)	ap-northeast-1
China (Beijing)	cn-north-1
China (Ningxia)	cn-northwest-1
Middle East (Bahrain)	me-south-1
South America (São Paulo)	sa-east-1

3. Test your application

After a successful deployment, some information about the stack will be printed to the terminal (URLs of the deployed services, links to logs, metrics, etc.).

Create a monitor:

curl -X POST <API_GATEWAY_URL>/monitors \
  -H "Content-Type: application/json" \
  -d '{"name": "Google", "url": "https://www.google.com"}'

List all monitors with their latest check results:
```
curl <API_GATEWAY_URL>/monitors
```
The health checker runs automatically every 5 minutes. Check back after a few minutes to see results.

4. Run the application in development mode

To run functions in the development mode (remotely on AWS), you can use the dev command. For example, to develop and debug lambda function checkHealth, you can use

stacktape dev --region <<your-region>> --stage <<stage>> --resourceName checkHealth

The command will:

quickly re-build and re-deploy your new function code
watch for the function logs and pretty-print them to the terminal

The function is rebuilt and redeployed, when you either:

type rs + enter to the terminal
use the --watch option and one of your source code files changes

5. Hotswap deploys

Stacktape deployments use AWS CloudFormation under the hood. It brings a lot of guarantees and convenience, but can be slow for certain use-cases.
To speed up the deployment, you can use the --hotSwap flag which avoids using Cloudformation.
Hotswap deployments work only for source code changes (for lambda function, containers and batch jobs) and for content uploads to buckets.
If the update deployment is not hot-swappable, Stacktape will automatically fall back to using a Cloudformation deployment.

stacktape deploy --hotSwap --stage <<stage>> --region <<region>> --projectName <<project-name>>

6. Delete your stack

If you no longer want to use your stack, you can delete it.
Stacktape will automatically delete every infrastructure resource and deployment artifact associated with your stack.

stacktape delete --stage <<stage>> --region <<region>>

Stack description

Stacktape uses a simple stacktape.yml configuration file to describe infrastructure resources, packaging, deployment pipeline and other aspects of your project.

You can deploy your project to multiple environments (stages) - for example production, staging or dev-john. A stack is a running instance of an project. It consists of your application code (if any) and the infrastructure resources required to run it.

The configuration for this project is described below.

1. Resources

Every resource must have an arbitrary, alphanumeric name (A-z0-9).
Stacktape resources consist of multiple underlying AWS or 3rd party resources.

1.1 HTTP API Gateway

API Gateway receives HTTP requests and routes them to the API function.

CORS is enabled for convenience.

resources:
  apiGateway:
    type: http-api-gateway
    properties:
      cors:
        enabled: true

1.2 DynamoDB Table

Stores monitor definitions and their check history. Each monitor record includes the URL to check, the current status, and the last 10 health check results.

monitorsTable:
  type: dynamo-db-table
  properties:
    primaryKey:
      partitionKey:
        name: id
        type: string

1.3 Health Check Function

Runs on a schedule (every 5 minutes). Scans all monitors from DynamoDB, sends an HTTP request to each URL, records the response status, latency, and status code, then updates the monitor with the latest results.

Timeout - 120 seconds to allow checking multiple URLs.
Schedule - rate(5 minutes) for regular health checks.

checkHealth:
  type: function
  properties:
    packaging:
      type: stacktape-lambda-buildpack
      properties:
        entryfilePath: ./src/check-health.ts
    memory: 512
    timeout: 120
    connectTo:
      - monitorsTable
    events:
      - type: schedule
        properties:
          scheduleRate: rate(5 minutes)

1.4 API Function

Hono-based HTTP API for managing monitors — create, list, get details, and delete. Each monitor includes its recent check history.

api:
  type: function
  properties:
    packaging:
      type: stacktape-lambda-buildpack
      properties:
        entryfilePath: ./src/index.ts
    memory: 512
    connectTo:
      - monitorsTable
    events:
      - type: http-api-gateway
        properties:
          httpApiGatewayName: apiGateway
          path: /
          method: '*'
      - type: http-api-gateway
        properties:
          httpApiGatewayName: apiGateway
          path: /{proxy+}
          method: '*'

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
src		src
.gitignore		.gitignore
README.md		README.md
package.json		package.json
stacktape.yml		stacktape.yml
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Scheduled Health Checker

Prerequisites

1. Generate your project

2. Deploy your stack

3. Test your application

4. Run the application in development mode

5. Hotswap deploys

6. Delete your stack

Stack description

1. Resources

1.1 HTTP API Gateway

1.2 DynamoDB Table

1.3 Health Check Function

1.4 API Function

About

Uh oh!

Releases

Packages

Uh oh!

Contributors

Uh oh!

Languages

stacktape/starter-scheduled-health-checker

Folders and files

Latest commit

History

Repository files navigation

Scheduled Health Checker

Prerequisites

1. Generate your project

2. Deploy your stack

3. Test your application

4. Run the application in development mode

5. Hotswap deploys

6. Delete your stack

Stack description

1. Resources

1.1 HTTP API Gateway

1.2 DynamoDB Table

1.3 Health Check Function

1.4 API Function

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages