DiagnosticCapture
Defined in: packages/devtools/src/capture.ts:37
Bounded explicit capture. No content is retained before start.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DiagnosticCapture(
getKey?,options?):DiagnosticCapture
Defined in: packages/devtools/src/capture.ts:67
Creates an inactive capture with optional redaction and bounds.
Parameters
Section titled “Parameters”getKey?
Section titled “getKey?”() => string | null
options?
Section titled “options?”CaptureOptions = {}
Returns
Section titled “Returns”DiagnosticCapture
Methods
Section titled “Methods”addRedactor()
Section titled “addRedactor()”addRedactor(
redact): () =>void
Defined in: packages/devtools/src/capture.ts:151
Composes an application policy into an existing store, including retained evidence. Policies should be idempotent.
Parameters
Section titled “Parameters”redact
Section titled “redact”(value) => unknown
Returns
Section titled “Returns”() => void
clear()
Section titled “clear()”clear():
void
Defined in: packages/devtools/src/capture.ts:126
Clears retained evidence and notes.
Returns
Section titled “Returns”void
engineRequest()
Section titled “engineRequest()”engineRequest(
message):void
Defined in: packages/devtools/src/capture.ts:301
Records request identity and update reasons.
Parameters
Section titled “Parameters”message
Section titled “message”ChartRequestMessage
Returns
Section titled “Returns”void
engineResponse()
Section titled “engineResponse()”engineResponse(
requestId,response,durationMs):void
Defined in: packages/devtools/src/capture.ts:310
Records a correlated Engine response.
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
response
Section titled “response”MaelstromResponse
durationMs
Section titled “durationMs”number
Returns
Section titled “Returns”void
export()
Section titled “export()”export(
outcome?):string
Defined in: packages/devtools/src/capture.ts:334
Serializes retained evidence using capture schema version 1.
Parameters
Section titled “Parameters”outcome?
Section titled “outcome?”string = ...
Returns
Section titled “Returns”string
getEvidenceRevision()
Section titled “getEvidenceRevision()”getEvidenceRevision():
number
Defined in: packages/devtools/src/capture.ts:60
Returns a revision for capture evidence changes, including redaction. Note edits update status separately.
Returns
Section titled “Returns”number
getLimits()
Section titled “getLimits()”getLimits():
Required<Pick<CaptureOptions,"maxEvents"|"maxCharacters"|"maxStringCharacters">>
Defined in: packages/devtools/src/capture.ts:76
Returns the configured event, serialized-character, and string limits.
Returns
Section titled “Returns”Required<Pick<CaptureOptions, "maxEvents" | "maxCharacters" | "maxStringCharacters">>
getSnapshot()
Section titled “getSnapshot()”getSnapshot():
object
Defined in: packages/devtools/src/capture.ts:58
Returns retained capture status.
Returns
Section titled “Returns”object
active
Section titled “active”active:
boolean
count:
number
dropped
Section titled “dropped”dropped:
number
optionalmode?:string
outcome
Section titled “outcome”outcome:
string
observations()
Section titled “observations()”observations(
snapshot,identity,initial?):void
Defined in: packages/devtools/src/capture.ts:259
Records observation changes and post-start transcript revisions.
Parameters
Section titled “Parameters”snapshot
Section titled “snapshot”VoiceObservationSnapshot
identity
Section titled “identity”Fields
initial?
Section titled “initial?”boolean = false
Returns
Section titled “Returns”void
record()
Section titled “record()”record(
kind,fields):void
Defined in: packages/devtools/src/capture.ts:188
Records one event only during an explicit capture.
Parameters
Section titled “Parameters”string
fields
Section titled “fields”Fields
Returns
Section titled “Returns”void
sessionEvent()
Section titled “sessionEvent()”sessionEvent(
input,identity):void
Defined in: packages/devtools/src/capture.ts:225
Projects supported voice events without retaining raw provider frames.
Parameters
Section titled “Parameters”unknown
identity
Section titled “identity”Fields
Returns
Section titled “Returns”void
setOutcome()
Section titled “setOutcome()”setOutcome(
outcome):void
Defined in: packages/devtools/src/capture.ts:324
Retains a redacted note, limited to 4000 characters.
Parameters
Section titled “Parameters”outcome
Section titled “outcome”string
Returns
Section titled “Returns”void
start()
Section titled “start()”start(
mode,sessionId?,providerInstanceId?):void
Defined in: packages/devtools/src/capture.ts:97
Starts a new capture and clears earlier evidence. Omit identities to capture all Provider lifetimes.
Parameters
Section titled “Parameters”string
sessionId?
Section titled “sessionId?”string
providerInstanceId?
Section titled “providerInstanceId?”string
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: packages/devtools/src/capture.ts:117
Stops recording and retains the evidence.
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>boolean
Defined in: packages/devtools/src/capture.ts:62
Observes changes until unsubscribed.
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”() => boolean