Skip to content

Lab08#10

Open
pepegx wants to merge 31 commits intomasterfrom
lab08
Open

Lab08#10
pepegx wants to merge 31 commits intomasterfrom
lab08

Conversation

@pepegx
Copy link
Copy Markdown
Owner

@pepegx pepegx commented Mar 19, 2026

Summary

This PR completes Lab 08 by adding Prometheus-based application metrics, deploying a full metrics monitoring stack,
and documenting the implementation and validation results. It also includes the bonus Ansible automation for end-to-
end observability deployment.

What Changed

  • Added Prometheus instrumentation to the Python application
  • Exposed a /metrics endpoint
  • Added HTTP request metrics:
    • request counter
    • request duration histogram
    • in-progress requests gauge
  • Added application-specific metrics for endpoint calls and system info collection
  • Added Prometheus to the monitoring stack
  • Configured Prometheus to scrape:
    • the Python app
    • Prometheus itself
    • Loki
    • Grafana
  • Added Grafana Prometheus datasource provisioning
  • Added a custom Lab 08 metrics dashboard with 8 panels
  • Added production-oriented health checks, retention settings, resource limits, and persistent volumes
  • Added Lab 08 documentation and screenshots
  • Extended the Ansible monitoring role for the Lab 08 bonus:
    • Prometheus defaults and template
    • Grafana datasource provisioning
    • metrics dashboard provisioning
    • deployment verification and idempotency checks

Validation

  • docker compose --env-file .env.example config
  • Local stack started successfully and all 6 services became healthy
  • Prometheus up query returned all required targets as healthy
  • Grafana datasource provisioning was verified through the API
  • The Lab 08 dashboard was automatically provisioned
  • Persistence was verified after docker compose down and docker compose up -d
  • Python app validation:
    • pytest: 19 passed
    • coverage: 96.83%
    • ruff: passed
  • Ansible bonus validation:
    • syntax check passed
    • full deploy passed
    • second run was idempotent (changed=0)

Notes

  • Main documentation: monitoring/docs/LAB08.md
  • Bonus documentation: ansible/docs/LAB08.md

pepega and others added 30 commits January 28, 2026 13:08
- Implement Flask-based DevOps Info Service (Python)
- Add GET / endpoint with service, system, runtime, and request info
- Add GET /health endpoint for monitoring
- Implement environment variable configuration (HOST, PORT, DEBUG)
- Add comprehensive documentation (README.md and LAB01.md)
- Include best practices: PEP 8, error handling, logging
- Add GitHub Community engagement section
- Implement bonus task: Go version of the service
- Add testing screenshots and evidence
- Pin dependencies in requirements.txt
- Configure .gitignore for Python and Go
- Add pytest unit tests (15 tests covering all endpoints)
- Add GitHub Actions workflow with matrix testing (Python 3.11, 3.12)
- Add ruff linter integration
- Add Docker build/push with CalVer versioning
- Add status badge to README
- Add LAB03.md documentation

Best practices:
- Dependency caching via setup-python
- Docker layer caching via Buildx
- Job dependencies (docker needs lint-test)
- Fail-fast matrix strategy
- Concurrency with cancel-in-progress
- Path filters for monorepo efficiency
- Docker build always runs (validates Dockerfile)
- Docker push only when DOCKERHUB secrets are configured
- Graceful handling when secrets not available
- Add .github/workflows/go-ci.yml for Go application
- Language-specific linting with golangci-lint
- Go testing with race detector and coverage
- Snyk security scanning for Go dependencies
- Docker build and push with CalVer versioning
- Path-based triggers for monorepo optimization
- Separate Docker image: pepegx/devops-info-service-go
- Parallel execution with Python CI workflow
…i-app support

Completes all main tasks (10pts) and bonus tasks (2.5pts):

MAIN TASKS (10pts):
- Unit Testing (3pts): pytest framework, 15 tests, 80% coverage
- GitHub Actions CI (4pts): python-ci.yml with matrix build, linting, testing, Docker push
- CI Best Practices (3pts): status badge, caching, Snyk security scanning

BONUS (2.5pts):
- Multi-App CI: go-ci.yml with path-based triggers
- Test Coverage: codecov integration with XML reporting

All requirements verified locally and ready for GitHub Actions execution.
- Fix codecov action file path (app_python/coverage.xml)
- Add CODECOV_TOKEN secret to codecov action
- Fix Snyk actions with proper file paths for both Python and Go
- Add Go CI status badge to app_go/README.md
- Fix codecov badge URL in app_python/README.md (remove token param)

All Lab03 requirements verified:
- 15 unit tests passing with 80% coverage
- Matrix builds for Python 3.11/3.12
- Snyk security scanning configured
- CalVer versioning implemented
- Path filters for monorepo
- Add main_test.go with 12 comprehensive unit tests
- Test all endpoints: /, /health, 404 handler
- Test helper functions: getEnv, getUptime, getSystemInfo
- Test custom mux wrapper with subtests
- Update README with unit testing documentation
- Update LAB03.md with test details

Coverage: 67.2% of statements
- Add pyproject.toml with 70% coverage threshold
- Configure pytest-cov fail-under for CI enforcement
- Add codecov upload for Go workflow
- Update LAB03.md with new coverage stats (98%)
- Simplify pytest command to use pyproject.toml config

Coverage improvements:
- Python: 98% coverage with 70% threshold
- Go: 67.2% coverage with codecov integration
- Refactor main.go: extract setupRouter() and printStartupBanner()
- Add TestSetupRouter to test router configuration
- Add TestPrintStartupBanner to test startup output
- Add TestDebugMode to test handlers with debug=true
- Coverage increased from 67.2% to 87.3% (above 70% threshold)
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 96.82540% with 4 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
app_python/app.py 96.82% 4 Missing ⚠️

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants