@agentskit/observability β Type Aliases
API type aliases for @agentskit/observability.
#Type Alias: AxiomSinkObserver
AxiomSinkObserver =
LifecycleObserver
Defined in: packages/observability/src/axiom.ts:22
Lifecycle observer returned by axiomSink.
#Type Alias: BisectOpts
BisectOpts =
object
Defined in: packages/observability/src/replay-bisect.ts:17
Probe limit and optional callback for replayBisect.
#Properties
#maxProbes?
readonlyoptionalmaxProbes?:number
Defined in: packages/observability/src/replay-bisect.ts:18
#onProbe?
readonlyoptionalonProbe?: (changeIndex,result) =>void
Defined in: packages/observability/src/replay-bisect.ts:19
#Parameters
changeIndex
number
result
"pass" | "fail"
#Returns
void
#Type Alias: BisectVerdict
BisectVerdict = {
index:number;kind:"culprit";probes:number; } | {kind:"all_clean";probes:number; } | {kind:"all_broken";probes:number; } | {detail:string;kind:"inconsistent";probes:number; }
Defined in: packages/observability/src/replay-bisect.ts:7
Result of probing a change history for the earliest pass-to-fail transition.
#Type Alias: ChargebackGroupKey
ChargebackGroupKey =
"tenant"|"user"|"skill"|"tool"|"model"|"tenant+user"|"tenant+skill"|"tenant+tool"|"tenant+model"
Defined in: packages/observability/src/cost-chargeback.ts:38
Fields supported as chargeback report grouping keys.
#Type Alias: CostAlertSink
CostAlertSink = (
event) =>void|Promise<void>
Defined in: packages/observability/src/cost-guard-advanced-types.ts:57
Receives cost alerts in registration order.
#Parameters
#event
#Returns
void | Promise<void>
#Type Alias: CostAlertType
CostAlertType =
"cost:threshold"|"cost:exceeded"|"cost:disabled"|"cost:forecast"
Defined in: packages/observability/src/cost-guard-advanced-types.ts:25
Event kinds emitted when a budget threshold, forecast, or disablement occurs.
#Type Alias: CostGuardErrorHandler
CostGuardErrorHandler = (
error) =>void|Promise<void>
Defined in: packages/observability/src/cost-guard.ts:16
Isolated error reporter shared by all cost guards.
#Parameters
#error
unknown
#Returns
void | Promise<void>
#Type Alias: CostGuardMode
CostGuardMode =
"warn"|"reject"|"kill"
Defined in: packages/observability/src/cost-guard-advanced-types.ts:5
Enforcement policy: report only, expose rejection state, or disable the tenant.
#Type Alias: CostReserveResult
CostReserveResult = {
ok:true;reservationId:string;window:CostWindow; } | {ok:false;reason:"quota_exceeded";window:CostWindow; }
Defined in: packages/observability/src/cost-store.ts:45
Outcome of CostStore.reserve. A denied reservation holds nothing.
#Type Alias: DatadogSinkObserver
DatadogSinkObserver =
LifecycleObserver
Defined in: packages/observability/src/datadog.ts:21
Lifecycle observer returned by datadogSink.
#Type Alias: DevtoolsEnvelope
DevtoolsEnvelope = {
protocol:1;serverId:string;since:string;type:"hello"; } | {at:number;event:AgentEvent;seq:number;type:"agent-event"; } | {seq:number;type:"replay-end"; }
Defined in: packages/observability/src/devtools.ts:12
Wire messages for connection setup, event delivery, and replay completion.
#Type Alias: NewRelicSinkObserver
NewRelicSinkObserver =
LifecycleObserver
Defined in: packages/observability/src/new-relic.ts:20
Lifecycle observer returned by newRelicSink.
#Type Alias: ObserverRedactionMode
ObserverRedactionMode =
"redact"|"tokenize"
Defined in: packages/observability/src/redaction.ts:27
Whether observer payloads replace PII or tokenize it through a vault.
#Type Alias: PiiAuditAction
PiiAuditAction =
"pii:redact"|"pii:reveal"|"pii:reveal-denied"
Defined in: packages/observability/src/audit-log.ts:58
Audit action names emitted for PII redaction and reveal events.
#Type Alias: ReplayHandler<E>
ReplayHandler<
E> = (event) =>void|Promise<void>
Defined in: packages/observability/src/replay.ts:10
Asynchronous or synchronous consumer invoked for each replayed event.
#Type Parameters
#E
E
#Parameters
#event
E
#Returns
void | Promise<void>
#Type Alias: ReplayOracle
ReplayOracle = (
changeIndex) =>Promise<"pass"|"fail">
Defined in: packages/observability/src/replay-bisect.ts:14
Replays a history prefix ending at an index and reports whether it passes.
#Parameters
#changeIndex
number
#Returns
Promise<"pass" | "fail">
#Type Alias: ReplayPosition
ReplayPosition =
object
Defined in: packages/observability/src/replay-timeline.ts:120
Selected timeline row and its state difference from the previous step.
#Properties
#cumulative
readonlycumulative:TimelineRow
Defined in: packages/observability/src/replay-timeline.ts:122
#index
readonlyindex:number
Defined in: packages/observability/src/replay-timeline.ts:121
#stateDiffFromPrevious
readonlystateDiffFromPrevious: readonlyStateDiffEntry[]
Defined in: packages/observability/src/replay-timeline.ts:123
#Type Alias: ReplayStep
ReplayStep =
object
Defined in: packages/observability/src/replay-timeline.ts:17
Recorded execution checkpoint consumed by the replay timeline helpers.
#Properties
#costUsd
readonlycostUsd:number
Defined in: packages/observability/src/replay-timeline.ts:24
#id
readonlyid:string
Defined in: packages/observability/src/replay-timeline.ts:18
#latencyMs
readonlylatencyMs:number
Defined in: packages/observability/src/replay-timeline.ts:21
#nodeId
readonlynodeId:string
Defined in: packages/observability/src/replay-timeline.ts:19
#outcome
readonlyoutcome:"ok"|"failed"|"paused"|"skipped"
Defined in: packages/observability/src/replay-timeline.ts:26
#state
readonlystate:Readonly<Record<string,unknown>>
Defined in: packages/observability/src/replay-timeline.ts:25
#timestamp
readonlytimestamp:number
Defined in: packages/observability/src/replay-timeline.ts:20
#tokensIn
readonlytokensIn:number
Defined in: packages/observability/src/replay-timeline.ts:22
#tokensOut
readonlytokensOut:number
Defined in: packages/observability/src/replay-timeline.ts:23
#Type Alias: StateDiffEntry
StateDiffEntry = {
key:string;kind:"add";value:unknown; } | {key:string;kind:"remove";previous:unknown; } | {key:string;kind:"change";previous:unknown;value:unknown; }
Defined in: packages/observability/src/replay-timeline.ts:88
One property addition, removal, or change between two state snapshots.
#Type Alias: Timeline
Timeline =
object
Defined in: packages/observability/src/replay-timeline.ts:42
Timeline rows, totals, and start/end timestamps for a replay.
#Properties
#rows
readonlyrows: readonlyTimelineRow[]
Defined in: packages/observability/src/replay-timeline.ts:43
#span
readonlyspan:object
Defined in: packages/observability/src/replay-timeline.ts:47
#endedAt
readonlyendedAt:number
#startedAt
readonlystartedAt:number
#totalCostUsd
readonlytotalCostUsd:number
Defined in: packages/observability/src/replay-timeline.ts:44
#totalLatencyMs
readonlytotalLatencyMs:number
Defined in: packages/observability/src/replay-timeline.ts:46
#totalTokens
readonlytotalTokens:number
Defined in: packages/observability/src/replay-timeline.ts:45
#Type Alias: TimelineRow
TimelineRow =
object
Defined in: packages/observability/src/replay-timeline.ts:30
Cumulative metrics and outcome at one recorded replay checkpoint.
#Properties
#cumulativeCostUsd
readonlycumulativeCostUsd:number
Defined in: packages/observability/src/replay-timeline.ts:35
#cumulativeLatencyMs
readonlycumulativeLatencyMs:number
Defined in: packages/observability/src/replay-timeline.ts:37
#cumulativeTokens
readonlycumulativeTokens:number
Defined in: packages/observability/src/replay-timeline.ts:36
#index
readonlyindex:number
Defined in: packages/observability/src/replay-timeline.ts:31
#nodeId
readonlynodeId:string
Defined in: packages/observability/src/replay-timeline.ts:33
#outcome
readonlyoutcome:ReplayStep["outcome"]
Defined in: packages/observability/src/replay-timeline.ts:38
#stepId
readonlystepId:string
Defined in: packages/observability/src/replay-timeline.ts:32
#timestamp
readonlytimestamp:number
Defined in: packages/observability/src/replay-timeline.ts:34
#Type Alias: UnknownModelPolicy
UnknownModelPolicy =
"error"|"allow-zero"
Defined in: packages/observability/src/cost-guard.ts:13
Controls whether pricing an unlisted model fails or treats it as free.