github-ci-monitor

README

github-ci-monitor

Check GitHub repositories CI statues and send them to DataDog.

Overview

When we merge pull requests, sometimes CI/CD fails. Then we want to find the failure.

By running this tool periodically, we can monitor the status by DataDog.

This tool gets GitHub repositories CI statues (commit status and Check API) and sends the result by DataDog API.

Running on AWS Lambda

Architecture

1. Run a Lambda Function periodically with Amazon CloudWatch Events.
2. In a Lambda Function, get repositories statuses by GitHub API
3. Send service checks by DataDog API
4. Configure DataDog Monitor and send alerts from DataDog to Slack

How to setup

We publish github-ci-monitor at AWS Serverless Application Repository.

• Create AWS Secrets Manager's secret
• Deploy the Lambda Function with AWS SAM
  • Example of SAM template

Configuration

• Lambda's environment variables
• AWS Secrets Manager's secret

Lambda's environment variables

• CONFIG: YAML

---
repos:
- owner: suzuki-shunsuke
  repo: test-github-action
  ref: master
  status: true
  check_run: true
  check_suite: true
  tags:
    codeowner: sre
region: ap-northeast-1
secret_id: github-ci-monitor
check_name: ci.ok
tags:
  sender: github-ci-monitor

AWS Secrets Manager's secret

• datadog_api_key
• github_token

How to create the DataDog Monitor

New Monitor > Custom Check

• Select a check: ci.ok

LICENSE

MIT