Files
LogWhispererAI/CHANGELOG.md
Luca Sacchi Ricciardi 88cfe9af50 docs: update all documentation for Sprint 1 completion
- Update README.md with badges, project status, and improved structure
- Update CHANGELOG.md with Project Review Sprint 1 and version 0.1.1
- Update PRD status to reflect Sprint 1 completion
- Update ingestion script spec status to Completed with review link
- Update Sprint 1 verification report with Project Review reference
- Add comprehensive Sprint 1 Project Review document

Refs: Project Review conducted by agent staff (Product Manager, Tech Lead, Security Auditor)
2026-04-02 17:25:29 +02:00

89 lines
3.2 KiB
Markdown

# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Common Changelog](https://common-changelog.org/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- docs: Project Review Sprint 1 with agent staff analysis
- Product Manager UVP alignment assessment
- Tech Lead architecture coherence review
- Security Auditor risk analysis
- Sprint 1 review document in `docs/reviews/s`
### Changed
- docs: Updated README.md with project status badges and improved structure
- docs: Updated PRD status to reflect Sprint 1 completion
- docs: Updated ingestion script spec status to "Completed"
- docs: Updated Sprint 1 verification report with Project Review reference
## [0.1.1] - 2026-04-02
### Added
- docs: Project Review Sprint 1 complete analysis
- Product Manager review: UVP alignment (7.05/10)
- Tech Lead review: Architecture assessment (7.5/10)
- Security Auditor review: Risk analysis (5.75/10)
- Comprehensive recommendations for Sprint 2
### Changed
- docs: Major README.md refactoring with badges and improved navigation
- docs: Updated all sprint documentation to "Completed" status
## [0.1.0] - 2026-04-02
### Added
- feat: Implement log ingestion script (`logwhisperer.sh`) for monitoring system logs
- Monitor multiple log sources: syslog, nginx, postgresql
- Pattern matching for critical errors (FATAL, ERROR, OOM, segfault, disk full)
- JSON payload generation with severity levels (low, medium, critical)
- Rate limiting to prevent alert flooding (30s per source/pattern)
- Offset tracking for each log file to avoid reprocessing
- HTTP POST dispatch to configurable webhook with retry logic
- Dry-run mode for testing pattern matching without sending webhooks
- Configuration file support (`/etc/logwhisperer/config.env`)
- Command-line flags: `--help`, `--validate`, `--config`, `--dry-run`, `--test-line`
- feat: Create installation script (`install.sh`)
- Interactive configuration wizard
- UUID v4 generation for CLIENT_ID
- Systemd service creation (when run as root)
- Support for both system-wide and user-local installation
- Prerequisite checking (bash, curl)
- Connectivity test to webhook URL
- test: Add comprehensive test suite (`tests/test_logwhisperer.py`)
- Script existence and executable validation
- Configuration validation tests
- Pattern matching tests (FATAL, OOM, ERROR patterns)
- JSON payload structure validation
- Severity mapping verification
- docs: Create technical specification for Feature 1 (Log Ingestion)
- Architecture diagram and component description
- Requirements (functional and non-functional)
- Safety guidelines (Metodo Sacchi)
- Acceptance criteria
- docs: Create Sprint 1 verification report (`docs/sprint1_verification.md`)
- Complete verification of all Sprint 1 deliverables
- Test results summary (12/12 tests passed)
- Acceptance criteria checklist
- Security audit results
- Code quality assessment
### Security
- Configuration files created with restrictive permissions (600)
- No hardcoded credentials in scripts
- HTTPS validation for webhook URLs (warning for non-HTTPS)
- Read-only access to log files (no modifications)