How to customize the bug report gesture in Aardvark?

You can pass a custom subclass of UIGestureRecognizer to `[Aardvark addBugReporter:triggeringGestureRecognizerClass:]` as mentioned in the README's customization section, allowing modifications like different touch patterns or programmatic triggers.

Does Aardvark automatically log crashes and exceptions?

Yes, it can log uncaught exceptions with stack traces by calling `ARKEnableLogOnUncaughtException()`, but for full crash reports, you need the AardvarkCrashReport extension, which handles prior app launch crashes or live thread states.

Aardvark vs Firebase Crashlytics for iOS bug reporting

Aardvark focuses on user-triggered, actionable reports with logs and screenshots via email, while Crashlytics offers automated crash analytics and real-time dashboards. Aardvark is better for in-app feedback collection, whereas Crashlytics suits teams needing backend-integrated monitoring.

How to view logs offline with Aardvark?

Logs are stored incrementally on disk and can be accessed via the ARKLogTableViewController from AardvarkLoggingUI, allowing offline viewing within the app without network dependency, as logs are appended to files locally.

Can I integrate Aardvark with a bug tracking tool like Jira?

Yes, but it requires custom implementation using the ARKBugReporter protocol to replace the default email reporter, as the README notes for tailored workflows, involving additional coding to connect to APIs like Jira's.

What are Aardvark's requirements for Xcode and iOS versions?

It requires Xcode 16.0 or later and iOS 16.0 or later, as stated in the requirements, which may limit adoption in legacy projects or teams on older development environments.

Open-Awesome

Aardvark

Apache-2.0Objective-CAardvarkMailUI/1.1.0

A library for iOS that simplifies creating actionable bug reports with logs and screenshots.

GitHub

262 stars43 forks0 contributors

What is Aardvark?

Aardvark is a library for iOS that simplifies the creation of actionable bug reports within apps. It provides tools for logging, screenshot capture, and email-based bug reporting triggered by user gestures, helping developers gather detailed information about issues directly from users.

Target Audience

iOS developers building apps who need robust, integrated bug reporting and logging tools to improve debugging and user feedback quality.

Value Proposition

Developers choose Aardvark for its minimal setup, performance-friendly background logging, and customizable reporting workflows, making it a comprehensive solution for enhancing bug report quality without complex integration.

Overview

Aardvark is a library that makes it dead simple to create actionable bug reports.

Use Cases

Best For

Adding gesture-triggered bug reporting to iOS apps
Integrating email-based bug reports with logs and screenshots
Viewing application logs directly within an iOS app
Logging uncaught exceptions with stack traces
Customizing bug reporting workflows with third-party services
Debugging UI issues with attached Reveal files (via extensions)

Not Ideal For

Apps requiring direct integration with bug tracking systems like Jira or GitHub without custom coding
Cross-platform projects that need consistent bug reporting on Android or web alongside iOS
Applications with stringent data privacy policies where email transmission is non-compliant
Teams seeking turnkey analytics dashboards or real-time crash monitoring without additional services

Pros & Cons

Pros

Minimal Setup Effort

The README emphasizes 'only three steps' for integration, with email reporting activated via a single method call like `Aardvark.addDefaultBugReportingGestureWithEmailBugReporter(withRecipient:)`, reducing initial configuration time.

Background Logging Performance

Logs are processed on an internal background queue that 'will never slow down your app,' and logs are incrementally appended to disk, not stored in memory, ensuring minimal performance impact.

Customizable Reporting Workflows

Supports custom bug reporter implementations via the ARKBugReporter protocol and custom gesture recognizers, allowing integration with third-party services or tailored triggers as noted in the customization section.

Integrated Log Viewing UI

Includes the AardvarkLoggingUI framework for pushing an ARKLogTableViewController instance to view logs directly on the device, aiding in-app debugging without external tools.

Cons

Email-Centric Default

The out-of-the-box setup relies on email for bug reports, requiring custom implementation for other services, which the README acknowledges by directing users to the ARKBugReporter protocol for alternatives.

iOS Platform Lock-in

It is limited to iOS 16.0+ and watchOS 7.0+, with no support for Android or web, as specified in the requirements, making it unsuitable for cross-platform development.

Extension Dependencies

Advanced features like Reveal file attachments or crash reports depend on separate extensions (e.g., AardvarkReveal), adding complexity and potential third-party tool reliance beyond the core library.

Frequently Asked Questions

Related Projects

SwiftFormat

A command-line tool and Xcode Extension for formatting Swift code

Stars8,923

Forks699

Last commit4 days ago

MLeaksFinder

Find memory leaks in your iOS app at develop time.

Stars5,430

Forks942

Last commit3 years ago

FBRetainCycleDetector

iOS library to help detecting retain cycles in runtime.

Stars4,230

Forks601

Last commit19 days ago

Bootstrap

iOS project bootstrap aimed at high quality coding.

Stars2,036

Forks106

Last commit5 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub