Add integration for logging package (#631)

ueman · web-flow · commit 6b305d6579ed · 2021-12-02T09:55:19.000+01:00
diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
@@ -4,6 +4,8 @@ on:
     branches:
       - main
   pull_request:
+    paths-ignore:
+      - 'logging/**'
 defaults:
   run:
     shell: bash
diff --git a/.github/workflows/flutter.yml b/.github/workflows/flutter.yml
@@ -4,6 +4,8 @@ on:
     branches:
       - main
   pull_request:
+    paths-ignore:
+      - 'logging/**'
 defaults:
   run:
     shell: bash
diff --git a/.github/workflows/logging.yml b/.github/workflows/logging.yml
@@ -0,0 +1,97 @@
+name: logging
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+defaults:
+  run:
+    shell: bash
+jobs:
+  build:
+    name: Build ${{matrix.sdk}} on ${{matrix.os}}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 20
+    defaults:
+      run:
+        working-directory: ./logging
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        sdk: [stable, beta, dev]
+        exclude:
+          # Bad state: Could not run tests with Observatory enabled. Try setting a different port with --port option.
+          - os: ubuntu-latest
+            sdk: beta
+          # hanging often
+          - os: ubuntu-latest
+            sdk: dev
+          - os: macos-latest
+            sdk: beta
+          # macos-latest is taking hours due to limited resources
+          - os: macos-latest
+            sdk: dev
+
+    steps:
+        - uses: dart-lang/setup-dart@v1
+          with:
+            sdk: ${{ matrix.sdk }}
+        - uses: actions/checkout@v2
+        # coverage with 'chrome' platform hangs the build
+        - name: Test (VM and browser)
+          run: |
+            dart pub get
+            dart test -p chrome
+            dart test -p vm --coverage=coverage
+            dart pub run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.packages --report-on=lib
+
+        - uses: codecov/codecov-action@v1
+          if: runner.os == 'Linux'
+          with:
+            name: sentry
+            file: ./logging/coverage/lcov.info
+        
+        - uses: VeryGoodOpenSource/very_good_coverage@v1.1.1
+          if: runner.os == 'Linux'
+          with:
+            path: "./logging/coverage/lcov.info"
+            min_coverage: 90
+
+  analyze:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    defaults:
+      run:
+        working-directory: ./dart
+    steps:
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: stable
+      - uses: actions/checkout@v2
+      - run: |
+          dart pub get
+          dart analyze --fatal-infos
+          dart format --set-exit-if-changed ./
+
+  package-analysis:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v2
+      - uses: axel-op/dart-package-analyzer@v3
+        id: analysis
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          relativePath: dart/
+      - name: Check scores
+        env:
+          TOTAL: ${{ steps.analysis.outputs.total }}
+          TOTAL_MAX: ${{ steps.analysis.outputs.total_max }}
+        run: |
+          PERCENTAGE=$(( $TOTAL * 100 / $TOTAL_MAX ))
+          if (( $PERCENTAGE < 100 ))
+          then
+            echo Score too low!
+            exit 1
+          fi
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # Unreleased
 
+* Feat: Integration for `logging` (#631)
 * Feat: Add logger name to `SentryLogger` and send errors in integrations to the registered logger (#641)
 
 # 6.1.2
diff --git a/logging/.gitignore b/logging/.gitignore
@@ -0,0 +1,10 @@
+# Files and directories created by pub.
+.dart_tool/
+.packages
+
+# Conventional directory for build outputs.
+build/
+
+# Omit committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
diff --git a/logging/CHANGELOG.md b/logging/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/logging/README.md b/logging/README.md
@@ -0,0 +1,49 @@
+# Sentry integration for `logging` package
+===========
+
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+| package | build | pub | likes | popularity | pub points |
+| ------- | ------- | ------- | ------- | ------- | ------- |
+| sentry | [![build](https://github.com/getsentry/sentry-dart/workflows/logging/badge.svg?branch=main)](https://github.com/getsentry/sentry-dart/actions?query=workflow%3Alogging) | [![pub package](https://img.shields.io/pub/v/sentry_logging.svg)](https://pub.dev/packages/sentry_logging) | [![likes](https://badges.bar/sentry_logging/likes)](https://pub.dev/packages/sentry_logging/score) | [![popularity](https://badges.bar/sentry_logging/popularity)](https://pub.dev/packages/sentry_logging/score) | [![pub points](https://badges.bar/sentry_logging/pub%20points)](https://pub.dev/packages/sentry_logging/score)
+
+Integration for the [`logging`](https://pub.dev/packages/logging) package.
+
+#### Usage
+
+- Sign up for a Sentry.io account and get a DSN at http://sentry.io.
+
+- Follow the installing instructions on [pub.dev](https://pub.dev/packages/sentry/install).
+
+- Initialize the Sentry SDK using the DSN issued by Sentry.io and add the `LoggingIntegration`
+
+```dart
+import 'package:sentry/sentry.dart';
+
+Future<void> main() async {
+  await Sentry.init(
+    (options) {
+      options.dsn = 'https://example@sentry.io/example';
+      options.addIntegration(LoggingIntegration());
+    },
+    appRunner: initApp, // Init your App.
+  );
+}
+
+void initApp() {
+  // your app code
+}
+```
+
+#### Resources
+
+* [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dart/)
+* [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
+* [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)
+* [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](https://stackoverflow.com/questions/tagged/sentry)
+* [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)
diff --git a/logging/analysis_options.yaml b/logging/analysis_options.yaml
@@ -0,0 +1,33 @@
+include: package:lints/recommended.yaml
+
+analyzer:
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+  language:
+    strict-raw-types: true
+  errors:
+    # treat missing required parameters as a warning (not a hint)
+    missing_required_param: error
+    # treat missing returns as a warning (not a hint)
+    missing_return: error
+    # allow having TODOs in the code
+    todo: ignore
+    # allow self-reference to deprecated members (we do this because otherwise we have
+    # to annotate every member in every test, assert, etc, when we deprecate something)
+    deprecated_member_use_from_same_package: warning
+    # ignore sentry/path on pubspec as we change it on deployment
+    invalid_dependency: ignore
+  exclude:
+    - example/**
+
+linter:
+  rules:
+    - prefer_final_locals
+    - public_member_api_docs
+    - prefer_single_quotes
+    - prefer_relative_imports
+    - unnecessary_brace_in_string_interps
+    - implementation_imports
+    - require_trailing_commas
+    - unawaited_futures
diff --git a/logging/example/sentry_logging_example.dart b/logging/example/sentry_logging_example.dart
@@ -0,0 +1,34 @@
+import 'package:sentry_logging/sentry_logging.dart';
+import 'dart:async';
+import 'package:sentry/sentry.dart';
+import 'package:logging/logging.dart';
+
+Future<void> main() async {
+  // ATTENTION: Change the DSN below with your own to see the events in Sentry. Get one at sentry.io
+  const dsn =
+      'https://9934c532bf8446ef961450973c898537@o447951.ingest.sentry.io/5428562';
+
+  await Sentry.init(
+    (options) {
+      options.dsn = dsn;
+      options.addIntegration(LoggingIntegration());
+    },
+    appRunner: runApp,
+  );
+}
+
+Future<void> runApp() async {
+  final log = Logger('MyAwesomeLogger');
+
+  log.warning('a warning!');
+
+  try {
+    throw Exception();
+  } catch (error, stackTrace) {
+    // The log from above will be contained in this crash report.
+    await Sentry.captureException(
+      error,
+      stackTrace: stackTrace,
+    );
+  }
+}
diff --git a/logging/lib/sentry_logging.dart b/logging/lib/sentry_logging.dart
@@ -0,0 +1,3 @@
+library sentry_logging;
+
+export 'src/logging_integration.dart';
diff --git a/logging/lib/src/extension.dart b/logging/lib/src/extension.dart
@@ -0,0 +1,54 @@
+// ignore_for_file: public_member_api_docs
+
+import 'package:logging/logging.dart';
+import 'package:sentry/sentry.dart';
+import 'package:sentry/sentry_io.dart';
+
+extension LogRecordX on LogRecord {
+  Breadcrumb toBreadcrumb() {
+    return Breadcrumb(
+      category: 'log',
+      type: 'debug',
+      timestamp: time,
+      level: level.toSentryLevel(),
+      message: message,
+      data: <String, Object>{
+        if (object != null) 'LogRecord.object': object!,
+        if (error != null) 'LogRecord.error': error!,
+        if (stackTrace != null) 'LogRecord.stackTrace': stackTrace!,
+        'LogRecord.loggerName': loggerName,
+        'LogRecord.sequenceNumber': sequenceNumber,
+      },
+    );
+  }
+
+  SentryEvent toEvent() {
+    return SentryEvent(
+      logger: loggerName,
+      level: level.toSentryLevel(),
+      message: SentryMessage(message),
+      throwable: error,
+      extra: <String, Object>{
+        if (object != null) 'LogRecord.object': object!,
+        'LogRecord.sequenceNumber': sequenceNumber,
+      },
+    );
+  }
+}
+
+extension LogLevelX on Level {
+  SentryLevel? toSentryLevel() {
+    return <Level, SentryLevel?>{
+      Level.ALL: SentryLevel.debug,
+      Level.FINEST: SentryLevel.debug,
+      Level.FINER: SentryLevel.debug,
+      Level.FINE: SentryLevel.debug,
+      Level.CONFIG: SentryLevel.debug,
+      Level.INFO: SentryLevel.info,
+      Level.WARNING: SentryLevel.warning,
+      Level.SEVERE: SentryLevel.error,
+      Level.SHOUT: SentryLevel.fatal,
+      Level.OFF: null,
+    }[this];
+  }
+}
diff --git a/logging/lib/src/logging_integration.dart b/logging/lib/src/logging_integration.dart
@@ -0,0 +1,76 @@
+import 'dart:async';
+
+import 'package:logging/logging.dart';
+import 'package:sentry/sentry.dart';
+import 'version.dart';
+import 'extension.dart';
+
+/// An [Integration] which listens to all messages of the
+/// [logging](https://pub.dev/packages/logging) package.
+class LoggingIntegration extends Integration<SentryOptions> {
+  /// Creates the [LoggingIntegration].
+  ///
+  /// All log events equal or higher than [minBreadcrumbLevel] are recorded as a
+  /// [Breadcrumb].
+  /// All log events equal or higher than [minEventLevel] are recorded as a
+  /// [SentryEvent].
+  LoggingIntegration({
+    Level minBreadcrumbLevel = Level.INFO,
+    Level minEventLevel = Level.SEVERE,
+  })  : _minBreadcrumbLevel = minBreadcrumbLevel,
+        _minEventLevel = minEventLevel;
+
+  final Level _minBreadcrumbLevel;
+  final Level _minEventLevel;
+  late StreamSubscription<LogRecord> _subscription;
+  late Hub _hub;
+
+  @override
+  FutureOr<void> call(Hub hub, SentryOptions options) {
+    _hub = hub;
+    _setSdkVersion(options);
+    _subscription = Logger.root.onRecord.listen(
+      _onLog,
+      onError: (Object error, StackTrace stackTrace) async {
+        await _hub.captureException(error, stackTrace: stackTrace);
+      },
+    );
+    options.sdk.addIntegration('LoggingIntegration');
+  }
+
+  @override
+  Future<void> close() async {
+    await super.close();
+    await _subscription.cancel();
+  }
+
+  void _setSdkVersion(SentryOptions options) {
+    final sdk = SdkVersion(
+      name: sdkName,
+      version: sdkVersion,
+      integrations: options.sdk.integrations,
+      packages: options.sdk.packages,
+    );
+    sdk.addPackage('pub:sentry_logging', sdkVersion);
+    options.sdk = sdk;
+  }
+
+  bool _isLoggable(Level logLevel, Level minLevel) {
+    return logLevel >= minLevel;
+  }
+
+  void _onLog(LogRecord record) async {
+    // The event must be logged first, otherwise the log would also be added
+    // to the breadcrumbs for itself.
+    if (_isLoggable(record.level, _minEventLevel)) {
+      await _hub.captureEvent(
+        record.toEvent(),
+        stackTrace: record.stackTrace,
+      );
+    }
+
+    if (_isLoggable(record.level, _minBreadcrumbLevel)) {
+      _hub.addBreadcrumb(record.toBreadcrumb());
+    }
+  }
+}
diff --git a/logging/lib/src/version.dart b/logging/lib/src/version.dart
@@ -0,0 +1,5 @@
+/// The SDK version reported to Sentry.io in the submitted events.
+const String sdkVersion = '6.2.0';
+
+/// The default SDK name reported to Sentry.io in the submitted events.
+const String sdkName = 'sentry.dart.logging';
diff --git a/logging/pubspec.yaml b/logging/pubspec.yaml
diff --git a/logging/test/logging_integration_test.dart b/logging/test/logging_integration_test.dart
diff --git a/logging/test/mock_hub.dart b/logging/test/mock_hub.dart
diff --git a/logging/test/version_test.dart b/logging/test/version_test.dart

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+library sentry_logging;`
	`2`	`+`
	`3`	`+export 'src/logging_integration.dart';`