README
¶
cat-team-github-metrics
This project is a responsible for collecting various metrics from GitHub and injecting them in to BigQuery.
The mertrics are surfaced in our Grafana instance. For more information, reach out to the Content and Tooling team.
Build and release
Builds and releases are handled by goreleaser. For convenience when working locally use the provided Makefile.
Release steps
- Ensure that you are on the HEAD of the main branch.
- Create a new release prep branch (e.g maint_release_prep)
- Create a tag
make tag version=v.0.0.1. This will also push the tag to the remote. - The release workflow is triggered by new tags. It will publish a binary and a Docker image.
Working locally
Exporter
To use the exporter you'll need to be logged in to GCP with the gcloud cli and have the following environment variables exported in your current session.
export MODULE_OWNER=""
export MODULE_NAME=""
export GITHUB_TOKEN=xxxxxxxxxx
export BIG_QUERY_DATASET_ID="my_dataset"
Running the exporter in docker
You can run the exporter in a docker container. The BigQuery SDK will use the local credential file that is presented to the container.
make release
docker run \
-e MODULE_OWNER=$MODULE_OWNER \
-e MODULE_NAME=$MODULE_NAME \
-e GITHUB_TOKEN=$GITHUB_TOKEN \
-e BIG_QUERY_PROJECT_ID=$BIG_QUERY_PROJECT_ID \
-e GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/creds.json \
-v ~/.config/gcloud/application_default_credentials.json:/tmp/keys/creds.json \
ghcr.io/puppetlabs/cat-team-github-metrics
Grafana
This repository also comtains a local Grafana stack. It will be deployed with the BigQuery datasource which will need to be configured.
First create a new volume where we will store data:
docker volume create --name=grafana-data
Then move to the grafana directory and start the stack as follows:
cd grafana
docker-compose up
Your local stack will be accessible at http://localhost:9000
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd holds all of the entry points for the cobra app.
|
Package cmd holds all of the entry points for the cobra app. |
|
internal
|
|
|
bigqueryclient
Package bigqueryclient is responsible for interacting with the BigQuery API.
|
Package bigqueryclient is responsible for interacting with the BigQuery API. |
|
configuration
Package configuration contains a number of methods that are used to provide configuration to the wider application.
|
Package configuration contains a number of methods that are used to provide configuration to the wider application. |
|
export
Package export contains the logic for exporting GitHub metrics to BigQuery.
|
Package export contains the logic for exporting GitHub metrics to BigQuery. |
|
githubclient
Package githubclient is responsible for interacting with the GitHub API
|
Package githubclient is responsible for interacting with the GitHub API |
|
metrics
Package metrics contains methods that are responsible for mapping responses to metrics that can be sent to BigQuery.
|
Package metrics contains methods that are responsible for mapping responses to metrics that can be sent to BigQuery. |
|
stamp
Package stamp is respnsible for stamping the last run time to BigQuery.
|
Package stamp is respnsible for stamping the last run time to BigQuery. |