https://github.com/douglasppa/observa-kit

Ready-to-run observability starter (Prometheus/Alertmanager/Grafana + FastAPI RED demo). Includes dashboards, demo/prod alert rules, and SLO/Runbook templates for fast pilots.
https://github.com/douglasppa/observa-kit

alertmanager grafana metrics observability prometheus runbook slo

Last synced: 19 days ago
JSON representation

Ready-to-run observability starter (Prometheus/Alertmanager/Grafana + FastAPI RED demo). Includes dashboards, demo/prod alert rules, and SLO/Runbook templates for fast pilots.

• Host: GitHub
• URL: https://github.com/douglasppa/observa-kit
• Owner: douglasppa
• License: apache-2.0
• Created: 2025-08-20T13:05:48.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2025-08-20T13:46:39.000Z (about 2 months ago)
• Last Synced: 2025-08-20T15:33:14.012Z (about 2 months ago)
• Topics: alertmanager, grafana, metrics, observability, prometheus, runbook, slo
• Language: Python
• Homepage:
• Size: 284 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Observa Kit

[![Made with FastAPI](https://img.shields.io/badge/FastAPI-✅-informational)](#) [![Prometheus](https://img.shields.io/badge/Prometheus-ready-orange)](#) [![Grafana](https://img.shields.io/badge/Grafana-provisioned-blue)](#) [![Docker Compose](https://img.shields.io/badge/Docker%20Compose-ok-2496ED)](#) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-green)](#license) [![Template Repo](https://img.shields.io/badge/GitHub-Template%20Repo-181717)](#)

> Plug-and-play observability starter (Prometheus, Alertmanager, Grafana + FastAPI RED demo). Provisioned dashboards, demo/prod alert rules, and SLO/Runbook templates — ideal for quick pilots and SMB handoffs.

---

## Pre-requirements

- Docker e Docker Compose installed.

## How to run

```bash

docker compose up -d

# Grafana: http://localhost:3000  (admin / admin)

# Prometheus: http://localhost:9090

# App (docs): http://localhost:8000/docs

```

## Test alerts (another terminal)

```bash

# Activate alerts with demo config

make demo

# Activate alerts with prod config

make prod

# Generate requests

while true; do for i in {1..20}; do curl -s http://localhost:8000/checkout >/dev/null & done; wait; sleep 0.5; done

# Simulate 5xx errors for 2 minutes

curl "http://localhost:8000/simulate/error?minutes=2"

# Simulate slowness for 2 minutes

curl "http://localhost:8000/simulate/slow?minutes=2"

```

## What’s included

- FastAPI app with Prometheus metrics and incident simulation.

- Prometheus with alert rules (error%, p95, throughput).

- Alertmanager sending webhooks to the app itself (/alerts).

- Grafana provisioned with a datasource and the “Observa – Service Health” dashboard.

- Templates: Runbook, SLO, One-pager, Proposal/SOW, NDA, Acceptance checklist.

## Next steps

- Adjust thresholds (e.g., p95 800 ms → your reality).

- Replace the demo app with the client’s endpoints (Micrometer/prom-client/etc.).

- (Optional) Add exporters (postgres_exporter, node_exporter, etc.).

---

## Screenshots

**Dashboard – Health (RED)**

![Grafana Dashboard](docs/images/healthy.png)

**Low throughput issue**

![Low Throughput](docs/images/low_throughput.png)

**High error rate issue**

![Low Throughput](docs/images/high_error_rate.png)

**High latency issue**

![Low Throughput](docs/images/high_latency.png)