Skip to content

Commit b071433

Browse files
authored
add dsm checkpointer typing (#6732)
add typing for DSM checkpointing API
1 parent 58e102c commit b071433

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

index.d.ts

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,11 @@ interface Tracer extends opentracing.Tracer {
134134

135135
dogstatsd: tracer.DogStatsD;
136136

137+
/**
138+
* Data Streams manual checkpointer API.
139+
*/
140+
dataStreamsCheckpointer: tracer.DataStreamsCheckpointer;
141+
137142
/**
138143
* LLM Observability SDK
139144
*/
@@ -1026,6 +1031,29 @@ declare namespace tracer {
10261031
flush(): void
10271032
}
10281033

1034+
/**
1035+
* Manual Data Streams Monitoring checkpointer API.
1036+
*/
1037+
export interface DataStreamsCheckpointer {
1038+
/**
1039+
* Sets a produce checkpoint and injects the DSM context into the provided carrier.
1040+
* @param type The streaming technology (e.g., kafka, kinesis, sns).
1041+
* @param target The target of data (topic, exchange, stream name).
1042+
* @param carrier The carrier object to inject DSM context into.
1043+
*/
1044+
setProduceCheckpoint (type: string, target: string, carrier: any): void;
1045+
1046+
/**
1047+
* Sets a consume checkpoint and extracts DSM context from the provided carrier.
1048+
* @param type The streaming technology (e.g., kafka, kinesis, sns).
1049+
* @param source The source of data (topic, exchange, stream name).
1050+
* @param carrier The carrier object to extract DSM context from.
1051+
* @param manualCheckpoint Whether this checkpoint was manually set. Defaults to true.
1052+
* @returns The DSM context associated with the current pathway.
1053+
*/
1054+
setConsumeCheckpoint (type: string, source: string, carrier: any, manualCheckpoint?: boolean): any;
1055+
}
1056+
10291057
export interface EventTrackingV2 {
10301058
/**
10311059
* Links a successful login event to the current trace. Will link the passed user to the current trace with Appsec.setUser() internally.

0 commit comments

Comments
 (0)