agentskit.js

AdvancedCostGuardOptions

Auto-generated API reference for AdvancedCostGuardOptions.

Interface: AdvancedCostGuardOptions

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

#Properties

#alertSinks?

optional alertSinks?: CostAlertSink[]

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

One or more alert sinks. Fired in registration order.


#budgets

budgets: Record<string, number>

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

Per-tenant USD budgets (overall, applied alongside windows).


#caps?

optional caps?: CostCaps

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

Window caps applied to every tenant. Per-tenant overrides via tenantCaps.


#defaultBudgetUsd?

optional defaultBudgetUsd?: number

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

Fallback overall budget for tenants not listed.


#disableRuntime?

optional disableRuntime?: (tenant, reason) => void | Promise<void>

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

Called when a tenant is disabled in 'kill' mode. Must persist the disabled state (Redis flag, DB row) so the runtime stays disabled across restarts. The tenant is re-enabled only via your own out-of-band call (e.g. an admin API).

#Parameters

tenant

string

reason

string

#Returns

void | Promise<void>


#mode?

optional mode?: CostGuardMode

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

Enforcement mode (default 'warn'). 'kill' requires disableRuntime.


#modelOverride?

optional modelOverride?: string

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


#name?

optional name?: string

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


#now?

optional now?: () => number

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

Clock override for tests.

#Returns

number


#prices?

optional prices?: Record<string, TokenPrice>

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


#tenantCaps?

optional tenantCaps?: Record<string, CostCaps>

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

Per-tenant override of caps. Wins over the workspace-wide caps.


#tenantOf?

optional tenantOf?: () => string | undefined

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

Active tenant resolver (same shape as multiTenantCostGuard.tenantOf).

#Returns

string | undefined

Explore nearby

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

On this page