Interface: AdvancedCostGuardOptions

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

#Properties

#alertSinks?

optional alertSinks?: CostAlertSink[]

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

One or more alert sinks. Fired in registration order.

---

#budgets

budgets: Record<string, number>

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

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

---

#caps?

optional caps?: CostCaps

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

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

---

#defaultBudgetUsd?

optional defaultBudgetUsd?: number

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

Fallback overall budget for tenants not listed.

---

#disableRuntime?

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

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

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). Failures are isolated; kill state stays fail-closed disabled.

#Parameters

tenant

string

reason

string

#Returns

void | Promise<void>

---

#mode?

optional mode?: CostGuardMode

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

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

---

#modelOverride?

optional modelOverride?: string

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

---

#name?

optional name?: string

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

---

#now?

optional now?: () => number

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

Clock override for tests. Throws / non-finite values are isolated.

#Returns

number

---

#onError?

optional onError?: CostGuardErrorHandler

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

Isolated sink for internal / callback / sink failures.

---

#prices?

optional prices?: Record<string, TokenPrice>

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

---

#tenantCaps?

optional tenantCaps?: Record<string, CostCaps>

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

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

---

#tenantOf?

optional tenantOf?: () => string | undefined

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

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

#Returns

string | undefined

Explore nearby

• Peer
  AdvancedCostGuard

  Auto-generated API reference for AdvancedCostGuard.

• Peer
  AppendAuditInput

  Auto-generated API reference for AppendAuditInput.

• Peer
  AuditEntry

  Auto-generated API reference for AuditEntry.