https://github.com/bugfender/bugfendersdk-flutter

Flutter SDK for Bugfender
https://github.com/bugfender/bugfendersdk-flutter

Last synced: 2 days ago
JSON representation

Flutter SDK for Bugfender

• Host: GitHub
• URL: https://github.com/bugfender/bugfendersdk-flutter
• Owner: bugfender
• License: bsd-3-clause
• Created: 2019-01-10T09:17:33.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-12T17:40:32.000Z (9 months ago)
• Last Synced: 2024-03-27T12:55:03.557Z (8 months ago)
• Language: Dart
• Homepage: https://bugfender.com
• Size: 118 MB
• Stars: 9
• Watchers: 7
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flutter_bugfender

A Bugfender Wrapper plugin (implementing native code) for Flutter Projects.

**Note:** This plugin was provided by the community, hence it is published "AS IS", our support might not always be able to help you.

## Using the package

Edit `pubspec.yaml` and add add `flutter_bugfender` to `dependencies`:

```

dependencies:

  flutter:

    sdk: flutter

  flutter_bugfender: ^3.0.0

```

Then run `flutter pub get` (or ‘Packages Get’ in IntelliJ) to download the package.

Edit `lib/main.dart` and add an import:

```dart

import 'package:flutter_bugfender/flutter_bugfender.dart';

```

And wrap your `runApp` statement like this:

```dart

void main() {

  FlutterBugfender.handleUncaughtErrors(() async {

    await FlutterBugfender.init("YOUR_APP_KEY",

        enableCrashReporting: true, // these are optional, but recommended

        enableUIEventLogging: true,

        enableAndroidLogcatLogging: true);

    FlutterBugfender.log("hello world!");

    runApp(new MyApp());

  });

}

```

There are other init options:

* `apiUri` and `baseUri`: alternative URLs for on-premises installations

* `maximumLocalStorageSize`: maximum size the local log cache will use, in bytes

* `printToConsole`: whether to print to console or not

* `enableUIEventLogging`: enable automatic logging of user interactions for native elements.

* `enableCrashReporting`: enable automatic crash reporting for native crashes. To report Dart exceptions see [this](#report-dart-and-flutter-exceptions).

* `enableAndroidLogcatLogging`: enable automatic logging of logcat (Android only)

* `overrideDeviceName`: specify a name for the device (deprecated, prefer `FlutterBugfender.setDeviceString()` instead)

* `version`: app version identifier (Web specific)

* `build`: app build identifier (Web specific)

You can also call:

```dart

FlutterBugfender.log("Working fine!");

FlutterBugfender.fatal("Fatal sent!");

FlutterBugfender.error("Error sent!");

FlutterBugfender.warn("Warning sent!");

FlutterBugfender.info("Info sent!");

FlutterBugfender.debug("Debug sent!");

FlutterBugfender.trace("Trace sent!");

FlutterBugfender.sendLog(

 line: 42,

 method: "someMethod()",

 file:"someFile",

 level: LogLevel.info,

 tag: "Custom tag",

 text: "This is a custom log"

);

FlutterBugfender.setDeviceString("user.email", "[email protected]");

FlutterBugfender.setDeviceInt("user.id", 32);

FlutterBugfender.setDeviceFloat("user.pi", 3.14);

FlutterBugfender.setDeviceBool("user.enabled", true);

FlutterBugfender.removeDeviceKey("user.pi");

FlutterBugfender.sendCrash("Test Crash", "Stacktrace here!");

FlutterBugfender.sendIssue("Test Issue", "Issue value goes here!");

FlutterBugfender.sendUserFeedback("Test user feedback", "User feedback details here!");

FlutterBugfender.setForceEnabled(true);

FlutterBugfender.forceSendOnce();

FlutterBugfender.getDeviceUri());

FlutterBugfender.getSessionUri());

FlutterBugfender.getUserFeedback()); // Show a screen which asks for feedback

```

### Report Dart and Flutter Exceptions

If you need more control on error handling, you can replace the call to `handleUncaughtErrors()` with:

````dart

// Capture Flutter Error

FlutterError.onError = (FlutterErrorDetails details) async {

  FlutterError.presentError(details);

  await FlutterBugfender.sendCrash(details.exception.toString(), details.stack?.toString() ?? "");

};

// Capture Dart Exceptions 

runZonedGuarded(() {

  runApp(new MyApp());;

}, (Object error, StackTrace stack) async {

  await FlutterBugfender.sendCrash(error.toString(), stack.toString());

});

````

# Contributing

## Updating the embedded web library

This library contains a copy of the Bugfender Web SDK, so this library to be loaded without network usage 

and with consistent behavior, at the expense that when the Web SDK changes, we must update the local copy.

To update it, type:

```sh

curl https://js.bugfender.com/bugfender-v2.js -o assets/bugfender.js

```

This is not necessary for iOS and Android, because CocoaPods/Gradle dependency management is integrated.