Available languages / Idiomas disponibles: English / Español

Back to repository: Home

GitHub Observability Demo

Observability demo for GitHub repository metrics using Prometheus + Grafana + GitHub exporter.

Designed to showcase observability practices and CI in GitHub Actions. Reviewing the project does not require running anything locally.

This repository is based on community work (github-monitoring) and is used for educational/portfolio purposes.

What gets validated in CI (GitHub Actions)

• compose-validate (compose-validate.yml)

  • Validates docker-compose.yml using docker compose config

• link-check (link-check.yml)

  • Validates README links (basic documentation quality gate)

Evidence: workflow logs in Actions.

What’s included

• Prometheus scrapes metrics from the GitHub exporter
• Grafana provides dashboards for repository statistics (stars, forks, issues) for a list of sample repos
• Docker Compose stack with ready-to-use configuration

Structure

.
├─ grafana/          # Dashboards and provisioning
├─ prometheus/       # Prometheus configuration
├─ images/           # Screenshots used in this README
├─ docker-compose.yml
└─ config.monitoring # Example variables (REPOS, etc.)

Optional local run (not required for evaluation)

Running locally is not required to review the code or CI.

If you want to execute it with Docker Compose:

1. Create a GitHub Personal Access Token (PAT) with public repo access (or repo if private)

2. Define environment variables:

   • REPOS (comma-separated), e.g. freeCodeCamp/freeCodeCamp,docker/docker
   • GITHUB_TOKEN (your PAT)

3. Launch:

   docker compose up -d

Grafana: http://localhost:3000 (user admin, password defined in config.monitoring) Prometheus: http://localhost:9090

Screenshots

Dashboard

GitHub Token (PAT)

Datasource in Grafana

Import dashboard

Credits

Original stack from the community (github-monitoring) with CI and documentation adjustments by @metorresponce.

See also: Code of Conduct · Contributing · Security