feat: add new transaction metrics - postman (#1741)

VGau · web-flow · commit 298e981c8781 · 2025-11-20T14:26:06.000+01:00
* feat: add new transaction metrics - postman

* fix: include new db migration

* fix: add counters

* fix: add receipt receive time

* fix: update claim creation date for retries

* fix: add direction to histogram metrics

* fix: update metrics
diff --git a/postman/scripts/runPostman.ts b/postman/scripts/runPostman.ts
@@ -13,6 +13,9 @@ async function main() {
       isCalldataEnabled: process.env.L1_L2_CALLDATA_ENABLED === "true",
       listener: {
         pollingInterval: process.env.L1_LISTENER_INTERVAL ? parseInt(process.env.L1_LISTENER_INTERVAL) : undefined,
+        receiptPollingInterval: process.env.L1_LISTENER_RECEIPT_POLLING_INTERVAL
+          ? parseInt(process.env.L1_LISTENER_RECEIPT_POLLING_INTERVAL)
+          : undefined,
         maxFetchMessagesFromDb: process.env.MAX_FETCH_MESSAGES_FROM_DB
           ? parseInt(process.env.MAX_FETCH_MESSAGES_FROM_DB)
           : undefined,
@@ -76,6 +79,9 @@ async function main() {
       isCalldataEnabled: process.env.L2_L1_CALLDATA_ENABLED === "true",
       listener: {
         pollingInterval: process.env.L2_LISTENER_INTERVAL ? parseInt(process.env.L2_LISTENER_INTERVAL) : undefined,
+        receiptPollingInterval: process.env.L2_LISTENER_RECEIPT_POLLING_INTERVAL
+          ? parseInt(process.env.L2_LISTENER_RECEIPT_POLLING_INTERVAL)
+          : undefined,
         maxFetchMessagesFromDb: process.env.MAX_FETCH_MESSAGES_FROM_DB
           ? parseInt(process.env.MAX_FETCH_MESSAGES_FROM_DB)
           : undefined,
diff --git a/postman/src/application/postman/api/metrics/TransactionMetricsUpdater.ts b/postman/src/application/postman/api/metrics/TransactionMetricsUpdater.ts
@@ -6,13 +6,33 @@ export class TransactionMetricsUpdater implements ITransactionMetricsUpdater {
       LineaPostmanMetrics.TransactionProcessingTime,
       [0.1, 0.5, 1, 2, 3, 5, 7, 10],
       "Time taken to process a transaction",
+      ["direction"],
+    );
+
+    this.metricsService.createHistogram(
+      LineaPostmanMetrics.TransactionInfuraConfirmationTime,
+      [0.1, 0.5, 1, 2, 3, 5, 7, 10],
+      "Time taken to receive the transaction receipt from Infura",
+      ["direction"],
     );
   }
 
-  public addTransactionProcessingTime(transactionProcessingTimeInSeconds: number): void {
+  public addTransactionProcessingTime(direction: string, transactionProcessingTimeInSeconds: number): void {
     return this.metricsService.addValueToHistogram(
       LineaPostmanMetrics.TransactionProcessingTime,
       transactionProcessingTimeInSeconds,
+      { direction },
+    );
+  }
+
+  public addTransactionInfuraConfirmationTime(
+    direction: string,
+    transactionInfuraConfirmationTimeInSeconds: number,
+  ): void {
+    return this.metricsService.addValueToHistogram(
+      LineaPostmanMetrics.TransactionInfuraConfirmationTime,
+      transactionInfuraConfirmationTimeInSeconds,
+      { direction },
     );
   }
 }
diff --git a/postman/src/application/postman/api/metrics/__tests__/TransactionMetricsUpdater.test.ts b/postman/src/application/postman/api/metrics/__tests__/TransactionMetricsUpdater.test.ts
@@ -12,8 +12,8 @@ describe("TransactionMetricsUpdater", () => {
   });
 
   it("should get correct values after add histogram value", async () => {
-    transactionMetricsUpdater.addTransactionProcessingTime(2);
-    transactionMetricsUpdater.addTransactionProcessingTime(3);
+    transactionMetricsUpdater.addTransactionProcessingTime("L1_TO_L2", 2);
+    transactionMetricsUpdater.addTransactionProcessingTime("L1_TO_L2", 3);
 
     const histogramValues = await metricsService.getHistogramMetricsValues(
       LineaPostmanMetrics.TransactionProcessingTime,
diff --git a/postman/src/application/postman/app/PostmanServiceClient.ts b/postman/src/application/postman/app/PostmanServiceClient.ts
@@ -242,7 +242,7 @@ export class PostmanServiceClient {
       l2MessageClaimingPersister,
       {
         direction: Direction.L1_TO_L2,
-        pollingInterval: config.l2Config.listener.pollingInterval,
+        pollingInterval: config.l2Config.listener.receiptPollingInterval,
       },
       new WinstonLogger(`L2${MessagePersistingPoller.name}`, config.loggerOptions),
     );
@@ -369,7 +369,7 @@ export class PostmanServiceClient {
       l1MessageClaimingPersister,
       {
         direction: Direction.L2_TO_L1,
-        pollingInterval: config.l1Config.listener.pollingInterval,
+        pollingInterval: config.l1Config.listener.receiptPollingInterval,
       },
       new WinstonLogger(`L1${MessagePersistingPoller.name}`, config.loggerOptions),
     );
diff --git a/postman/src/application/postman/app/config/__tests__/utils.test.ts b/postman/src/application/postman/app/config/__tests__/utils.test.ts
@@ -96,6 +96,7 @@ describe("Config utils", () => {
             maxBlocksToFetchLogs: DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
             maxFetchMessagesFromDb: DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
             pollingInterval: DEFAULT_LISTENER_INTERVAL,
+            receiptPollingInterval: DEFAULT_LISTENER_INTERVAL,
           },
           messageServiceContractAddress: TEST_CONTRACT_ADDRESS_1,
           rpcUrl: TEST_RPC_URL,
@@ -129,6 +130,7 @@ describe("Config utils", () => {
             maxBlocksToFetchLogs: DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
             maxFetchMessagesFromDb: DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
             pollingInterval: DEFAULT_LISTENER_INTERVAL,
+            receiptPollingInterval: DEFAULT_LISTENER_INTERVAL,
           },
           messageServiceContractAddress: TEST_CONTRACT_ADDRESS_2,
           rpcUrl: TEST_RPC_URL,
@@ -215,6 +217,7 @@ describe("Config utils", () => {
             maxBlocksToFetchLogs: DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
             maxFetchMessagesFromDb: DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
             pollingInterval: DEFAULT_LISTENER_INTERVAL + 1000,
+            receiptPollingInterval: DEFAULT_LISTENER_INTERVAL,
           },
           messageServiceContractAddress: TEST_CONTRACT_ADDRESS_1,
           rpcUrl: TEST_RPC_URL,
@@ -248,6 +251,7 @@ describe("Config utils", () => {
             maxBlocksToFetchLogs: DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
             maxFetchMessagesFromDb: DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
             pollingInterval: DEFAULT_LISTENER_INTERVAL + 1000,
+            receiptPollingInterval: DEFAULT_LISTENER_INTERVAL,
           },
           messageServiceContractAddress: TEST_CONTRACT_ADDRESS_2,
           rpcUrl: TEST_RPC_URL,
diff --git a/postman/src/application/postman/app/config/config.ts b/postman/src/application/postman/app/config/config.ts
@@ -101,6 +101,7 @@ export type ClaimingConfig = Omit<Required<ClaimingOptions>, "feeRecipientAddres
  */
 export type ListenerOptions = {
   pollingInterval?: number;
+  receiptPollingInterval?: number;
   initialFromBlock?: number;
   blockConfirmation?: number;
   maxFetchMessagesFromDb?: number;
diff --git a/postman/src/application/postman/app/config/utils.ts b/postman/src/application/postman/app/config/utils.ts
@@ -57,6 +57,7 @@ export function getConfig(postmanOptions: PostmanOptions): PostmanConfig {
       isCalldataEnabled: l1Options.isCalldataEnabled ?? DEFAULT_CALLDATA_ENABLED,
       listener: {
         pollingInterval: l1Options.listener.pollingInterval ?? DEFAULT_LISTENER_INTERVAL,
+        receiptPollingInterval: l1Options.listener.receiptPollingInterval ?? DEFAULT_LISTENER_INTERVAL,
         maxFetchMessagesFromDb: l1Options.listener.maxFetchMessagesFromDb ?? DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
         maxBlocksToFetchLogs: l1Options.listener.maxBlocksToFetchLogs ?? DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
         initialFromBlock: l1Options.listener.initialFromBlock ?? DEFAULT_INITIAL_FROM_BLOCK,
@@ -92,6 +93,7 @@ export function getConfig(postmanOptions: PostmanOptions): PostmanConfig {
       enableLineaEstimateGas: l2Options.enableLineaEstimateGas ?? false,
       listener: {
         pollingInterval: l2Options.listener.pollingInterval ?? DEFAULT_LISTENER_INTERVAL,
+        receiptPollingInterval: l2Options.listener.receiptPollingInterval ?? DEFAULT_LISTENER_INTERVAL,
         maxFetchMessagesFromDb: l2Options.listener.maxFetchMessagesFromDb ?? DEFAULT_MAX_FETCH_MESSAGES_FROM_DB,
         maxBlocksToFetchLogs: l2Options.listener.maxBlocksToFetchLogs ?? DEFAULT_MAX_BLOCKS_TO_FETCH_LOGS,
         initialFromBlock: l2Options.listener.initialFromBlock ?? DEFAULT_INITIAL_FROM_BLOCK,
diff --git a/postman/src/application/postman/persistence/dataSource.ts b/postman/src/application/postman/persistence/dataSource.ts
@@ -10,6 +10,7 @@ import { DBOptions } from "./config/types";
 import { MessageEntity } from "./entities/Message.entity";
 import { AddCompressedTxSizeColumn1718026260629 } from "./migrations/1718026260629-AddCompressedTxSizeColumn";
 import { AddSponsorshipMetrics1745569276097 } from "./migrations/1745569276097-AddSponsorshipMetrics";
+
 export class DB {
   public static create(config: DBOptions): DataSource {
     return new DataSource({
diff --git a/postman/src/core/metrics/IMetricsService.ts b/postman/src/core/metrics/IMetricsService.ts
@@ -21,6 +21,7 @@ export enum LineaPostmanMetrics {
   SponsorshipFeesGwei = "linea_postman_sponsorship_fees_gwei_total", // Represent up to ~9_007_199 ETH
 
   TransactionProcessingTime = "linea_postman_l2_transaction_tx_processing_time",
+  TransactionInfuraConfirmationTime = "linea_postman_l2_transaction_tx_infura_confirmation_time",
 }
 
 export interface IMetricsService {
diff --git a/postman/src/core/metrics/ITransactionMetricsUpdater.ts b/postman/src/core/metrics/ITransactionMetricsUpdater.ts
@@ -1,3 +1,4 @@
 export interface ITransactionMetricsUpdater {
-  addTransactionProcessingTime(transactionProcessingTimeInSeconds: number): void;
+  addTransactionProcessingTime(direction: string, transactionProcessingTimeInSeconds: number): void;
+  addTransactionInfuraConfirmationTime(direction: string, transactionBroadcastTimeInSeconds: number): void;
 }
diff --git a/postman/src/services/processors/MessageClaimingPersister.ts b/postman/src/services/processors/MessageClaimingPersister.ts
@@ -8,7 +8,7 @@ import {
   JsonRpcProvider,
   ErrorDescription,
 } from "ethers";
-import { Direction, OnChainMessageStatus } from "@consensys/linea-sdk";
+import { OnChainMessageStatus } from "@consensys/linea-sdk";
 import { BaseError } from "../../core/errors";
 import { MessageStatus } from "../../core/enums";
 import { ILogger } from "../../core/utils/logging/ILogger";
@@ -91,7 +91,8 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
 
       const receipt = await this.provider.getTransactionReceipt(firstPendingMessage.claimTxHash);
       if (receipt) {
-        await this.updateReceiptStatus(firstPendingMessage, receipt);
+        const receiptReceivedAt = new Date();
+        await this.updateReceiptStatus(firstPendingMessage, receipt, receiptReceivedAt);
       } else {
         if (!this.isMessageExceededSubmissionTimeout(firstPendingMessage)) return;
         this.logger.warn("Retrying to claim message: messageHash=%s", firstPendingMessage.messageHash);
@@ -108,12 +109,13 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
           firstPendingMessage.messageHash,
         );
         if (!retryTransactionReceipt) return;
+        const receiptReceivedAt = new Date();
         this.logger.warn(
           "Retried claim message transaction succeed: messageHash=%s transactionHash=%s",
           firstPendingMessage.messageHash,
           retryTransactionReceipt.hash,
         );
-        await this.updateReceiptStatus(firstPendingMessage, retryTransactionReceipt);
+        await this.updateReceiptStatus(firstPendingMessage, retryTransactionReceipt, receiptReceivedAt);
       }
     } catch (e) {
       const error = ErrorParser.parseErrorWithMitigation(e);
@@ -161,6 +163,7 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
       const tx = await this.messageServiceContract.retryTransactionWithHigherFee(transactionHash);
 
       this.messageBeingRetry.message?.edit({
+        claimTxCreationDate: new Date(),
         claimTxGasLimit: parseInt(tx.gasLimit.toString()),
         claimTxMaxFeePerGas: tx.maxFeePerGas ?? undefined,
         claimTxMaxPriorityFeePerGas: tx.maxPriorityFeePerGas ?? undefined,
@@ -200,13 +203,25 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
    * @param {Message} message - The message object to update.
    * @param {TransactionReceipt} receipt - The receipt of the claim transaction.
    */
-  private async updateReceiptStatus(message: Message, receipt: TransactionReceipt): Promise<void> {
+  private async updateReceiptStatus(
+    message: Message,
+    receipt: TransactionReceipt,
+    receiptReceivedAt: Date,
+  ): Promise<void> {
     let processingTimeInSeconds: number | undefined;
-    if (this.config.direction === Direction.L1_TO_L2 && message.claimTxCreationDate) {
+    let infuraConfirmationTimeInSeconds: number | undefined;
+
+    if (message.claimTxCreationDate) {
       const block = await this.provider.getBlock(receipt.blockNumber);
       if (block) {
         processingTimeInSeconds = block.timestamp - message.claimTxCreationDate.getTime() / 1_000;
-        this.transactionMetricsUpdater.addTransactionProcessingTime(processingTimeInSeconds);
+        infuraConfirmationTimeInSeconds = (receiptReceivedAt.getTime() - message.claimTxCreationDate.getTime()) / 1_000;
+
+        this.transactionMetricsUpdater.addTransactionProcessingTime(this.config.direction, processingTimeInSeconds);
+        this.transactionMetricsUpdater.addTransactionInfuraConfirmationTime(
+          this.config.direction,
+          infuraConfirmationTimeInSeconds,
+        );
       }
     }
 
@@ -234,7 +249,10 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
         "Message claim transaction has been REVERTED: messageHash=%s transactionHash=%s",
         message.messageHash,
         receipt.hash,
-        { ...(processingTimeInSeconds ? { processingTimeInSeconds } : {}) },
+        {
+          ...(processingTimeInSeconds ? { processingTimeInSeconds } : {}),
+          ...(infuraConfirmationTimeInSeconds ? { infuraConfirmationTimeInSeconds } : {}),
+        },
       );
       return;
     }
@@ -256,7 +274,10 @@ export class MessageClaimingPersister implements IMessageClaimingPersister {
       "Message has been SUCCESSFULLY claimed: messageHash=%s transactionHash=%s",
       message.messageHash,
       receipt.hash,
-      { ...(processingTimeInSeconds ? { processingTimeInSeconds } : {}) },
+      {
+        ...(processingTimeInSeconds ? { processingTimeInSeconds } : {}),
+        ...(infuraConfirmationTimeInSeconds ? { infuraConfirmationTimeInSeconds } : {}),
+      },
     );
   }
 }
diff --git a/postman/src/services/processors/__tests__/MessageClaimingPersister.test.ts b/postman/src/services/processors/__tests__/MessageClaimingPersister.test.ts
@@ -340,6 +340,7 @@ describe("TestMessageClaimingPersister ", () => {
         claimTxGasLimit: Number(retryTxResponse.gasLimit),
         claimNumberOfRetry: 1,
         claimLastRetriedAt: mockedDate,
+        claimTxCreationDate: expect.any(Date),
       });
       const { loggerWarnSpy, messageRepositoryUpdateSpy, l2QuerierGetReceiptSpy } = testFixtureFactory({
         firstPendingMessage: testPendingMessageLocal,
@@ -394,6 +395,7 @@ describe("TestMessageClaimingPersister ", () => {
         claimTxGasLimit: Number(retryTxResponse.gasLimit),
         claimNumberOfRetry: 1,
         claimLastRetriedAt: mockedDate,
+        claimTxCreationDate: expect.any(Date),
       });
       const { loggerWarnSpy, messageRepositoryUpdateSpy, l2QuerierGetReceiptSpy } = testFixtureFactory({
         firstPendingMessage: testPendingMessageLocal,
diff --git a/postman/src/utils/testing/constants.ts b/postman/src/utils/testing/constants.ts
@@ -208,6 +208,7 @@ export const testL1NetworkConfig: L1NetworkConfig = {
   },
   listener: {
     pollingInterval: 4000,
+    receiptPollingInterval: 4000,
     maxFetchMessagesFromDb: 3,
     initialFromBlock: DEFAULT_INITIAL_FROM_BLOCK,
     blockConfirmation: DEFAULT_LISTENER_BLOCK_CONFIRMATIONS,
@@ -237,6 +238,7 @@ export const testL2NetworkConfig: L2NetworkConfig = {
   },
   listener: {
     pollingInterval: 100,
+    receiptPollingInterval: 100,
     maxFetchMessagesFromDb: 3,
     initialFromBlock: 10,
     blockConfirmation: DEFAULT_LISTENER_BLOCK_CONFIRMATIONS,

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ export enum LineaPostmanMetrics {`
`21`	`21`	`SponsorshipFeesGwei = "linea_postman_sponsorship_fees_gwei_total", // Represent up to ~9_007_199 ETH`
`22`	`22`
`23`	`23`	`TransactionProcessingTime = "linea_postman_l2_transaction_tx_processing_time",`
	`24`	`+ TransactionInfuraConfirmationTime = "linea_postman_l2_transaction_tx_infura_confirmation_time",`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`export interface IMetricsService {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`export interface ITransactionMetricsUpdater {`
`2`		`- addTransactionProcessingTime(transactionProcessingTimeInSeconds: number): void;`
	`2`	`+ addTransactionProcessingTime(direction: string, transactionProcessingTimeInSeconds: number): void;`
	`3`	`+ addTransactionInfuraConfirmationTime(direction: string, transactionBroadcastTimeInSeconds: number): void;`
`3`	`4`	`}`