logguardian

README

LogGuardian - AWS CloudWatch Log Compliance Automation

Enterprise-grade automation for CloudWatch log group encryption, retention, and compliance monitoring

What LogGuardian Does

LogGuardian automatically ensures your AWS CloudWatch log groups meet enterprise compliance standards:

• Encryption: Enforces KMS encryption on all log groups
• Retention: Sets appropriate log retention policies
• Compliance: Continuous monitoring via AWS Config rules
• Automation: Zero-touch remediation and reporting

Quick Deploy

Docker Container (New!)

Quick Start:

# Pull and run the container
docker pull ghcr.io/zsoftly/logguardian:latest

# Run in dry-run mode to preview changes
docker run --rm \
  -e AWS_REGION=ca-central-1 \
  -e CONFIG_RULE_NAME=your-config-rule \
  -e DRY_RUN=true \
  ghcr.io/zsoftly/logguardian:latest

See Docker Usage Guide for authentication options and detailed instructions.

AWS Serverless Application Repository

AWS Console:

1. Click "Deploy" button above
2. Configure parameters as needed
3. Deploy to your AWS account

AWS CLI:

# Get the application (using latest version)
aws serverlessrepo create-cloud-formation-template \
  --application-id arn:aws:serverlessrepo:ca-central-1:410129828371:applications/LogGuardian \
  --region ca-central-1

# Deploy the template
aws cloudformation deploy \
  --template-file template.yaml \
  --stack-name logguardian \
  --capabilities CAPABILITY_NAMED_IAM

Manual Deployment

# Clone the repository
git clone https://github.com/zsoftly/logguardian.git
cd logguardian

# Build and package Lambda
make build && make package

# Deploy using AWS SAM
make sam-deploy-dev

Key Features

• Flexible Infrastructure: Works with new or existing AWS Config, KMS keys, and rules
• Automated Scheduling: EventBridge-based compliance checks
• Enterprise Ready: Supports existing infrastructure and custom policies
• Multi-Region: Deploy across multiple AWS regions
• Monitoring: CloudWatch metrics and dashboards
• Container Support: Run as Docker container or AWS Lambda function

� Documentation & Support

📚 Comprehensive Documentation:

• Problem Statement & Solution - Detailed problem analysis and solution overview
• Architecture Overview - System design and visual diagrams showing how LogGuardian works
• Docker Usage Guide - Running LogGuardian as a Docker container
• Configuration Parameters - Complete parameter guide with enterprise examples
• Deployment Examples - AWS CLI, CloudFormation, and Terraform examples
• Lambda Implementation - Lambda function implementation details
• Config Rule Evaluation - Batch processing and compliance analysis
• KMS Encryption Validation - KMS key validation and cross-region support
• Local Testing - Comprehensive local Lambda testing with 9+ test scenarios
• Development Guide - Development setup and guidelines
• 🚀 Complete Deployment Guide - Full deployment instructions

🆘 Support:

• Report Issues
• Discussions

Contributing

We welcome contributions! Please see our Development Guide for details.

# Clone and setup
git clone https://github.com/zsoftly/logguardian.git
cd logguardian

# Install dependencies and run tests
make test

Professional Services

Need help with enterprise deployment? ZSoftly Technologies Inc provides professional AWS consulting services.

🌐 ZSoftly Cloud Services

📞 Contact Information:

• Phone: +1 (343) 503-0513
• Email: info@zsoftly.com
• Address: 116 Albert Street, Suite 300, Ottawa, Ontario K1P 5G3
• Business Hours: Mon–Fri: 6 AM–10 PM EST
• Book Online Consultation

License

MIT License - see the LICENSE file for details.

---

Built by ZSoftly Technologies Inc | Made in Canada | Professional Services