+
+
+
+
+
+
+ Error monitoring and crash reporting for Java applications +
+ +
+ 
+ 
+
+ Website • + Documentation • + Java Guide • + Git +
+ +--- + +**IronTelemetry** helps you capture exceptions, track user journeys, and get actionable insights to fix issues faster. Built for developers who want simple, powerful error monitoring without the complexity. + +## Features + +- **Exception Capture** - Automatically capture exceptions with full stack traces +- **Journey Tracking** - Understand what users did before an error occurred +- **Breadcrumbs** - Add context with custom breadcrumbs and metadata +- **Async Support** - CompletableFuture support for async operations +- **Thread-Safe** - All operations are safe for concurrent use +- **Spring Integration** - Easy integration with Spring Boot ## Installation @@ -25,63 +55,66 @@ implementation 'com.ironservices:telemetry:0.1.0' ## Quick Start -### Basic Exception Capture +### Initialize the SDK ```java import com.ironservices.telemetry.TelemetryClient; -public class Main { - public static void main(String[] args) { - // Initialize with your DSN - try (TelemetryClient client = new TelemetryClient("https://pk_live_xxx@irontelemetry.com")) { - try { - doSomething(); - } catch (Exception e) { - client.captureException(e); - throw e; - } - } - } +TelemetryClient client = new TelemetryClient("https://pk_live_xxx@irontelemetry.com"); +``` + +### Capture Exceptions + +```java +try { + doSomething(); +} catch (Exception e) { + client.captureException(e); + throw e; } ``` -### Journey Tracking - -Track user journeys to understand the context of errors: +### Track User Journeys ```java -import com.ironservices.telemetry.*; +Journey journey = client.startJourney("Checkout Flow"); +journey.setUser("user-123", "user@example.com", "John Doe"); -public class CheckoutService { - private final TelemetryClient client; +try { + journey.runStep("Validate Cart", BreadcrumbCategory.BUSINESS, () -> { + validateCart(); + }); - public CheckoutService(TelemetryClient client) { - this.client = client; - } + journey.runStep("Process Payment", BreadcrumbCategory.BUSINESS, () -> { + processPayment(); + }); - public void processCheckout() { - Journey journey = client.startJourney("Checkout Flow"); - journey.setUser("user-123", "user@example.com", "John Doe"); + journey.complete(); +} catch (Exception e) { + journey.fail(e); + client.captureException(e); + throw e; +} +``` - try { - journey.runStep("Validate Cart", BreadcrumbCategory.BUSINESS, () -> { - validateCart(); - }); +### Add Breadcrumbs - journey.runStep("Process Payment", BreadcrumbCategory.BUSINESS, () -> { - processPayment(); - }); +```java +client.addBreadcrumb("User clicked checkout button", BreadcrumbCategory.UI); +client.addBreadcrumb("Payment API called", BreadcrumbCategory.HTTP); +``` - journey.runStep("Send Confirmation", BreadcrumbCategory.NOTIFICATION, () -> { - sendConfirmationEmail(); - }); +## Spring Integration - journey.complete(); - } catch (Exception e) { - journey.fail(e); - client.captureException(e); - throw e; - } +```java +@ControllerAdvice +public class GlobalExceptionHandler { + private final TelemetryClient telemetryClient; + + @ExceptionHandler(Exception.class) + public ResponseEntity handleException(Exception e) { + telemetryClient.captureException(e); + return ResponseEntity.status(500).body("Internal Server Error"); } } ``` @@ -89,183 +122,34 @@ public class CheckoutService { ## Configuration ```java -import com.ironservices.telemetry.TelemetryClient; -import com.ironservices.telemetry.TelemetryOptions; - TelemetryOptions options = new TelemetryOptions("https://pk_live_xxx@irontelemetry.com") .setEnvironment("production") .setAppVersion("1.2.3") - .setSampleRate(1.0) // 100% of events - .setDebug(false) - .setBeforeSend(event -> { - // Filter or modify events - if (event.getMessage() != null && event.getMessage().contains("expected")) { - return null; // Drop the event - } - return event; - }); + .setSampleRate(1.0) + .setDebug(false); TelemetryClient client = new TelemetryClient(options); ``` -### Configuration Options +## Documentation -| Option | Type | Default | Description | -|--------|------|---------|-------------| -| `dsn` | String | required | Your Data Source Name | -| `environment` | String | "production" | Environment name | -| `appVersion` | String | "0.0.0" | Application version | -| `sampleRate` | double | 1.0 | Sample rate (0.0 to 1.0) | -| `maxBreadcrumbs` | int | 100 | Max breadcrumbs to keep | -| `debug` | boolean | false | Enable debug logging | -| `beforeSend` | Function | null | Hook to filter/modify events | -| `enableOfflineQueue` | boolean | true | Enable offline queue | -| `maxOfflineQueueSize` | int | 500 | Max offline queue size | +For complete documentation, visit [irontelemetry.com/docs](https://irontelemetry.com/docs). -## Features +## Other SDKs -- **Automatic Stack Traces**: Full stack traces captured with every exception -- **Journey Tracking**: Track user flows and correlate errors with context -- **Breadcrumbs**: Leave a trail of events leading up to an error -- **User Context**: Associate errors with specific users -- **Tags & Extras**: Add custom metadata to your events -- **Async Support**: CompletableFuture support for async operations -- **Thread-Safe**: All operations are safe for concurrent use +| Platform | Package | +|----------|---------| +| JavaScript/TypeScript | [@ironservices/telemetry](https://git.marketally.com/ironservices/irontelemetry-js) | +| .NET | [IronTelemetry.Client](https://git.marketally.com/ironservices/irontelemetry-dotnet) | +| Python | [irontelemetry](https://git.marketally.com/ironservices/irontelemetry-python) | +| Go | [irontelemetry-go](https://git.marketally.com/ironservices/irontelemetry-go) | +| Rust | [irontelemetry](https://git.marketally.com/ironservices/irontelemetry-rust) | -## Breadcrumbs +## Support -```java -// Add simple breadcrumbs -client.addBreadcrumb("User clicked checkout button", BreadcrumbCategory.UI); -client.addBreadcrumb("Payment API called", BreadcrumbCategory.HTTP); - -// With level -client.addBreadcrumb("User logged in", BreadcrumbCategory.AUTH, SeverityLevel.INFO); - -// With data -Map