Skip to content

Latest commit

 

History

History
121 lines (93 loc) · 4.01 KB

README.md

File metadata and controls

121 lines (93 loc) · 4.01 KB

Ziton Error

License: MIT

A Flutter package for error monitoring and reporting. Listen for common flutter errors & push error details along with Stack trace, platform & screen information to ziton project dashboard when it occurs at debug level. Production level errors are reported using reportError Function where user can specify custom error message and description, platform and screen information along with error message pushed to ziton dashboard.

Features

  • Error information with context
  • Platform and screen information
  • Error file info with lines causing error
  • Project panel for collaboration
  • Assign & share errors
  • Report error in production mode

Configuration

1. Adding Dependency

Add package name with version to your package's pubspec.yaml file:

dependencies:
  ziton_error 0.0.3

2. Install

Install packages from the command line: with pub:

$ pub get

with Flutter:

$ flutter pub get

3. Import

Import in Dart contains runApp function, you can use:

import 'package:ziton_error/ziton_error.dart';

Usage in debug level

Import package ziton_error and Listen for errors with ZitonError function

//call FlutterError function inside main()
void main() {
  FlutterError.onError = (FlutterErrorDetails errorDetails){
    //report error to ziton
    ZitonError("your dsn",errorDetails);
  };
  runApp(const MyApp());
}

Usage in production level

Import package ziton_error add reportError in catch block with error message and description

 try {
    //something won't work
 } 
 catch (error) {
  //call report error function with parameters dsn,name, filename, description.
    ReportError(
      "https://OokNpSGVsSrzqesUiHBTXHnzFDtGMVoViJdgtXcFNCUmYwhQhwXiouYWbTFy.ziton.live",
      "error function does not exist",
      "main.dart",
      "error in running this code.this code produces error that must be reported to the ziton live"
      );
}

dsn is the unique key provided to each project, look something like this

https://OokNpSGxxxxxxxxxxxxxxxxxxxxxcFNCUmYwhQhwXiouYWbTFy.ziton.live

Dashboard Error View

  • Error Listing with tracking number of occurance sort out based on time

  • Individual Error with meta data and detailed clean view of stack trace

Create project and generate dsn

  • Head on to ziton.live homepage

  • Login to ziton.live

  • click on create new project

  • add name and description of the project

  • choose the stack whether flutter/django

  • here you go 🥳 copy your dsn and add to project 😍

Project info

  • select red mark on top right side of the project card

  • project dsn
  • deleting project
  • add collaberators

can be done from this screen

Additional information

head on to Ziton Home for further information.