Skip to content
AgentsKit

@agentskit/observability — Type Aliases

API type aliases for @agentskit/observability.

#Type Alias: AxiomSinkObserver

AxiomSinkObserver = LifecycleObserver

Defined in: observability/src/axiom.ts:20


#Type Alias: BisectOpts

BisectOpts = object

Defined in: observability/src/replay-bisect.ts:14

#Properties

#maxProbes?

readonly optional maxProbes?: number

Defined in: observability/src/replay-bisect.ts:15


#onProbe?

readonly optional onProbe?: (changeIndex, result) => void

Defined in: observability/src/replay-bisect.ts:16

#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: observability/src/replay-bisect.ts:6


#Type Alias: ChargebackGroupKey

ChargebackGroupKey = "tenant" | "user" | "skill" | "tool" | "model" | "tenant+user" | "tenant+skill" | "tenant+tool" | "tenant+model"

Defined in: observability/src/cost-chargeback.ts:37


#Type Alias: CostAlertSink

CostAlertSink = (event) => void | Promise<void>

Defined in: observability/src/cost-guard-advanced-types.ts:50

#Parameters

#event

CostAlertEvent

#Returns

void | Promise<void>


#Type Alias: CostAlertType

CostAlertType = "cost:threshold" | "cost:exceeded" | "cost:disabled" | "cost:forecast"

Defined in: observability/src/cost-guard-advanced-types.ts:20


#Type Alias: CostGuardErrorHandler

CostGuardErrorHandler = (error) => void | Promise<void>

Defined in: observability/src/cost-guard.ts:14

Isolated error reporter shared by all cost guards.

#Parameters

#error

unknown

#Returns

void | Promise<void>


#Type Alias: CostGuardMode

CostGuardMode = "warn" | "reject" | "kill"

Defined in: observability/src/cost-guard-advanced-types.ts:3


#Type Alias: DatadogSinkObserver

DatadogSinkObserver = LifecycleObserver

Defined in: observability/src/datadog.ts:19


#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: observability/src/devtools.ts:10


#Type Alias: NewRelicSinkObserver

NewRelicSinkObserver = LifecycleObserver

Defined in: observability/src/new-relic.ts:18


#Type Alias: ObserverRedactionMode

ObserverRedactionMode = "redact" | "tokenize"

Defined in: observability/src/redaction.ts:26

Wrap any Observer so PII is redacted (or tokenized) in event payloads before they hit the underlying sink. Without this, even with send-side redaction in place, sensitive data leaks through Langfuse / Braintrust / local trace storage / replay snapshots.

The wrapper edits content fields only (llm:end.content, tool:start.args, tool:end.result, agent:delegate:end.result). It deliberately does NOT touch numeric / structural fields like usage, durationMs, messageCount, latencyMs, step — those carry no PII risk and breaking their numeric type would corrupt downstream dashboards.

Closes issue #792.


#Type Alias: PiiAuditAction

PiiAuditAction = "pii:redact" | "pii:reveal" | "pii:reveal-denied"

Defined in: observability/src/audit-log.ts:51


#Type Alias: ReplayHandler<E>

ReplayHandler<E> = (event) => void | Promise<void>

Defined in: observability/src/replay.ts:9

#Type Parameters

#E

E

#Parameters

#event

E

#Returns

void | Promise<void>


#Type Alias: ReplayOracle

ReplayOracle = (changeIndex) => Promise<"pass" | "fail">

Defined in: observability/src/replay-bisect.ts:12

#Parameters

#changeIndex

number

#Returns

Promise<"pass" | "fail">


#Type Alias: ReplayPosition

ReplayPosition = object

Defined in: observability/src/replay-timeline.ts:104

#Properties

#cumulative

readonly cumulative: TimelineRow

Defined in: observability/src/replay-timeline.ts:106


#index

readonly index: number

Defined in: observability/src/replay-timeline.ts:105


#stateDiffFromPrevious

readonly stateDiffFromPrevious: readonly StateDiffEntry[]

Defined in: observability/src/replay-timeline.ts:107


#Type Alias: ReplayStep

ReplayStep = object

Defined in: observability/src/replay-timeline.ts:16

#Properties

#costUsd

readonly costUsd: number

Defined in: observability/src/replay-timeline.ts:23


#id

readonly id: string

Defined in: observability/src/replay-timeline.ts:17


#latencyMs

readonly latencyMs: number

Defined in: observability/src/replay-timeline.ts:20


#nodeId

readonly nodeId: string

Defined in: observability/src/replay-timeline.ts:18


#outcome

readonly outcome: "ok" | "failed" | "paused" | "skipped"

Defined in: observability/src/replay-timeline.ts:25


#state

readonly state: Readonly<Record<string, unknown>>

Defined in: observability/src/replay-timeline.ts:24


#timestamp

readonly timestamp: number

Defined in: observability/src/replay-timeline.ts:19


#tokensIn

readonly tokensIn: number

Defined in: observability/src/replay-timeline.ts:21


#tokensOut

readonly tokensOut: number

Defined in: observability/src/replay-timeline.ts:22


#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: observability/src/replay-timeline.ts:79


#Type Alias: Timeline

Timeline = object

Defined in: observability/src/replay-timeline.ts:39

#Properties

#rows

readonly rows: readonly TimelineRow[]

Defined in: observability/src/replay-timeline.ts:40


#span

readonly span: object

Defined in: observability/src/replay-timeline.ts:44

#endedAt

readonly endedAt: number

#startedAt

readonly startedAt: number


#totalCostUsd

readonly totalCostUsd: number

Defined in: observability/src/replay-timeline.ts:41


#totalLatencyMs

readonly totalLatencyMs: number

Defined in: observability/src/replay-timeline.ts:43


#totalTokens

readonly totalTokens: number

Defined in: observability/src/replay-timeline.ts:42


#Type Alias: TimelineRow

TimelineRow = object

Defined in: observability/src/replay-timeline.ts:28

#Properties

#cumulativeCostUsd

readonly cumulativeCostUsd: number

Defined in: observability/src/replay-timeline.ts:33


#cumulativeLatencyMs

readonly cumulativeLatencyMs: number

Defined in: observability/src/replay-timeline.ts:35


#cumulativeTokens

readonly cumulativeTokens: number

Defined in: observability/src/replay-timeline.ts:34


#index

readonly index: number

Defined in: observability/src/replay-timeline.ts:29


#nodeId

readonly nodeId: string

Defined in: observability/src/replay-timeline.ts:31


#outcome

readonly outcome: ReplayStep["outcome"]

Defined in: observability/src/replay-timeline.ts:36


#stepId

readonly stepId: string

Defined in: observability/src/replay-timeline.ts:30


#timestamp

readonly timestamp: number

Defined in: observability/src/replay-timeline.ts:32


#Type Alias: UnknownModelPolicy

UnknownModelPolicy = "error" | "allow-zero"

Defined in: observability/src/cost-guard.ts:11

Explore nearby