Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add db attibutes to spans
  • Loading branch information
buenaflor committed Sep 5, 2023
commit 6aa04fac02447956cf06314e98c4c1f4ac4c7c23
10 changes: 10 additions & 0 deletions sqflite/lib/src/sentry_batch.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import 'package:sqflite/sqflite.dart';
// ignore: implementation_imports
import 'package:sqflite_common/src/sql_builder.dart';

import '../sentry_sqflite.dart';
import 'sentry_database.dart';

/// A [Batch] wrapper that adds Sentry support.
Expand Down Expand Up @@ -47,8 +48,13 @@ class SentryBatch implements Batch {
SentryDatabase.dbOp,
description: _buffer.toString().trim(),
);

// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteBatch;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _batch.apply(
Expand Down Expand Up @@ -86,6 +92,10 @@ class SentryBatch implements Batch {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteBatch;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _batch.commit(
Expand Down
18 changes: 18 additions & 0 deletions sqflite/lib/src/sentry_database.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import 'package:meta/meta.dart';
import 'package:sentry/sentry.dart';
import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart' as p;

import '../sentry_sqflite.dart';
import 'sentry_database_executor.dart';
import 'sentry_sqflite_transaction.dart';
import 'version.dart';
Expand Down Expand Up @@ -31,6 +33,15 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
static const dbSqlQueryOp = 'db.sql.query';

static const _dbSqlOp = 'db.sql.transaction';
@internal
// ignore: public_member_api_docs
static const dbSystem = 'db.system';
@internal
// ignore: public_member_api_docs
static const dbName = 'db.name';
@internal
// ignore: public_member_api_docs
static String? currentDbName;

/// ```dart
/// import 'package:sqflite/sqflite.dart';
Expand All @@ -48,6 +59,7 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
final options = _hub.options;
options.sdk.addIntegration('SentrySqfliteTracing');
options.sdk.addPackage(packageName, sdkVersion);
currentDbName = p.basenameWithoutExtension(_database.path);
}

// TODO: check if perf is enabled
Expand All @@ -63,6 +75,8 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabase;

currentDbName = null;

try {
await _database.close();

Expand Down Expand Up @@ -113,6 +127,10 @@ class SentryDatabase extends SentryDatabaseExecutor implements Database {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabase;
span?.setData(dbSystem, 'sqlite');
if (currentDbName != null) {
span?.setData(dbName, currentDbName);
}

Future<T> newAction(Transaction txn) async {
final executor =
Expand Down
45 changes: 45 additions & 0 deletions sqflite/lib/src/sentry_database_executor.dart
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result =
Expand Down Expand Up @@ -68,8 +72,13 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
SentryDatabase.dbSqlExecuteOp,
description: sql,
);
span?.setData(SentryDatabase.dbSystem, 'sqlite');
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
await _executor.execute(sql, arguments);
Expand Down Expand Up @@ -107,6 +116,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.insert(
Expand Down Expand Up @@ -163,6 +176,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.query(
Expand Down Expand Up @@ -226,6 +243,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.queryCursor(
Expand Down Expand Up @@ -266,6 +287,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.rawDelete(sql, arguments);
Expand Down Expand Up @@ -294,6 +319,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.rawInsert(sql, arguments);
Expand Down Expand Up @@ -325,6 +354,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.rawQuery(sql, arguments);
Expand Down Expand Up @@ -357,6 +390,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.rawQueryCursor(
Expand Down Expand Up @@ -389,6 +426,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.rawUpdate(sql, arguments);
Expand Down Expand Up @@ -430,6 +471,10 @@ class SentryDatabaseExecutor implements DatabaseExecutor {
);
// ignore: invalid_use_of_internal_member
span?.origin = SentryTraceOrigins.autoDbSqfliteDatabaseExecutor;
span?.setData(SentryDatabase.dbSystem, 'sqlite');
if (SentryDatabase.currentDbName != null) {
span?.setData(SentryDatabase.dbName, SentryDatabase.currentDbName);
}

try {
final result = await _executor.update(
Expand Down
1 change: 1 addition & 0 deletions sqflite/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies:
sqflite: ^2.0.0
sqflite_common: ^2.0.0
meta: ^1.3.0
path: ^1.8.3

dev_dependencies:
lints: ^2.0.0
Expand Down
47 changes: 47 additions & 0 deletions sqflite/test/sentry_batch_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,53 @@ SELECT * FROM Product''';
await db.close();
});

test('apply creates db span with dbSystem and dbName attributes', () async {
final db = await fixture.getDatabase();
final batch = db.batch();

batch.insert('Product', <String, Object?>{'title': 'Product 1'});

await batch.apply();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystem], 'sqlite');
expect(span.data[SentryDatabase.dbName], SentryDatabase.currentDbName);

await db.close();
});

test('commit creates db span with dbSystem and dbName attributes',
() async {
final db = await fixture.getDatabase();
final batch = db.batch();

batch.insert('Product', <String, Object?>{'title': 'Product 1'});

await batch.commit();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystem], 'sqlite');
expect(span.data[SentryDatabase.dbName], SentryDatabase.currentDbName);

await db.close();
});

test('dbName attribute is null if currentDbName is null', () async {
final db = await fixture.getDatabase();
final batch = db.batch();
SentryDatabase.currentDbName = null;

batch.insert('Product', <String, Object?>{'title': 'Product 1'});

await batch.commit();

final span = fixture.tracer.children.last;
expect(span.data[SentryDatabase.dbSystem], 'sqlite');
expect(span.data[SentryDatabase.dbName], isNull);

await db.close();
});

tearDown(() {
databaseFactory = sqfliteDatabaseFactoryDefault;
});
Expand Down
Loading