sentry_flutter library
A Flutter client for Sentry.io crash reporting.
Classes
- Breadcrumb
- Structed data to describe more information pior to the event Sentry.captureEvent.
- Contexts
- The context interfaces provide additional context data.
- DebugImage
- The list of debug images contains all dynamic libraries loaded into the process and their memory addresses. Instruction addresses in the Stack Trace are mapped into the list of debug images in order to retrieve debug files for symbolication. There are two kinds of debug images: Native debug images with types macho, elf, and pe Android debug images with type proguard more details : https://develop.sentry.dev/sdk/event-payloads/debugmeta/
- DebugMeta
- The debug meta interface carries debug information for processing errors and crash reports.
- Dsn
- The Data Source Name (DSN) tells the SDK where to send the events
- FlutterErrorIntegration
- Integration that capture errors on the FlutterError.onError handler.
- Hub
- SDK API contract which combines a client and scope management
- HubAdapter
- Hub adapter to make Integrations testable
-
Integration<
T extends SentryOptions> - Code that provides middlewares, bindings or hooks into certain frameworks or environments, along with code that inserts those bindings and activates them.
- IsolateErrorIntegration
- NoOp web integration : isolate doesnt' work in browser
- LoadAndroidImageListIntegration
- Loads the Android Image list for stack trace symbolication
- LoadContextsIntegration
- Load Device's Contexts from the iOS SDK.
- LoadReleaseIntegration
- An Integration that loads the release version from native apps
- Mechanism
- Sentry Exception Mechanism The exception mechanism is an optional field residing in the Exception Interface. It carries additional information about the way the exception was created on the target system. This includes general exception values obtained from operating system or runtime APIs, as well as mechanism-specific values.
- NativeSdkIntegration
- Enables Sentry's native SDKs (Android and iOS)
- PlatformChecker
- Helper to check in which enviroment the library is running. The envirment checks (release/debug/profile) are mutually exclusive.
- RouteObserverBreadcrumb
- This class makes it easier to record breadcrumbs for events of Flutters NavigationObserver by accepting RouteSettings.
- RunZonedGuardedIntegration
-
Integration that runs runner function within
runZonedGuarded
and capture errors on therunZonedGuarded
error handler. See https://api.dart.dev/stable/dart-async/runZonedGuarded.html - Scope
- Scope data to be sent with the event
- SdkInfo
- An object describing the system SDK.
- SdkVersion
- Describes the SDK that is submitting events to Sentry.
- Sentry
- Sentry SDK main entry point
- SentryApp
- App context describes the application.
- SentryBrowser
- Carries information about the browser or user agent for web-related errors.
- SentryClient
- Logs crash reports and events to the Sentry.io service.
- SentryDevice
- This describes the device that caused the event.
- SentryEvent
- An event to be reported to Sentry.io.
- SentryException
- The Exception Interface specifies an exception or error that occurred in a program.
- SentryFlutterOptions
- This class adds options which are only availble in a Flutter environment. Note that some of these options require native Sentry integration, which is not available on all platforms.
- SentryGpu
- GPU context describes the GPU of the device.
- SentryHttpClient
- A http-package compatible HTTP client which records requests as breadcrumbs.
- SentryId
- Hexadecimal string representing a uuid4 value
- SentryLevel
- Severity of the logged Event.
- SentryMessage
-
The Message Interface carries a log message that describes an event or error.
Optionally, it can carry a format string and structured parameters. This can help to group similar messages into the same issue.
example of a serialized message : {
"message": {
"message": "My raw message with interpreted strings like %s",
"params":
"this"
} } - This is a navigation observer to record navigational breadcrumbs. For now it only records navigation events and no gestures.
- SentryOperatingSystem
- Describes the operating system on which the event was created.
- SentryOptions
- Sentry SDK options
- SentryPackage
-
A SentryPackage part of the
Sdk
. - SentryRequest
- The Request interface contains information on a HTTP request related to the event. In client SDKs, this can be an outgoing request, or the request that rendered the current web page. On server SDKs, this could be the incoming web request that is being handled.
- SentryRuntime
- Describes a runtime in more detail.
- SentryStackFrame
- Frames belong to a StackTrace It should contain at least a filename, function or instruction_addr
- SentryStackTrace
- Stacktrace holds information about the frames of the stack.
- SentryUser
- Describes the current user associated with the application, such as the currently signed in user.
- Transport
- A transport is in charge of sending the event either via http or caching in the disk.
- WidgetsBindingIntegration
- Integration that captures certain window and device events. See also:
- WidgetsFlutterBindingIntegration
- It is necessary to initialize Flutter method channels so that our plugin can call into the native code.
Enums
- SentryOrientation
- If a device is on portrait or landscape mode
Mixins
- SentryFlutter
- Sentry Flutter SDK main entry point
Functions
-
dartLogger(
SentryLevel level, String message) → void - A Logger that prints out the level and message
-
handleIsolateError(
Hub hub, SentryOptions options, dynamic error) → Future< void> -
noOpLogger(
SentryLevel level, String message) → void - A NoOp logger that does nothing
Typedefs
-
AppRunner
= FutureOr<
void> Function() -
Runs a callback inside of the
runZonedGuarded
method, useful for running yourrunApp(MyApp())
- BeforeBreadcrumbCallback = Breadcrumb? Function(Breadcrumb? breadcrumb, {dynamic hint})
- This function is called with an SDK specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped
- BeforeSendCallback = SentryEvent? Function(SentryEvent event, {dynamic hint})
- This function is called with an SDK specific event object and can return a modified event object or nothing to skip reporting the event
- ClockProvider = DateTime Function()
- Used to provide timestamp for logging.
-
EventProcessor
= FutureOr<
SentryEvent?> Function(SentryEvent event, {dynamic hint}) - Are callbacks that run for every event. They can either return a new event which in most cases means just adding data OR return null in case the event will be dropped and not sent.
-
FlutterOptionsConfiguration
= FutureOr<
void> Function(SentryFlutterOptions) - Configuration options callback
-
OptionsConfiguration
= FutureOr<
void> Function(SentryOptions) - Configuration options callback
-
PackageLoader
= Future<
PackageInfo> Function() - a PackageInfo wrapper to make it testable
- ScopeCallback = void Function(Scope)
- Configures the scope through the callback.
- SentryLogger = void Function(SentryLevel level, String message)
- Logger interface to log useful debugging information if debug is enabled
Exceptions / Errors
- ThrowableMechanism
- An Error decorator that holds a Mechanism related to the decorated Error