uber-go/goleak
Goleak
Goleak is a diagnostic utility designed to identify and report leaked goroutines within Go applications. By integrating directly with standard testing frameworks, it validates that background tasks terminate correctly after the completion of individual test cases, packages, or entire test suites.
The tool functions by capturing snapshots of active execution threads and comparing them against a baseline to isolate newly spawned processes. To ensure accuracy and reduce noise, it provides mechanisms to filter specific stack traces, ignore known background tasks, and perform retries to account for transient operations that may conclude shortly after a test finishes.
This library supports the maintenance of stable automated test suites by pinpointing the source of concurrency bugs and preventing resource exhaustion. It is distributed as a testing framework extension that can be incorporated into existing workflows to monitor runtime behavior and verify the overall concurrency health of software.
Features
- Goroutine Leak Prevention - A testing utility that identifies and reports leaked goroutines by inspecting runtime stacks after test execution to ensure clean resource management.
- Concurrent Software Testing - Identifies and prevents background goroutine leaks during automated test execution to ensure stable and resource-efficient software performance.
- Thread Leak Detection - Detects active background goroutines to identify resource leaks during test execution and report unexpected persistence.
- Execution Snapshots - Records a baseline of active tasks before execution and compares it against a final state to isolate newly spawned leaks.
- Runtime Debugging - Inspects active background tasks and stack traces to diagnose unexpected process persistence and improve the overall health of concurrent applications.
- Test Suite Extensions - Integrates with standard test suites to validate that no background tasks remain active after individual tests or packages finish.
- Stack Trace Recoveries - Excludes specific background tasks or functions from leak detection by matching stack traces to reduce noise and false positives.
- Test State Cleanup - Validates that no unexpected background tasks remain running after individual tests or entire test suites finish execution to ensure a clean state.
- Stack Trace Inspections - Captures the current state of all active execution threads by querying the internal runtime to identify lingering background processes.
- Automated Test Suites - Integrates leak detection into existing test workflows to isolate and resolve concurrency bugs that cause flaky or unstable test results.
- Concurrency Analysis - A diagnostic tool that filters and monitors active goroutines to isolate concurrency bugs and prevent resource exhaustion in concurrent applications.
- Test Isolation Verifiers - Runs leak detection across individual test cases to pinpoint the specific source of background task leaks within a software package.
- Asynchronous Polling Mechanisms - Repeats verification checks over a configurable duration to account for transient tasks that terminate shortly after the primary execution.
- Test Lifecycle Hooks - Hooks into the standard testing framework to automatically trigger validation logic immediately following the completion of individual test cases.
- Development Utilities - Detects goroutine leaks.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
