Added tracing to DB

Author: rpanic

packages/persistance/src/PrismaDatabaseConnection.ts

@@ -3,8 +3,10 @@ import {
   sequencerModule,
   SequencerModule,
   StorageDependencyMinimumDependencies,
+  Tracer,
 } from "@proto-kit/sequencer";
 import { DependencyFactory, OmitKeys } from "@proto-kit/common";
+import { inject } from "tsyringe";
 
 import { PrismaStateService } from "./services/prisma/PrismaStateService";
 import { PrismaBatchStore } from "./services/prisma/PrismaBatchStore";
@@ -38,6 +40,10 @@ export class PrismaDatabaseConnection
   extends SequencerModule<PrismaDatabaseConfig>
   implements DependencyFactory, PrismaConnection
 {
+  public constructor(@inject("Tracer") private readonly tracer: Tracer) {
+    super();
+  }
+
   private initializedClient: PrismaClient | undefined = undefined;
 
   public get prismaClient(): PrismaClient {
@@ -53,7 +59,7 @@ export class PrismaDatabaseConnection
   > {
     return {
       asyncStateService: {
-        useFactory: () => new PrismaStateService(this, "batch"),
+        useFactory: () => new PrismaStateService(this, "batch", this.tracer),
       },
       batchStorage: {
         useClass: PrismaBatchStore,
@@ -65,7 +71,7 @@ export class PrismaDatabaseConnection
         useClass: PrismaBlockStorage,
       },
       unprovenStateService: {
-        useFactory: () => new PrismaStateService(this, "block"),
+        useFactory: () => new PrismaStateService(this, "block", this.tracer),
       },
       settlementStorage: {
         useClass: PrismaSettlementStorage,

packages/persistance/src/RedisConnection.ts

@@ -2,11 +2,13 @@ import { createClient, RedisClientType } from "redis";
 import {
   SequencerModule,
   StorageDependencyMinimumDependencies,
+  Tracer,
 } from "@proto-kit/sequencer";
 import { DependencyFactory } from "@proto-kit/common";
 import isArray from "lodash/isArray";
 
 import { RedisMerkleTreeStore } from "./services/redis/RedisMerkleTreeStore";
+import { inject } from "tsyringe";
 
 export interface RedisConnectionConfig {
   host: string;
@@ -26,6 +28,10 @@ export class RedisConnectionModule
   extends SequencerModule<RedisConnectionConfig>
   implements DependencyFactory, RedisConnection
 {
+  public constructor(@inject("Tracer") private readonly tracer: Tracer) {
+    super();
+  }
+
   private client?: RedisClientType;
 
   public get redisClient(): RedisClientType {
@@ -43,13 +49,15 @@ export class RedisConnectionModule
   > {
     return {
       asyncMerkleStore: {
-        useFactory: () => new RedisMerkleTreeStore(this),
+        useFactory: () => new RedisMerkleTreeStore(this, this.tracer),
       },
       unprovenMerkleStore: {
-        useFactory: () => new RedisMerkleTreeStore(this, "unproven"),
+        useFactory: () =>
+          new RedisMerkleTreeStore(this, this.tracer, "unproven"),
       },
       blockTreeStore: {
-        useFactory: () => new RedisMerkleTreeStore(this, "blockHash"),
+        useFactory: () =>
+          new RedisMerkleTreeStore(this, this.tracer, "blockHash"),
       },
     };
   }

packages/persistance/src/services/prisma/PrismaStateService.ts

@@ -1,4 +1,9 @@
-import { AsyncStateService, StateEntry } from "@proto-kit/sequencer";
+import {
+  AsyncStateService,
+  StateEntry,
+  Tracer,
+  trace,
+} from "@proto-kit/sequencer";
 import { Field } from "o1js";
 import { Prisma } from "@prisma/client";
 import { noop } from "@proto-kit/common";
@@ -19,12 +24,15 @@ export class PrismaStateService implements AsyncStateService {
   /**
    * @param connection
    * @param mask A indicator to which masking level the values belong
+   * @param tracer
    */
   public constructor(
     private readonly connection: PrismaConnection,
-    private readonly mask: string
+    private readonly mask: string,
+    public readonly tracer: Tracer
   ) {}
 
+  @trace("db.state.commit")
   public async commit(): Promise<void> {
     const { prismaClient } = this.connection;
 

packages/persistance/src/services/prisma/PrismaTransactionStorage.ts

@@ -1,5 +1,10 @@
 import { inject, injectable } from "tsyringe";
-import { PendingTransaction, TransactionStorage } from "@proto-kit/sequencer";
+import {
+  PendingTransaction,
+  trace,
+  Tracer,
+  TransactionStorage,
+} from "@proto-kit/sequencer";
 
 import type { PrismaConnection } from "../../PrismaDatabaseConnection";
 
@@ -9,9 +14,11 @@ import { TransactionMapper } from "./mappers/TransactionMapper";
 export class PrismaTransactionStorage implements TransactionStorage {
   public constructor(
     @inject("Database") private readonly connection: PrismaConnection,
-    private readonly transactionMapper: TransactionMapper
+    private readonly transactionMapper: TransactionMapper,
+    @inject("Tracer") public readonly tracer: Tracer
   ) {}
 
+  @trace("db.txs.get")
   public async getPendingUserTransactions(): Promise<PendingTransaction[]> {
     const { prismaClient } = this.connection;
 

packages/persistance/src/services/redis/RedisMerkleTreeStore.ts

@@ -2,6 +2,8 @@ import {
   AsyncMerkleTreeStore,
   MerkleTreeNode,
   MerkleTreeNodeQuery,
+  trace,
+  Tracer,
 } from "@proto-kit/sequencer";
 import { log, noop } from "@proto-kit/common";
 
@@ -12,6 +14,7 @@ export class RedisMerkleTreeStore implements AsyncMerkleTreeStore {
 
   public constructor(
     private readonly connection: RedisConnection,
+    public readonly tracer: Tracer,
     private readonly mask: string = "base"
   ) {}
 
@@ -23,6 +26,7 @@ export class RedisMerkleTreeStore implements AsyncMerkleTreeStore {
     noop();
   }
 
+  @trace("db.tree.commit")
   public async commit(): Promise<void> {
     const start = Date.now();
     const array: [string, string][] = this.cache.map(
@@ -45,6 +49,7 @@ export class RedisMerkleTreeStore implements AsyncMerkleTreeStore {
     this.cache = [];
   }
 
+  @trace("db.tree.read")
   public async getNodesAsync(
     nodes: MerkleTreeNodeQuery[]
   ): Promise<(bigint | undefined)[]> {

packages/sequencer/src/index.ts

@@ -102,5 +102,6 @@ export * from "./settlement/transactions/MinaTransactionSender";
 export * from "./settlement/transactions/MinaTransactionSimulator";
 export * from "./settlement/transactions/MinaSimulationService";
 export * from "./logging/Tracer";
+export * from "./logging/trace";
 export * from "./logging/ConsoleLoggingFactory";
 export * from "./logging/ConsoleTracer";