feat: Add Sentry error tracking adapter with enterprise features (#46) #63
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implement SentrySink with batching, breadcrumbs, and context enrichment - Add integration test setup script for Sentry self-hosted - Create examples for basic usage, breadcrumbs, and context - Support custom fingerprinting, sampling, and error filtering
- Fix message templates showing placeholders instead of actual values - Add comprehensive tests for template interpolation - Add Sentry adapter tests to CI pipeline - Add pipeline initialization and verification scripts - Update .gitignore for generated Sentry infrastructure files - Add user-focused documentation in examples/README.md
- Move Sentry dependencies from root to adapters/sentry/go.mod - Follow established pattern used by middleware, otel, and logr adapters - Keep core library dependencies minimal
…pers - Add RFC3339 formatting for time.Time values in message interpolation - Add performance benchmarks for critical operations - Add common fingerprinting helpers (ByTemplate, ByErrorType, ByProperty) - Add test coverage for time type handling
Implement complete suite of production-ready features for Sentry integration: Performance & Reliability: - Add retry logic with exponential backoff and jitter for network resilience - Implement string builder pooling for zero-allocation message rendering - Add LRU stack trace caching to reduce repeated extraction overhead - Support environment variable configuration (SENTRY_DSN) Observability & Monitoring: - Implement comprehensive metrics collection with atomic counters - Add transaction/performance monitoring with distributed tracing support - Create span tracking for HTTP, database, cache, and custom operations - Include metrics callbacks for real-time monitoring Sampling & Cost Control: - Implement 7 sampling strategies (fixed, adaptive, priority, burst, group, profiles, custom) - Add pre-configured sampling profiles for common scenarios - Integrate with mtlog's native sampling APIs - Support group-based sampling to limit repetitive errors Examples & Documentation: - Add 4 new comprehensive examples (retry, performance, metrics, sampling) - Create extensive test suite with 500+ lines of tests - Update README with detailed documentation for all features - Include benchmarks showing performance improvements Tests show 60ns stack trace caching, 11ns retry calculation, 7ns metrics collection
- Remove unused timer field from SentrySink struct - Simplify nil check for Exception slice (S1009) - Fix redundant type assertion for hint.OriginalException (S1040) - Remove empty branch in stack trace caching (SA9003)
Adjust TestDynamicLevelControl_Performance threshold from 150ns to 200ns on Windows to account for slower performance on Windows CI environments
- Add Sentry integration examples to README.md - Document Sentry sink in docs/sinks.md with usage examples - Update quick-reference.md and quick-reference.html with Sentry examples - Include all Sentry example programs in README examples list
There was a problem hiding this comment.
Pull Request Overview
This PR implements a comprehensive Sentry integration for mtlog, providing production-grade error tracking, performance monitoring, and advanced sampling capabilities. The integration maintains mtlog's zero-allocation philosophy where possible while offering enterprise features for monitoring and observability.
Key changes:
- Complete Sentry adapter with automatic error capture, transaction tracking, and breadcrumb collection
- 7 sampling strategies including adaptive, burst detection, and group-based sampling
- Performance optimizations including stack trace caching and string builder pooling
- Comprehensive test suite with integration tests and benchmarks
Reviewed Changes
Copilot reviewed 31 out of 33 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| dynamic_level_test.go | Performance test improvements for Windows compatibility |
| docs/sinks.md | Comprehensive documentation for Sentry integration features |
| docs/quick-reference.md | Quick reference examples for Sentry usage |
| docs/quick-reference.html | HTML version of quick reference with Sentry examples |
| adapters/sentry/*.go | Core Sentry implementation with options, sampling, metrics, and performance tracking |
| adapters/sentry/*_test.go | Extensive test suite covering all features with benchmarks |
| adapters/sentry/scripts/*.sh | Integration test setup and verification scripts |
| adapters/sentry/examples/* | 8 comprehensive example programs demonstrating different use cases |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- Add rand.Seed() in init to ensure better randomness for retry backoff jitter - Address Copilot review comment about predictable retry patterns - Note: Using math/rand is acceptable here as jitter is not security-critical
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Implements a comprehensive Sentry integration for mtlog, providing automatic error tracking, performance monitoring, and advanced sampling capabilities. This adapter enables production-grade error monitoring with Sentry while maintaining mtlog's zero-allocation philosophy where possible.
Key capabilities:
Type of change
Checklist
go test ./...)golangci-lint run)Additional notes
Performance Achievements
Comprehensive Feature Set
Production Ready
Fixes #46