Files
f2b/fail2ban/log_performance_optimized.go
Ismo Vuorinen 70d1cb70fd feat!: Go rewrite (#9)
* Go rewrite

* chore(cr): apply suggestions

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Ismo Vuorinen <ismo@ivuorinen.net>

* 📝 CodeRabbit Chat: Add NoOpClient to fail2ban and initialize when skip flag is true

* 📝 CodeRabbit Chat: Fix malformed if-else structure and add no-op client for skip-only commands

* 📝 CodeRabbit Chat: Fix malformed if-else structure and add no-op client for skip-only commands

* fix(main): correct no-op branch syntax (#10)

* chore(gitignore): ignore env and binary files (#11)

* chore(config): remove indent_size for go files (#12)

* feat(cli): inject version via ldflags (#13)

* fix(security): validate filter parameter to prevent path traversal (#15)

* chore(repo): anchor ignore for build artifacts (#16)

* chore(ci): use golangci-lint action (#17)

* feat(fail2ban): expose GetLogDir (#19)

* test(cmd): improve IP mock validation (#20)

* chore(ci): update golanglint

* fix(ci): golanglint

* fix(ci): correct args indentation in pr-lint workflow (#21)

* fix(ci): avoid duplicate releases (#22)

* refactor(fail2ban): remove test check from OSRunner (#23)

* refactor(fail2ban): make log and filter dirs configurable (#24)

* fix(ci): create single release per tag (#14)

Signed-off-by: Ismo Vuorinen <ismo@ivuorinen.net>

* chore(dev): add codex setup script (#27)

* chore(lint): enable staticcheck (#26)

* chore(ci): verify golangci config (#28)

* refactor(cmd): centralize env config (#29)

* chore(dev): add pre-commit config (#30)

* fix(ci): disable cgo in cross compile (#31)

* fix(ci): fail on formatting issues (#32)

* feat(cmd): add context to logs watch (#33)

* chore: fixes, roadmap, claude.md, linting

* chore: fixes, linting

* fix(ci): gh actions update, fixes and tweaks

* chore: use reviewdog actionlint

* chore: use wow-rp-addons/actions-editorconfig-check

* chore: combine agent instructions, add comments, fixes

* chore: linting, fixes, go revive

* chore(deps): update pre-commit hooks

* chore: bump go to 1.21, pin workflows

* fix: install tools in lint.yml

* fix: sudo timeout

* fix: service command injection

* fix: memory exhaustion with large logs

* fix: enhanced path traversal and file security vulns

* fix: race conditions

* fix: context support

* chore: simplify fail2ban/ code

* feat: major refactoring with GoReleaser integration and code consolidation

- Add GoReleaser configuration for automated multi-platform releases
  - Support for Linux, macOS, Windows, and BSD builds
  - Docker images, Homebrew tap, and Linux packages (.deb, .rpm, .apk)
  - GitHub Actions workflow for release automation

- Consolidate duplicate code and improve architecture
  - Extract common command helpers to cmd/helpers.go (~230 lines)
  - Remove duplicate MockClient implementation from tests (~250 lines)
  - Create context wrapper helpers in fail2ban/context_helpers.go
  - Standardize error messages in fail2ban/errors.go

- Enhance validation and security
  - Add proper IP address validation with fail2ban.ValidateIP
  - Fix path traversal and command injection vulnerabilities
  - Improve thread-safety in MockClient with consistent ordering

- Optimize documentation
  - Reduce CLAUDE.md from 190 to 81 lines (57% reduction)
  - Reduce TODO.md from 633 to 93 lines (85% reduction)
  - Move README.md to root directory with installation instructions

- Improve test reliability
  - Fix race conditions and test flakiness
  - Add sorting to ensure deterministic test output
  - Enhance MockClient with configurable behavior

* feat: comprehensive code quality improvements and documentation reorganization

This commit represents a major overhaul of code quality, documentation
structure, and development tooling:

**Documentation & Structure:**

- Move CODE_OF_CONDUCT.md from .github to root directory
- Reorganize documentation with dedicated docs/ directory
- Create comprehensive architecture, security, and testing documentation
- Update all references and cross-links for new documentation structure

**Code Quality & Linting:**

- Add 120-character line length limit across all files via EditorConfig
- Enable comprehensive linting with golines, lll, usetesting, gosec, and revive
- Fix all 86 revive linter issues (unused parameters, missing export comments)
- Resolve security issues (file permissions 0644 → 0600, gosec warnings)
- Replace deprecated os.Setenv with t.Setenv in all tests
- Configure golangci-lint with auto-fix capabilities and formatter integration

**Development Tooling:**

- Enhance pre-commit configuration with additional hooks and formatters
- Update GoReleaser configuration with improved YAML formatting
- Improve GitHub workflows and issue templates for CLI-specific context
- Add comprehensive Makefile with proper dependency checking

**Testing & Security:**

- Standardize mock patterns and context wrapper implementations
- Enhance error handling with centralized error constants
- Improve concurrent access testing for thread safety

* perf: implement major performance optimizations with comprehensive test coverage

This commit introduces three significant performance improvements along with
complete linting compliance and robust test coverage:

**Performance Optimizations:**
1. **Time Parsing Cache (8.6x improvement)**
    - Add TimeParsingCache with sync.Map for caching parsed times
    - Implement object pooling for string builders to reduce allocations
    - Create optimized BanRecordParser with pooled string slices

2. **Gzip Detection Consolidation (55x improvement)**
    - Consolidate ~100 lines of duplicate gzip detection logic
    - Fast-path extension checking before magic byte detection
    - Unified GzipDetector with comprehensive file handling utilities

3. **Parallel Processing (2.5-5.0x improvement)**
    - Generic WorkerPool implementation for concurrent operations
    - Smart fallback to sequential processing for single operations
    - Context-aware cancellation support for long-running tasks
    - Applied to ban/unban operations across multiple jails

**New Files Added:**
- fail2ban/time_parser.go: Cached time parsing with global instances
- fail2ban/ban_record_parser.go: Optimized ban record parsing
- fail2ban/gzip_detection.go: Unified gzip handling utilities
- fail2ban/parallel_processing.go: Generic parallel processing framework
- cmd/parallel_operations.go: Command-level parallel operation support

**Code Quality & Linting:**
- Resolve all golangci-lint issues (0 remaining)
- Add proper #nosec annotations for legitimate file operations
- Implement sentinel errors replacing nil/nil anti-pattern
- Fix context parameter handling and error checking

**Comprehensive Test Coverage:**
- 500+ lines of new tests with benchmarks validating all improvements
- Concurrent access testing for thread safety
- Edge case handling and error condition testing
- Performance benchmarks demonstrating measured improvements

**Modified Files:**
- fail2ban/fail2ban.go: Integration with new optimized parsers
- fail2ban/logs.go: Use consolidated gzip detection (-91 lines)
- cmd/ban.go & cmd/unban.go: Add conditional parallel processing

* test: comprehensive test infrastructure overhaul with real test data

Major improvements to test code quality and organization:

• Added comprehensive test data infrastructure with 6 anonymized log files
• Extracted common test helpers reducing ~200 lines to ~50 reusable functions
• Enhanced ban record parser tests with real production log patterns
• Improved gzip detection tests with actual compressed test data
• Added integration tests for full log processing and concurrent operations
• Updated .gitignore to allow testdata log files while excluding others
• Updated TODO.md to reflect completed test infrastructure improvements

* fix: comprehensive security hardening and critical bug fixes

Security Enhancements:
- Add command injection protection with allowlist validation for all external
  commands
- Add security documentation to gzip functions warning about path traversal risks
- Complete TODO.md security audit - all critical vulnerabilities addressed

Bug Fixes:
- Fix negative index access vulnerability in parallel operations (prevent panic)
- Fix parsing inconsistency between BannedIn and BannedInWithContext functions
- Fix nil error handling in concurrent log reading tests
- Fix benchmark error simulation to measure actual performance vs error paths

Implementation Details:
- Add ValidateCommand() with allowlist for fail2ban-client, fail2ban-regex,
  service, systemctl, sudo
- Integrate command validation into all OSRunner methods before execution
- Replace manual string parsing with ParseBracketedList() for consistency
- Add bounds checking (index >= 0) to prevent negative array access
- Replace nil error with descriptive error message in concurrent error channels
- Update banFunc in benchmark to return success instead of permanent errors

Test Coverage:
- Add comprehensive security validation tests with injection attempt patterns
- Add parallel operations safety tests with index validation
- Add parsing consistency tests between context/non-context functions
- Add error handling demonstration tests for concurrent operations
- Add gzip function security requirement documentation tests

* perf: implement ultra-optimized log and ban record parsing with significant performance gains

Major performance improvements to core fail2ban processing with
 comprehensive benchmarking:

Performance Achievements:
• Ban record parsing: 15% faster, 39% less memory, 45% fewer allocations
• Log processing: 27% faster, 64% less memory, 32% fewer allocations
• Cache performance: 624x faster cache hits with zero allocations
• String pooling: 4.7x improvement with zero memory allocations

Core Optimizations:
• Object pooling (sync.Pool) for string slices, scanner buffers, and line buffers
• Comprehensive caching (sync.Map) for gzip detection, file info, and path patterns
• Fast path optimizations with extension-based gzip detection
• Byte-level operations to reduce string allocations in filtering
• Ultra-optimized parsers with smart field parsing and efficient time handling

New Files:
• fail2ban/ban_record_parser_optimized.go - High-performance ban record parser
• fail2ban/log_performance_optimized.go - Ultra-optimized log processor with caching
• fail2ban/ban_record_parser_benchmark_test.go - Ban record parsing benchmarks
• fail2ban/log_performance_benchmark_test.go - Log performance benchmarks
• fail2ban/ban_record_parser_compatibility_test.go - Compatibility verification tests

Updated:
• fail2ban/fail2ban.go - Integration with ultra-optimized parsers
• TODO.md - Marked performance optimization tasks as completed

* fix(ci): install dev dependencies for pre-commit

* refactor: streamline pre-commit config and extract test helpers

- Replace local hooks with upstream pre-commit repositories for better maintainability
- Add new hooks: shellcheck, shfmt, checkov for enhanced code quality
- Extract common test helpers into dedicated test_helpers.go to reduce duplication
- Add warning logs for unreadable log files in fail2ban and logs packages
- Remove hard-coded GID checks in sudo.go for better cross-platform portability
- Update golangci-lint installation method in Makefile

* fix(security): path traversal, log file validation

* feat: complete pre-release modernization with comprehensive testing

- Remove all deprecated legacy functions and dead code paths
- Add security hardening with sanitized error messages
- Implement comprehensive performance benchmarks and security audit tests
- Mark all pre-release modernization tasks as completed (10/10)
- Update project documentation to reflect full completion status

* fix(ci): linting, and update gosec install source

* feat: implement comprehensive test framework with 60-70% code reduction

Major test infrastructure modernization:

- Create fluent CommandTestBuilder framework for streamlined test creation
- Add MockClientBuilder pattern for advanced mock configuration
- Standardize table test field naming (expectedOut→wantOutput, expectError→wantError)
- Consolidate test code: 3,796 insertions, 3,104 deletions (net +692 lines with enhanced functionality)

Framework achievements:
- 168+ tests passing with zero regressions
- 5 cmd test files fully migrated to new framework
- 63 field name standardizations applied
- Advanced mock patterns with fluent interface

File organization improvements:
- Rename all test files with consistent prefixes (cmd_*, fail2ban_*, main_*)
- Split monolithic test files into focused, maintainable modules
- Eliminate cmd_test.go (622 lines) and main_test.go (825 lines)
- Create specialized test files for better organization

Documentation enhancements:
- Update docs/testing.md with complete framework documentation
- Optimize TODO.md from 231→72 lines (69% token reduction)
- Add comprehensive migration guides and best practices

Test framework components:
- command_test_framework.go: Core fluent interface implementation
- MockClientBuilder: Advanced mock configuration with builder pattern
- table_test_standards.go: Standardized field naming conventions
- Enhanced test helpers with error checking consolidation

* chore: fixes, .go-version, linting

* fix(ci) editorconfig in .pre-commit-config.yaml

* fix: too broad gitignore

* chore: update fail2ban/fail2ban_path_security_test.go

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Ismo Vuorinen <ismo@ivuorinen.net>

* chore: code review fixes

* chore: code review fixes

* fix: more code review fixes

* fix: more code review fixes

* feat: cleanup, fixes, testing

* chore: minor config file updates

- Add quotes to F2B_TIMEOUT value in .env.example for clarity
- Remove testdata log exception from .gitignore (simplified)

* feat: implement comprehensive monitoring with structured logging and metrics

- Add structured logging with context propagation throughout codebase
  - Implement ContextualLogger with request tracking and operation timing
  - Add context values for operation, IP, jail, command, and request ID
  - Integrate with existing logrus logging infrastructure

- Add request/response timing metrics collection
  - Create comprehensive Metrics system with atomic counters
  - Track command executions, ban/unban operations, and client operations
  - Implement latency distribution buckets for performance analysis
  - Add validation cache hit/miss tracking

- Enhance ban/unban commands with structured logging
  - Add LogOperation wrapper for automatic timing and context
  - Log individual jail operations with success/failure status
  - Integrate metrics recording with ban/unban operations

- Add new 'metrics' command to expose collected metrics
  - Support both plain text and JSON output formats
  - Display system metrics (uptime, memory, goroutines)
  - Show operation counts, failures, and average latencies
  - Include latency distribution histograms

- Update test infrastructure
  - Add tests for metrics command
  - Fix test helper to support persistent flags
  - Ensure all tests pass with new logging

This completes the high-priority performance monitoring and structured
logging requirements from TODO.md, providing comprehensive operational
visibility into the f2b application.

* docs: update TODO.md to reflect completed monitoring work

- Mark structured logging and timing metrics as completed
- Update test coverage stats (cmd/ improved from 66.4% to 76.8%)
- Add completed infrastructure section for today's work
- Update current status date and add monitoring to health indicators

* feat: complete TODO.md technical debt cleanup

Complete all remaining TODO.md tasks with comprehensive implementation:

## 🎯 Validation Caching Implementation
- Thread-safe validation cache with sync.RWMutex protection
- MetricsRecorder interface to avoid circular dependencies
- Cached validation for IP, jail, filter, and command validation
- Integration with existing metrics system for cache hit/miss tracking
- 100% test coverage for caching functionality

## 🔧 Constants Extraction
- Fail2Ban status codes: Fail2BanStatusSuccess, Fail2BanStatusAlreadyProcessed
- Command constants: Fail2BanClientCommand, Fail2BanRegexCommand, Fail2BanServerCommand
- File permissions: DefaultFilePermissions (0600), DefaultDirectoryPermissions (0750)
- Timeout limits: MaxCommandTimeout, MaxFileTimeout, MaxParallelTimeout
- Updated all references throughout codebase to use named constants

## 📊 Test Coverage Improvement
- Increased fail2ban package coverage from 62.0% to 70.3% (target: 70%+)
- Added 6 new comprehensive test files with 200+ additional test cases
- Coverage improvements across all major components:
  - Context helpers, validation cache, mock clients, OS runner methods
  - Error constructors, timing operations, cache statistics
  - Thread safety and concurrency testing

## 🛠️ Code Quality & Fixes
- Fixed all linting issues (golangci-lint, revive, errcheck)
- Resolved unused parameter warnings and error handling
- Fixed timing-dependent test failures in worker pool cancellation
- Enhanced thread safety in validation caching

## 📈 Final Metrics
- Overall test coverage: 72.4% (up from ~65%)
- fail2ban package: 70.3% (exceeds 70% target)
- cmd package: 76.9%
- Zero TODO/FIXME/HACK comments in production code
- 100% linting compliance

* fix: resolve test framework issues and update documentation

- Remove unnecessary defer/recover block in comprehensive_framework_test.go
- Fix compilation error in command_test_framework.go variable redeclaration
- Update TODO.md to reflect all 12 completed code quality fixes
- Clean up dead code and improve test maintainability
- Fix linting issues: error handling, code complexity, security warnings
- Break down complex test function to reduce cyclomatic complexity

* fix: replace dangerous test commands with safe placeholders

Replaces actual dangerous commands in test cases with safe placeholder patterns to prevent accidental execution while maintaining comprehensive security testing.

- Replace 'rm -rf /', 'cat /etc/passwd' with 'DANGEROUS_RM_COMMAND', 'DANGEROUS_SYSTEM_CALL'
- Update GetDangerousCommandPatterns() to recognize both old and new patterns
- Enhance filter validation with command injection protection (semicolons, pipes, backticks, dollar signs)
- Add package documentation comments for all packages (main, cmd, fail2ban)
- Fix GoReleaser static linking configuration for cross-platform builds
- Remove Docker platform restriction to enable multi-arch support
- Apply code formatting and linting fixes

All security validation tests continue to pass with the safe placeholders.

* fix: resolve TestMixedConcurrentOperations race condition and command key mismatches

The concurrency test was failing due to several issues:

1. **Command Key Mismatch**: Test setup used "sudo test arg" key but MockRunner
   looked for "test arg" because "test" command doesn't require sudo
2. **Invalid Commands**: Using "test" and "echo" commands that aren't in the
   fail2ban command allowlist, causing validation failures
3. **Race Conditions**: Multiple goroutines setting different MockRunners
   simultaneously, overwriting responses

**Solution:**
- Replace invalid test commands ("test", "echo") with valid fail2ban commands
  ("fail2ban-client status", "fail2ban-client -V")
- Pre-configure shared MockRunner with all required response keys for both
  sudo and non-sudo execution paths
- Improve test structure to reduce race conditions between setup and execution

All tests now pass reliably, resolving the CI failure.

* fix: address code quality issues and improve test coverage

- Replace unsafe type assertion with comma-ok idiom in logging
- Fix TestTestFilter to use created filter instead of nonexistent
- Add warning logs for invalid log level configurations
- Update TestVersionCommand to use consistent test framework pattern
- Remove unused LoggerContextKey constant
- Add version command support to test framework
- Fix trailing whitespace in test files

* feat: add timeout handling and multi-architecture Docker support

* test: enhance path traversal security test coverage

* chore: comprehensive documentation update and linting fixes

Updated all documentation to reflect current capabilities including context-aware operations, multi-architecture Docker support, advanced security features, and performance monitoring. Removed unused functions and fixed all linting issues.

* fix(lint): .goreleaser.yaml

* feat: add markdown link checker and fix all linting issues

- Add markdown-link-check to pre-commit hooks with comprehensive configuration
- Fix GitHub workflow structure (sync-labels.yml) with proper job setup
- Add JSON schemas to all configuration files for better IDE support
- Update tool installation in Makefile for markdown-link-check dependency
- Fix all revive linting issues (Boolean literals, defer in loop, if-else simplification, method naming)
- Resolve broken relative link in CONTRIBUTING.md
- Configure rate limiting and ignore patterns for GitHub URLs
- Enhance CLAUDE.md with link checking documentation

* fix(ci): sync-labels permissions

* docs: comprehensive documentation update reflecting current project status

- Updated TODO.md to show production-ready status with 21 commands
- Enhanced README.md with enterprise-grade features and capabilities
- Added performance monitoring and timeout configuration to FAQ
- Updated CLAUDE.md with accurate project architecture overview
- Fixed all line length issues to meet EditorConfig requirements
- Added .mega-linter.yml configuration for enhanced linting

* fix: address CodeRabbitAI review feedback

- Split .goreleaser.yaml builds for static/dynamic linking by architecture
- Update docs to accurately reflect 7 path traversal patterns (not 17)
- Fix containsPathTraversal to allow valid absolute paths
- Replace runnerCombinedRunWithSudoContext with RunnerCombinedOutputWithSudoContext
- Fix ldflags to use uppercase Version variable name
- Remove duplicate test coverage metrics in TODO.md
- Fix .markdown-link-check.json schema violations
- Add v8r JSON validator to pre-commit hooks

* chore(ci): update workflows, switch v8r to check-jsonschema

* fix: restrict static linking to amd64 only in .goreleaser.yaml

- Move arm64 from static to dynamic build configuration
- Static linking now only applies to linux/amd64
- Prevents build failures due to missing static libc on ARM64
- All architectures remain supported with appropriate linking

* fix(ci): caching

* fix(ci): python caching with pip, node with npm

* fix(ci): no caching for node then

* fix(ci): no requirements.txt, no cache

* refactor: address code review feedback

- Pin Alpine base image to v3.20 for reproducible builds
- Remove redundant --platform flags in GoReleaser Docker configs
- Fix unused parameters in concurrency test goroutines
- Simplify string search helper using strings.Contains()
- Remove redundant error checking logic in security tests

---------

Signed-off-by: Ismo Vuorinen <ismo@ivuorinen.net>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-08-07 01:49:45 +03:00

498 lines
13 KiB
Go

package fail2ban
import (
"bufio"
"fmt"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"sync"
"sync/atomic"
)
// OptimizedLogProcessor provides high-performance log processing with caching and optimizations
type OptimizedLogProcessor struct {
// Caches for performance
gzipCache sync.Map // string -> bool (path -> isGzip)
pathCache sync.Map // string -> string (pattern -> cleanPath)
fileInfoCache sync.Map // string -> *CachedFileInfo
// Object pools for reducing allocations
stringPool sync.Pool
linePool sync.Pool
scannerPool sync.Pool
// Statistics (thread-safe atomic counters)
cacheHits atomic.Int64
cacheMisses atomic.Int64
}
// CachedFileInfo holds cached information about a log file
type CachedFileInfo struct {
Path string
IsGzip bool
Size int64
ModTime int64
LogNumber int // For rotated logs: -1 for current, >=0 for rotated
IsValid bool
}
// OptimizedRotatedLog represents a rotated log file with cached info
type OptimizedRotatedLog struct {
Num int
Path string
Info *CachedFileInfo
}
// NewOptimizedLogProcessor creates a new high-performance log processor
func NewOptimizedLogProcessor() *OptimizedLogProcessor {
processor := &OptimizedLogProcessor{}
// String slice pool for lines
processor.stringPool = sync.Pool{
New: func() interface{} {
s := make([]string, 0, 1000) // Pre-allocate for typical log sizes
return &s
},
}
// Line buffer pool for individual lines
processor.linePool = sync.Pool{
New: func() interface{} {
b := make([]byte, 0, 512) // Pre-allocate for typical line lengths
return &b
},
}
// Scanner buffer pool
processor.scannerPool = sync.Pool{
New: func() interface{} {
b := make([]byte, 0, 64*1024) // 64KB scanner buffer
return &b
},
}
return processor
}
// GetLogLinesOptimized provides optimized log line retrieval with caching
func (olp *OptimizedLogProcessor) GetLogLinesOptimized(jailFilter, ipFilter string, maxLines int) ([]string, error) {
// Fast path for log directory pattern caching
pattern := filepath.Join(GetLogDir(), "fail2ban.log*")
files, err := olp.getCachedGlobResults(pattern)
if err != nil {
return nil, fmt.Errorf("error listing log files: %w", err)
}
if len(files) == 0 {
return []string{}, nil
}
// Optimized file parsing and sorting
currentLog, rotated := olp.parseLogFilesOptimized(files)
// Get pooled string slice
linesPtr := olp.stringPool.Get().(*[]string)
lines := (*linesPtr)[:0] // Reset slice but keep capacity
defer func() {
*linesPtr = lines[:0]
olp.stringPool.Put(linesPtr)
}()
config := LogReadConfig{
MaxLines: maxLines,
MaxFileSize: 100 * 1024 * 1024, // 100MB file size limit
JailFilter: jailFilter,
IPFilter: ipFilter,
ReverseOrder: false,
}
totalLines := 0
// Process rotated logs first (oldest to newest)
for _, rotatedLog := range rotated {
if config.MaxLines > 0 && totalLines >= config.MaxLines {
break
}
remainingLines := config.MaxLines - totalLines
if remainingLines <= 0 {
break
}
fileConfig := config
fileConfig.MaxLines = remainingLines
fileLines, err := olp.streamLogFileOptimized(rotatedLog.Path, fileConfig)
if err != nil {
getLogger().WithError(err).WithField("file", rotatedLog.Path).Error("Failed to read log file")
continue
}
lines = append(lines, fileLines...)
totalLines += len(fileLines)
}
// Process current log last
if currentLog != "" && (config.MaxLines == 0 || totalLines < config.MaxLines) {
remainingLines := config.MaxLines - totalLines
if remainingLines > 0 || config.MaxLines == 0 {
fileConfig := config
if config.MaxLines > 0 {
fileConfig.MaxLines = remainingLines
}
fileLines, err := olp.streamLogFileOptimized(currentLog, fileConfig)
if err != nil {
getLogger().WithError(err).WithField("file", currentLog).Error("Failed to read current log file")
} else {
lines = append(lines, fileLines...)
}
}
}
// Return a copy since we're pooling the original
result := make([]string, len(lines))
copy(result, lines)
return result, nil
}
// getCachedGlobResults caches glob results for performance
func (olp *OptimizedLogProcessor) getCachedGlobResults(pattern string) ([]string, error) {
// For now, don't cache glob results as file lists change frequently
// In a production system, you might cache with a TTL
return filepath.Glob(pattern)
}
// parseLogFilesOptimized optimizes file parsing with caching and better sorting
func (olp *OptimizedLogProcessor) parseLogFilesOptimized(files []string) (string, []OptimizedRotatedLog) {
var currentLog string
rotated := make([]OptimizedRotatedLog, 0, len(files))
for _, path := range files {
base := filepath.Base(path)
if base == "fail2ban.log" {
currentLog = path
} else if strings.HasPrefix(base, "fail2ban.log.") {
// Extract number more efficiently
if num := olp.extractLogNumberOptimized(base); num >= 0 {
info := olp.getCachedFileInfo(path)
rotated = append(rotated, OptimizedRotatedLog{
Num: num,
Path: path,
Info: info,
})
}
}
}
// Sort with cached info for better performance
olp.sortRotatedLogsOptimized(rotated)
return currentLog, rotated
}
// extractLogNumberOptimized efficiently extracts log numbers from filenames
func (olp *OptimizedLogProcessor) extractLogNumberOptimized(basename string) int {
// For "fail2ban.log.1" or "fail2ban.log.1.gz"
parts := strings.Split(basename, ".")
if len(parts) < 3 {
return -1
}
// parts[2] should be the number
numStr := parts[2]
if num, err := strconv.Atoi(numStr); err == nil && num >= 0 {
return num
}
return -1
}
// getCachedFileInfo gets or creates cached file information
func (olp *OptimizedLogProcessor) getCachedFileInfo(path string) *CachedFileInfo {
if cached, ok := olp.fileInfoCache.Load(path); ok {
olp.cacheHits.Add(1)
return cached.(*CachedFileInfo)
}
olp.cacheMisses.Add(1)
// Create new file info
info := &CachedFileInfo{
Path: path,
LogNumber: olp.extractLogNumberOptimized(filepath.Base(path)),
IsValid: true,
}
// Check if file is gzip
info.IsGzip = olp.isGzipFileOptimized(path)
// Get file size and mod time if needed for sorting
if stat, err := os.Stat(path); err == nil {
info.Size = stat.Size()
info.ModTime = stat.ModTime().Unix()
}
olp.fileInfoCache.Store(path, info)
return info
}
// isGzipFileOptimized provides cached gzip detection
func (olp *OptimizedLogProcessor) isGzipFileOptimized(path string) bool {
if cached, ok := olp.gzipCache.Load(path); ok {
return cached.(bool)
}
// Use optimized detection
isGzip := olp.fastGzipDetection(path)
olp.gzipCache.Store(path, isGzip)
return isGzip
}
// fastGzipDetection provides faster gzip detection
func (olp *OptimizedLogProcessor) fastGzipDetection(path string) bool {
// Super fast path: check extension
if strings.HasSuffix(path, ".gz") {
return true
}
// For fail2ban logs, if it doesn't end in .gz, it's very likely not gzipped
// We can skip the expensive magic byte check for known patterns
basename := filepath.Base(path)
if strings.HasPrefix(basename, "fail2ban.log") && !strings.Contains(basename, ".gz") {
return false
}
// Fallback to default detection only if necessary
isGzip, err := IsGzipFile(path)
if err != nil {
return false
}
return isGzip
}
// sortRotatedLogsOptimized provides optimized sorting
func (olp *OptimizedLogProcessor) sortRotatedLogsOptimized(rotated []OptimizedRotatedLog) {
// Use a more efficient sorting approach
sort.Slice(rotated, func(i, j int) bool {
// Primary sort: by log number (higher number = older)
if rotated[i].Num != rotated[j].Num {
return rotated[i].Num > rotated[j].Num
}
// Secondary sort: by modification time if numbers are equal
if rotated[i].Info != nil && rotated[j].Info != nil {
return rotated[i].Info.ModTime > rotated[j].Info.ModTime
}
// Fallback: string comparison
return rotated[i].Path > rotated[j].Path
})
}
// streamLogFileOptimized provides optimized log file streaming
func (olp *OptimizedLogProcessor) streamLogFileOptimized(path string, config LogReadConfig) ([]string, error) {
cleanPath, err := validateLogPath(path)
if err != nil {
return nil, err
}
if shouldSkipFile(cleanPath, config.MaxFileSize) {
return []string{}, nil
}
// Use cached gzip detection
isGzip := olp.isGzipFileOptimized(cleanPath)
// Create optimized scanner
scanner, cleanup, err := olp.createOptimizedScanner(cleanPath, isGzip)
if err != nil {
return nil, err
}
defer cleanup()
return olp.scanLogLinesOptimized(scanner, config)
}
// createOptimizedScanner creates an optimized scanner with pooled buffers
func (olp *OptimizedLogProcessor) createOptimizedScanner(path string, isGzip bool) (*bufio.Scanner, func(), error) {
if isGzip {
// Use existing gzip-aware scanner
return CreateGzipAwareScannerWithBuffer(path, 64*1024)
}
// For regular files, use optimized approach
// #nosec G304 - path is validated by validateLogPath before this call
file, err := os.Open(path)
if err != nil {
return nil, nil, err
}
// Get pooled buffer
bufPtr := olp.scannerPool.Get().(*[]byte)
buf := (*bufPtr)[:cap(*bufPtr)] // Use full capacity
scanner := bufio.NewScanner(file)
scanner.Buffer(buf, 64*1024) // 64KB max line size
cleanup := func() {
if err := file.Close(); err != nil {
getLogger().WithError(err).WithField("file", path).Warn("Failed to close file during cleanup")
}
*bufPtr = (*bufPtr)[:0] // Reset buffer
olp.scannerPool.Put(bufPtr)
}
return scanner, cleanup, nil
}
// scanLogLinesOptimized provides optimized line scanning with reduced allocations
func (olp *OptimizedLogProcessor) scanLogLinesOptimized(
scanner *bufio.Scanner,
config LogReadConfig,
) ([]string, error) {
// Get pooled string slice
linesPtr := olp.stringPool.Get().(*[]string)
lines := (*linesPtr)[:0] // Reset slice but keep capacity
defer func() {
*linesPtr = lines[:0]
olp.stringPool.Put(linesPtr)
}()
lineCount := 0
hasJailFilter := config.JailFilter != "" && config.JailFilter != "all"
hasIPFilter := config.IPFilter != "" && config.IPFilter != "all"
for scanner.Scan() {
if config.MaxLines > 0 && lineCount >= config.MaxLines {
break
}
line := scanner.Text()
if len(line) == 0 {
continue
}
// Fast filtering without trimming unless necessary
if hasJailFilter || hasIPFilter {
if !olp.matchesFiltersOptimized(line, config.JailFilter, config.IPFilter, hasJailFilter, hasIPFilter) {
continue
}
}
lines = append(lines, line)
lineCount++
}
if err := scanner.Err(); err != nil {
return nil, err
}
// Return a copy since we're pooling the original
result := make([]string, len(lines))
copy(result, lines)
return result, nil
}
// matchesFiltersOptimized provides optimized filtering with minimal allocations
func (olp *OptimizedLogProcessor) matchesFiltersOptimized(
line, jailFilter, ipFilter string,
hasJailFilter, hasIPFilter bool,
) bool {
if !hasJailFilter && !hasIPFilter {
return true
}
// Fast byte-level searching to avoid string allocations
lineBytes := []byte(line)
jailMatch := !hasJailFilter
ipMatch := !hasIPFilter
if hasJailFilter && !jailMatch {
// Look for jail pattern: [jail-name]
jailPattern := "[" + jailFilter + "]"
if olp.fastContains(lineBytes, []byte(jailPattern)) {
jailMatch = true
}
}
if hasIPFilter && !ipMatch {
// Look for IP pattern in the line
if olp.fastContains(lineBytes, []byte(ipFilter)) {
ipMatch = true
}
}
return jailMatch && ipMatch
}
// fastContains provides fast byte-level substring search
func (olp *OptimizedLogProcessor) fastContains(haystack, needle []byte) bool {
if len(needle) == 0 {
return true
}
if len(needle) > len(haystack) {
return false
}
// Use Boyer-Moore-like approach for longer needles
if len(needle) > 4 {
return strings.Contains(string(haystack), string(needle))
}
// Simple search for short needles
for i := 0; i <= len(haystack)-len(needle); i++ {
match := true
for j := 0; j < len(needle); j++ {
if haystack[i+j] != needle[j] {
match = false
break
}
}
if match {
return true
}
}
return false
}
// GetCacheStats returns cache performance statistics
func (olp *OptimizedLogProcessor) GetCacheStats() (hits, misses int64) {
return olp.cacheHits.Load(), olp.cacheMisses.Load()
}
// ClearCaches clears all caches (useful for testing or memory management)
func (olp *OptimizedLogProcessor) ClearCaches() {
// Use sync.Map's Range and Delete methods for thread-safe clearing
olp.gzipCache.Range(func(key, _ interface{}) bool {
olp.gzipCache.Delete(key)
return true
})
olp.pathCache.Range(func(key, _ interface{}) bool {
olp.pathCache.Delete(key)
return true
})
olp.fileInfoCache.Range(func(key, _ interface{}) bool {
olp.fileInfoCache.Delete(key)
return true
})
olp.cacheHits.Store(0)
olp.cacheMisses.Store(0)
}
// Global optimized processor instance
var optimizedLogProcessor = NewOptimizedLogProcessor()
// GetLogLinesUltraOptimized provides ultra-optimized log line retrieval
func GetLogLinesUltraOptimized(jailFilter, ipFilter string, maxLines int) ([]string, error) {
return optimizedLogProcessor.GetLogLinesOptimized(jailFilter, ipFilter, maxLines)
}