Skip to content

feat(satp-hermes): multi gateway metrics #4056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(satp-hermes): multi gateway metrics #4056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions packages/cactus-plugin-satp-hermes/src/main/typescript/core/session-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,3 +1057,26 @@ export function getMessageInSessionData(
throw new Error("Message type not found");
}
}

export function collectSessionAttributes(
session: SATPSession,
sessionSide: "client" | "server",
) {
let data: SessionData;
if (sessionSide === "client") {
data = session.getClientSessionData?.() || {};
} else {
data = session.getServerSessionData?.() || {};
}

return {
senderNetworkId: data.senderAsset?.networkId?.id,
receiverNetworkId: data.receiverAsset?.networkId?.id,
senderGatewayNetworkId: data.senderGatewayNetworkId,
receiverGatewayNetworkId: data.recipientGatewayNetworkId,
assetProfileId: data.assetProfileId,
sessionId: session.getSessionId?.(),
sourceLedgerAssetId: data.sourceLedgerAssetId,
recipientLedgerAssetId: data.recipientLedgerAssetId,
};
}
75 changes: 27 additions & 48 deletions packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-handlers/stage0-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ import {
SenderGatewayNetworkIdError,
SessionNotFoundError,
} from "../errors/satp-handler-errors";
import { saveMessageInSessionData, setError } from "../session-utils";
import {
collectSessionAttributes,
saveMessageInSessionData,
setError,
} from "../session-utils";
import { MessageType } from "../../generated/proto/cacti/satp/v02/common/message_pb";
import { getMessageTypeName } from "../satp-utils";
import { MonitorService } from "../../services/monitoring/monitor";
Expand Down Expand Up @@ -78,10 +82,6 @@ export class Stage0SATPHandler implements SATPHandler {
const fnTag = `${this.getHandlerIdentifier()}#${stepTag}`;
const { span, context: ctx } = this.monitorService.startSpan(fnTag);
return context.with(ctx, async () => {
const attributes: Record<
string,
undefined | string | number | boolean | string[] | number[] | boolean[]
> = {};
let session: SATPSession | undefined;
try {
this.Log.debug(`${fnTag}, New Session...`);
Expand Down Expand Up @@ -123,26 +123,16 @@ export class Stage0SATPHandler implements SATPHandler {

saveMessageInSessionData(session.getServerSessionData(), message);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
attributes.satp_phase = 0;
attributes.operation = "newSession";
const attributes: Record<
string,
| undefined
| string
| number
| boolean
| string[]
| number[]
| boolean[]
> = collectSessionAttributes(session, "server");

const startTimestamp =
session.getServerSessionData().receivedTimestamps?.stage0
Expand All @@ -156,7 +146,11 @@ export class Stage0SATPHandler implements SATPHandler {
await this.monitorService.recordHistogram(
"operation_duration",
duration,
attributes,
{ ...attributes, satp_phase: 0, operation: "newSession" },
);
} else {
this.Log.warn(
`${fnTag}, Missing timestamps for operation duration calculation`,
);
}

Expand Down Expand Up @@ -187,7 +181,7 @@ export class Stage0SATPHandler implements SATPHandler {
const fnTag = `${this.getHandlerIdentifier()}#${stepTag}`;
const { span, context: ctx } = this.monitorService.startSpan(fnTag);
return context.with(ctx, async () => {
const attributes: Record<
let attributes: Record<
string,
undefined | string | number | boolean | string[] | number[] | boolean[]
> = {};
Expand Down Expand Up @@ -226,26 +220,7 @@ export class Stage0SATPHandler implements SATPHandler {

saveMessageInSessionData(session.getServerSessionData(), message);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
attributes.satp_phase = 0;
attributes.operation = "preSATPTransfer";
attributes = collectSessionAttributes(session, "server");

const startTimestamp =
session.getServerSessionData().receivedTimestamps?.stage0
Expand All @@ -259,7 +234,11 @@ export class Stage0SATPHandler implements SATPHandler {
await this.monitorService.recordHistogram(
"operation_duration",
duration,
attributes,
{ ...attributes, satp_phase: 0, operation: "preSATPTransfer" },
);
} else {
this.Log.warn(
`${fnTag}, Missing timestamps for operation duration calculation`,
);
}

Expand Down
151 changes: 39 additions & 112 deletions packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-handlers/stage1-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@ import { PreSATPTransferResponse } from "../../generated/proto/cacti/satp/v02/se
import { stringify as safeStableStringify } from "safe-stable-stringify";
import { getMessageTypeName } from "../satp-utils";
import { MessageType } from "../../generated/proto/cacti/satp/v02/common/message_pb";
import { saveMessageInSessionData, setError } from "../session-utils";
import {
collectSessionAttributes,
saveMessageInSessionData,
setError,
} from "../session-utils";
import { BridgeManagerClientInterface } from "../../cross-chain-mechanisms/bridge/interfaces/bridge-manager-client-interface";
import { MonitorService } from "../../services/monitoring/monitor";
import { context, SpanStatusCode } from "@opentelemetry/api";
Expand Down Expand Up @@ -77,10 +81,6 @@ export class Stage1SATPHandler implements SATPHandler {
const fnTag = `${this.getHandlerIdentifier()}#${stepTag}`;
const { span, context: ctx } = this.monitorService.startSpan(fnTag);
return context.with(ctx, async () => {
const attributes: Record<
string,
undefined | string | number | boolean | string[] | number[] | boolean[]
> = {};
let session: SATPSession | undefined;
try {
this.Log.debug(`${fnTag}, Transfer Proposal...`);
Expand Down Expand Up @@ -124,33 +124,23 @@ export class Stage1SATPHandler implements SATPHandler {
span.setAttribute("sessionId", session.getSessionId());
span.setAttribute(
"senderNetworkId",
session?.getServerSessionData().senderAsset?.networkId?.id ?? "",
session.getServerSessionData().senderAsset?.networkId?.id ?? "",
);
span.setAttribute(
"receiverNetworkId",
session?.getServerSessionData().receiverAsset?.networkId?.id ?? "",
session.getServerSessionData().receiverAsset?.networkId?.id ?? "",
);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
attributes.satp_phase = 1;
attributes.operation = "transferProposal";
const attributes: Record<
string,
| undefined
| string
| number
| boolean
| string[]
| number[]
| boolean[]
> = collectSessionAttributes(session, "server");

const startTimestamp =
session.getServerSessionData().receivedTimestamps?.stage1
Expand All @@ -164,7 +154,11 @@ export class Stage1SATPHandler implements SATPHandler {
await this.monitorService.recordHistogram(
"operation_duration",
duration,
attributes,
{ ...attributes, satp_phase: 1, operation: "transferProposal" },
);
} else {
this.Log.warn(
`${fnTag}, Missing timestamps for operation duration calculation`,
);
}

Expand Down Expand Up @@ -198,7 +192,7 @@ export class Stage1SATPHandler implements SATPHandler {
const fnTag = `${this.getHandlerIdentifier()}#${stepTag}`;
const { span, context: ctx } = this.monitorService.startSpan(fnTag);
return context.with(ctx, async () => {
const attributes: Record<
let attributes: Record<
string,
undefined | string | number | boolean | string[] | number[] | boolean[]
> = {};
Expand All @@ -215,31 +209,14 @@ export class Stage1SATPHandler implements SATPHandler {
span.setAttribute("sessionId", session.getSessionId());
span.setAttribute(
"senderNetworkId",
session?.getServerSessionData().senderAsset?.networkId?.id ?? "",
session.getServerSessionData().senderAsset?.networkId?.id ?? "",
);
span.setAttribute(
"receiverNetworkId",
session?.getServerSessionData().receiverAsset?.networkId?.id ?? "",
session.getServerSessionData().receiverAsset?.networkId?.id ?? "",
);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
attributes = collectSessionAttributes(session, "server");

this.monitorService.updateCounter(
"initiated_transactions",
Expand Down Expand Up @@ -277,28 +254,6 @@ export class Stage1SATPHandler implements SATPHandler {
}

saveMessageInSessionData(session.getServerSessionData(), message);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
attributes.satp_phase = 1;
attributes.operation = "transferCommence";

const startTimestamp =
session.getServerSessionData().receivedTimestamps?.stage1
?.transferCommenceRequestMessageTimestamp;
Expand All @@ -311,7 +266,11 @@ export class Stage1SATPHandler implements SATPHandler {
await this.monitorService.recordHistogram(
"operation_duration",
duration,
attributes,
{ ...attributes, satp_phase: 1, operation: "transferCommence" },
);
} else {
this.Log.warn(
`${fnTag}, Missing timestamps for operation duration calculation`,
);
}

Expand All @@ -325,26 +284,11 @@ export class Stage1SATPHandler implements SATPHandler {
)}`,
);
setError(session, MessageType.TRANSFER_COMMENCE_RESPONSE, error);

attributes.senderNetworkId =
session?.getServerSessionData().senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getServerSessionData().receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getServerSessionData().senderGatewayNetworkId || undefined;
attributes.receiverGatewayNetworkId =
session?.getServerSessionData().recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getServerSessionData().assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getServerSessionData().sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getServerSessionData().recipientLedgerAssetId || undefined;
if (session) {
attributes = collectSessionAttributes(session, "server");
}
attributes.satp_phase = 1;
attributes.operation = "transferCommence";

this.monitorService.updateCounter(
"ongoing_transactions",
Expand Down Expand Up @@ -468,7 +412,7 @@ export class Stage1SATPHandler implements SATPHandler {
const fnTag = `${this.getHandlerIdentifier()}#${stepTag}`;
const { span, context: ctx } = this.monitorService.startSpan(fnTag);
return context.with(ctx, async () => {
const attributes: Record<
let attributes: Record<
string,
undefined | string | number | boolean | string[] | number[] | boolean[]
> = {};
Expand Down Expand Up @@ -522,26 +466,9 @@ export class Stage1SATPHandler implements SATPHandler {
);
setError(session, MessageType.TRANSFER_COMMENCE_REQUEST, error);

attributes.senderNetworkId =
session?.getClientSessionData()?.senderAsset?.networkId?.id ||
undefined;
attributes.receiverNetworkId =
session?.getClientSessionData()?.receiverAsset?.networkId?.id ||
undefined;
attributes.senderGatewayNetworkId =
session?.getClientSessionData()?.senderGatewayNetworkId ||
undefined;
attributes.receiverGatewayNetworkId =
session?.getClientSessionData()?.recipientGatewayNetworkId ||
undefined;
attributes.assetProfileId =
session?.getClientSessionData()?.assetProfileId || undefined;
attributes.sessionId = session?.getSessionId() || undefined;
attributes.sourceLedgerAssetId =
session?.getClientSessionData()?.sourceLedgerAssetId || undefined;
attributes.recipientLedgerAssetId =
session?.getClientSessionData()?.recipientLedgerAssetId ||
undefined;
if (session) {
attributes = collectSessionAttributes(session, "client");
}
attributes.satp_phase = 1;

this.monitorService.updateCounter(
Expand Down
Loading
Loading