Sentry Structured Logs (#2919)

* Logs: Models & Envelopes (#2916)

* Logs: Integrate in Sentry Client (#2920)

* [Structured Logs]: Expose Public API (#2940)

* update changelog entry

---------

Co-authored-by: Giancarlo Buenaflor <[email protected]>

Author: denrase

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+### Features
+
+- Sentry Structured Logs ([#2919](https://github.com/getsentry/sentry-dart/pull/2919))
+  - The old `SentryLogger` has been renamed to `SdkLogCallback` and can be accessed through `options.log` now.
+  - Adds support for structured logging though `Sentry.logger`:
+```dart
+// Enable in `SentryOptions`:
+options.enableLogs = true;
+
+// Use `Sentry.logger`
+Sentry.logger.info("This is a info log.");
+Sentry.logger.warn("This is a warning log with attributes.", attributes: {
+  'string-attribute': SentryLogAttribute.string('string'),
+  'int-attribute': SentryLogAttribute.int(1),
+  'double-attribute': SentryLogAttribute.double(1.0),
+  'bool-attribute': SentryLogAttribute.bool(true),
+});
+```
+
 ### Enhancements
 
 - Align User Feedback API ([#2949](https://github.com/getsentry/sentry-dart/pull/2949))

dart/lib/sentry.dart

@@ -60,3 +60,4 @@ export 'src/utils/tracing_utils.dart';
 export 'src/utils/url_details.dart';
 // ignore: invalid_export_of_internal_element
 export 'src/utils/breadcrumb_log_level.dart';
+export 'src/sentry_logger.dart';

dart/lib/src/client_reports/discarded_event.dart

@@ -64,6 +64,8 @@ extension _DataCategoryExtension on DataCategory {
         return 'security';
       case DataCategory.unknown:
         return 'unknown';
+      case DataCategory.logItem:
+        return 'log_item';
       case DataCategory.feedback:
         return 'feedback';
       case DataCategory.metricBucket:

dart/lib/src/diagnostic_logger.dart renamed to dart/lib/src/diagnostic_log.dart

@@ -1,12 +1,12 @@
 import 'protocol.dart';
 import 'sentry_options.dart';
 
-class DiagnosticLogger {
+class DiagnosticLog {
   final SentryOptions _options;
-  final SentryLogger _logger;
-  SentryLogger get logger => _logger;
+  final SdkLogCallback _logger;
+  SdkLogCallback get logger => _logger;
 
-  DiagnosticLogger(this._logger, this._options);
+  DiagnosticLog(this._logger, this._options);
 
   void log(
     SentryLevel level,

dart/lib/src/event_processor/deduplication_event_processor.dart

@@ -32,7 +32,7 @@ class DeduplicationEventProcessor implements EventProcessor {
     }
 
     if (!_options.enableDeduplication) {
-      _options.logger(SentryLevel.debug, 'Deduplication is disabled');
+      _options.log(SentryLevel.debug, 'Deduplication is disabled');
       return event;
     }
     return _deduplicate(event);
@@ -52,7 +52,7 @@ class DeduplicationEventProcessor implements EventProcessor {
     final exceptionHashCode = exception.hashCode;
 
     if (_exceptionToDeduplicate.contains(exceptionHashCode)) {
-      _options.logger(
+      _options.log(
         SentryLevel.info,
         'Duplicated exception detected. '
         'Event ${event.eventId} will be discarded.',

dart/lib/src/event_processor/enricher/io_platform_memory.dart

@@ -87,7 +87,7 @@ class PlatformMemory {
         return result.stdout.toString();
       }
     } catch (e) {
-      options.logger(SentryLevel.warning, "Failed to run process: $e");
+      options.log(SentryLevel.warning, "Failed to run process: $e");
       if (options.automatedTestMode) {
         rethrow;
       }

dart/lib/src/event_processor/exception/io_exception_event_processor.dart

@@ -71,7 +71,7 @@ class IoExceptionEventProcessor implements ExceptionEventProcessor {
       var uri = Uri.parse(address.host);
       request = SentryRequest.fromUri(uri: uri);
     } catch (exception, stackTrace) {
-      _options.logger(
+      _options.log(
         SentryLevel.error,
         'Could not parse ${address.host} to Uri',
         exception: exception,

dart/lib/src/event_processor/run_event_processors.dart

@@ -25,7 +25,7 @@ Future<SentryEvent?> runEventProcessors(
       final e = processor.apply(processedEvent!, hint);
       processedEvent = e is Future<SentryEvent?> ? await e : e;
     } catch (exception, stackTrace) {
-      options.logger(
+      options.log(
         SentryLevel.error,
         'An exception occurred while processing event by a processor',
         exception: exception,
@@ -47,7 +47,7 @@ Future<SentryEvent?> runEventProcessors(
           count: spanCountBeforeEventProcessors + 1,
         );
       }
-      options.logger(SentryLevel.debug, 'Event was dropped by a processor');
+      options.log(SentryLevel.debug, 'Event was dropped by a processor');
       break;
     } else if (event is SentryTransaction &&
         processedEvent is SentryTransaction) {

dart/lib/src/http_client/io_client_provider.dart

@@ -36,13 +36,13 @@ class IoClientProvider implements ClientProvider {
     }
     final pac = proxy.toPacString();
     if (proxy.type == SentryProxyType.socks) {
-      options.logger(
+      options.log(
         SentryLevel.warning,
         "Setting proxy '$pac' is not supported.",
       );
       return Client();
     }
-    options.logger(
+    options.log(
       SentryLevel.info,
       "Setting proxy '$pac'",
     );