Logs: Models & Envelopes (#2916)

Author: denrase

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Logs: Models & Envelopes ([#2916](https://github.com/getsentry/sentry-dart/pull/2916))
+
 ## 9.0.0-beta.2
 
 ### Fixes

dart/lib/src/protocol.dart

@@ -41,3 +41,6 @@ export 'protocol/span_status.dart';
 export 'sentry_event_like.dart';
 export 'protocol/sentry_feature_flag.dart';
 export 'protocol/sentry_feature_flags.dart';
+export 'protocol/sentry_log.dart';
+export 'protocol/sentry_log_level.dart';
+export 'protocol/sentry_log_attribute.dart';

dart/lib/src/protocol/sentry_log.dart

@@ -0,0 +1,33 @@
+import 'sentry_id.dart';
+import 'sentry_log_level.dart';
+import 'sentry_log_attribute.dart';
+
+class SentryLog {
+  DateTime timestamp;
+  SentryId traceId;
+  SentryLogLevel level;
+  String body;
+  Map<String, SentryLogAttribute> attributes;
+  int? severityNumber;
+
+  SentryLog({
+    required this.timestamp,
+    required this.traceId,
+    required this.level,
+    required this.body,
+    required this.attributes,
+    this.severityNumber,
+  });
+
+  Map<String, dynamic> toJson() {
+    return {
+      'timestamp': timestamp.toIso8601String(),
+      'trace_id': traceId.toString(),
+      'level': level.value,
+      'body': body,
+      'attributes':
+          attributes.map((key, value) => MapEntry(key, value.toJson())),
+      'severity_number': severityNumber ?? level.toSeverityNumber(),
+    };
+  }
+}

dart/lib/src/protocol/sentry_log_attribute.dart

@@ -0,0 +1,30 @@
+class SentryLogAttribute {
+  final dynamic value;
+  final String type;
+
+  const SentryLogAttribute._(this.value, this.type);
+
+  factory SentryLogAttribute.string(String value) {
+    return SentryLogAttribute._(value, 'string');
+  }
+
+  factory SentryLogAttribute.boolean(bool value) {
+    return SentryLogAttribute._(value, 'boolean');
+  }
+
+  factory SentryLogAttribute.integer(int value) {
+    return SentryLogAttribute._(value, 'integer');
+  }
+
+  factory SentryLogAttribute.double(double value) {
+    return SentryLogAttribute._(value, 'double');
+  }
+
+  // In the future the SDK will also support string[], boolean[], integer[], double[] values.
+  Map<String, dynamic> toJson() {
+    return {
+      'value': value,
+      'type': type,
+    };
+  }
+}

dart/lib/src/protocol/sentry_log_level.dart

@@ -0,0 +1,28 @@
+enum SentryLogLevel {
+  trace('trace'),
+  debug('debug'),
+  info('info'),
+  warn('warn'),
+  error('error'),
+  fatal('fatal');
+
+  final String value;
+  const SentryLogLevel(this.value);
+
+  int toSeverityNumber() {
+    switch (this) {
+      case SentryLogLevel.trace:
+        return 1;
+      case SentryLogLevel.debug:
+        return 5;
+      case SentryLogLevel.info:
+        return 9;
+      case SentryLogLevel.warn:
+        return 13;
+      case SentryLogLevel.error:
+        return 17;
+      case SentryLogLevel.fatal:
+        return 21;
+    }
+  }
+}

dart/lib/src/sentry_envelope.dart

@@ -81,6 +81,21 @@ class SentryEnvelope {
     );
   }
 
+  factory SentryEnvelope.fromLogs(
+    List<SentryLog> items,
+    SdkVersion sdkVersion,
+  ) {
+    return SentryEnvelope(
+      SentryEnvelopeHeader(
+        null,
+        sdkVersion,
+      ),
+      [
+        SentryEnvelopeItem.fromLogs(items),
+      ],
+    );
+  }
+
   /// Stream binary data representation of `Envelope` file encoded.
   Stream<List<int>> envelopeStream(SentryOptions options) async* {
     yield utf8JsonEncoder.convert(header.toJson());

dart/lib/src/sentry_envelope_item.dart

@@ -63,6 +63,21 @@ class SentryEnvelopeItem {
     );
   }
 
+  factory SentryEnvelopeItem.fromLogs(List<SentryLog> items) {
+    final payload = {
+      'items': items.map((e) => e.toJson()).toList(),
+    };
+    return SentryEnvelopeItem(
+      SentryEnvelopeItemHeader(
+        SentryItemType.log,
+        itemCount: items.length,
+        contentType: 'application/vnd.sentry.items.log+json',
+      ),
+      () => utf8JsonEncoder.convert(payload),
+      originalObject: payload,
+    );
+  }
+
   /// Header with info about type and length of data in bytes.
   final SentryEnvelopeItemHeader header;
 

dart/lib/src/sentry_envelope_item_header.dart

@@ -2,6 +2,7 @@
 class SentryEnvelopeItemHeader {
   SentryEnvelopeItemHeader(
     this.type, {
+    this.itemCount,
     this.contentType,
     this.fileName,
     this.attachmentType,
@@ -10,6 +11,8 @@ class SentryEnvelopeItemHeader {
   /// Type of encoded data.
   final String type;
 
+  final int? itemCount;
+
   final String? contentType;
 
   final String? fileName;
@@ -19,6 +22,7 @@ class SentryEnvelopeItemHeader {
   /// Item header encoded as JSON
   Future<Map<String, dynamic>> toJson(int length) async {
     return {
+      if (itemCount != null) 'item_count': itemCount,
       if (contentType != null) 'content_type': contentType,
       if (fileName != null) 'filename': fileName,
       if (attachmentType != null) 'attachment_type': attachmentType,

dart/lib/src/sentry_item_type.dart

@@ -5,5 +5,6 @@ class SentryItemType {
   static const String clientReport = 'client_report';
   static const String profile = 'profile';
   static const String statsd = 'statsd';
+  static const String log = 'log';
   static const String unknown = '__unknown__';
 }

dart/test/protocol/sentry_log_attribute_test.dart

@@ -0,0 +1,42 @@
+import 'package:test/test.dart';
+import 'package:sentry/sentry.dart';
+
+void main() {
+  test('$SentryLogAttribute string to json', () {
+    final attribute = SentryLogAttribute.string('test');
+    final json = attribute.toJson();
+    expect(json, {
+      'value': 'test',
+      'type': 'string',
+    });
+  });
+
+  test('$SentryLogAttribute boolean to json', () {
+    final attribute = SentryLogAttribute.boolean(true);
+    final json = attribute.toJson();
+    expect(json, {
+      'value': true,
+      'type': 'boolean',
+    });
+  });
+
+  test('$SentryLogAttribute integer to json', () {
+    final attribute = SentryLogAttribute.integer(1);
+    final json = attribute.toJson();
+
+    expect(json, {
+      'value': 1,
+      'type': 'integer',
+    });
+  });
+
+  test('$SentryLogAttribute double to json', () {
+    final attribute = SentryLogAttribute.double(1.0);
+    final json = attribute.toJson();
+
+    expect(json, {
+      'value': 1.0,
+      'type': 'double',
+    });
+  });
+}