agentskit.js

AdvancedCostGuard

Auto-generated API reference for AdvancedCostGuard.

Interface: AdvancedCostGuard

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

Production-grade cost guard. Extends the multi-tenant guard with modes (warn / reject / kill), rolling window caps, threshold + forecast alerts, and pluggable sinks. Closes #787–#789.

#Extends

  • Observer

#Properties

#costUsd

costUsd: (tenant) => number

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

#Parameters

tenant

string

#Returns

number


#enable

enable: (tenant) => void

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

Re-enable a tenant disabled by kill mode. Caller must also clear the persisted flag.

#Parameters

tenant

string

#Returns

void


#isDisabled

isDisabled: (tenant) => boolean

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

#Parameters

tenant

string

#Returns

boolean


#isRejected

isRejected: (tenant) => boolean

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

Reject mode only: true when this tenant has tripped the overall budget or an active window's 100% cap. Window-only rejections clear when the window rolls; overall rejections last until reset. Always false in warn / kill modes.

#Parameters

tenant

string

#Returns

boolean


#name

name: string

Defined in: core/dist/chat-Du42KmMf.d.ts:166

#Inherited from

Observer.name


#on

on: (event) => void | Promise<void>

Defined in: core/dist/chat-Du42KmMf.d.ts:167

#Parameters

event

AgentEvent

#Returns

void | Promise<void>

#Inherited from

Observer.on


#reset

reset: (tenant?) => void

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

#Parameters

tenant?

string

#Returns

void


#setTenant

setTenant: (tenant) => void

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

#Parameters

tenant

string | undefined

#Returns

void


#tenants

tenants: () => string[]

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

#Returns

string[]


#windowSpend

windowSpend: (tenant, window) => number | undefined

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

#Parameters

tenant

string

window

string

#Returns

number | undefined

Explore nearby

✎ Edit this page on GitHubΒ·Found a problem? Open an issue β†’Β·How to contribute β†’

On this page

Ask the docs
Ask anything about AgentsKit. Answers come from the docs corpus and cite their sources.