Skip to content

GitHub Copilot Usage Dashboard

Overview

This project contains an AWS Lambda Function which updates the GitHub Copilot dashboard's historic information, stored within an S3 bucket.

The Copilot dashboard can be found on the Copilot tab within the Digital Landscape. Its repository can be found here.

Techstack Overview

Architecture Overview

Architecture Diagram

This project uses 2 major components:

  • The Lambda Function
  • The GitHub API Toolkit (stored in another repository - Repository Link)

The Lambda Function

This component updates the dashboard's historic information, stored within an S3 bucket. The lambda imports the GitHub API Toolkit to get the API response containing the usage information. The script then adds any new data to the existing historic data within the S3 bucket.

The GitHub API Toolkit

This component is an imported library which is shared across multiple GitHub tools. The toolkit allows applications to make authenticated requests to the GitHub API. It is imported and used by both the dashboard and lambda function.

High Level Data Overview

Endpoint

The Copilot usage data endpoint can be found here.

Historic Data

This section gathers data from AWS S3. The Copilot usage endpoints have a limitation where they only return the last 28 days worth of information. To get around this, the project has an AWS Lambda function which runs weekly and stores data within an S3 bucket.

Getting Started

To setup and use the project, please refer to the README.