https://github.com/mariano-tp/github-observability-demo

Prometheus + Grafana + exporter para métricas de GitHub. CI con GitHub Actions.
https://github.com/mariano-tp/github-observability-demo

devops docker-compose github-actions grafana observability portfolio prometheus sre

Last synced: about 1 month ago
JSON representation

Prometheus + Grafana + exporter para métricas de GitHub. CI con GitHub Actions.

• Host: GitHub
• URL: https://github.com/mariano-tp/github-observability-demo
• Owner: mariano-tp
• License: mit
• Created: 2025-08-24T10:04:25.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-09-09T16:45:53.000Z (about 2 months ago)
• Last Synced: 2025-09-09T19:57:05.059Z (about 2 months ago)
• Topics: devops, docker-compose, github-actions, grafana, observability, portfolio, prometheus, sre
• Homepage:
• Size: 1.37 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![CI: compose-validate](https://img.shields.io/github/actions/workflow/status/mariano-tp/github-observability-demo/compose-validate.yml?branch=main&label=compose-validate&style=flat-square)](https://github.com/mariano-tp/github-observability-demo/actions/workflows/compose-validate.yml)

[![CI: link-check](https://img.shields.io/github/actions/workflow/status/mariano-tp/github-observability-demo/link-check.yml?branch=main&label=link-check&style=flat-square)](https://github.com/mariano-tp/github-observability-demo/actions/workflows/link-check.yml)

[![last commit](https://img.shields.io/github/last-commit/mariano-tp/github-observability-demo?style=flat-square)](https://github.com/mariano-tp/github-observability-demo/commits/main)

[![release](https://img.shields.io/github/v/release/mariano-tp/github-observability-demo?display_name=tag&style=flat-square)](https://github.com/mariano-tp/github-observability-demo/releases)

[![license: MIT](https://img.shields.io/badge/license-MIT-green?style=flat-square)](./LICENSE)

[![stars](https://img.shields.io/github/stars/mariano-tp/github-observability-demo?style=flat-square)](https://github.com/mariano-tp/github-observability-demo/stargazers)

# GitHub Observability Demo

Demo de observabilidad para métricas de **GitHub** usando **Prometheus + Grafana + github-exporter**.  

Pensado para mostrar prácticas de **observabilidad** y **CI en GitHub Actions**, sin instalar nada en el PC.

> Basado en trabajo de la comunidad (github-monitoring). Este fork se usa con fines educativos.

## ¿Qué incluye?

- **Prometheus** scrapea métricas del exporter de GitHub.

- **Grafana** con dashboard de estadísticas (stars, forks, issues) de repos de ejemplo.

- **CI**: workflow `compose-validate` que valida `docker-compose.yml` en cada push/PR.

## Estructura

```

.

├─ grafana/          # dashboards y provisión

├─ prometheus/       # configuración de Prometheus

├─ images/           # capturas usadas en este README

├─ docker-compose.yml

└─ config.monitoring # variables de ejemplo (REPOS, etc.)

```

## Cómo corre (opcional)

No es necesario para revisar el código ni el CI.  

Si alguien quiere ejecutarlo localmente con Docker Compose:

1. Crear un **Personal Access Token** de GitHub (PAT) con alcance `public_repo` (o `repo` si hay privados).

2. Definir variables:

   - `REPOS` (coma-separado, p. ej. `freeCodeCamp/freeCodeCamp,docker/docker`)

   - `GITHUB_TOKEN` (tu PAT)

3. Levantar:

```bash

docker compose up -d

```

- Grafana: `http://localhost:3000` (usuario `admin`, contraseña definida en `config.monitoring`)  

- Prometheus: `http://localhost:9090`

## Capturas

**Dashboard**  

![Dashboard](images/dashboard.png)

**Token de GitHub (PAT)**  

![PAT](images/github_token.png)

**Datasource en Grafana**  

![Datasource](images/Grafana_Add_Data_Source.png)

**Importar dashboard**  

![Import](images/Import_Dashboard.png)

## CI (GitHub Actions)

Este repositorio ejecuta automáticamente:

- `docker compose -f docker-compose.yml config` → valida sintaxis y referencias.

## Créditos

Stack original de la comunidad (github-monitoring) + ajustes de presentación y CI por @mariano-tp.

Ver también: [Código de Conducta](./CODE_OF_CONDUCT.md) · [Contribuir](./CONTRIBUTING.md) · [Seguridad](./SECURITY.md)