Skip to main content

CostTracker

Struct CostTracker 

Source
pub struct CostTracker { /* private fields */ }
Expand description

Thread-safe cumulative cost tracker.

Construct once per run (or share one per session), attach it to a crate::token_counter::TokenTrackingLLM with with_cost_tracker, optionally share the same Arc with an AgentExecutor::with_cost_tracker for hard budget enforcement.

Implementations§

Source§

impl CostTracker

Source

pub fn new(table: impl Into<Arc<PricingTable>>) -> Self

Tracker over the given pricing table.

Source

pub fn with_builtin_prices() -> Self

Tracker over the built-in price snapshot.

Source

pub fn with_scope(self, scope: impl Into<String>) -> Self

Labels this tracker with a run/session id (carried in reports and emitted cost events).

Source

pub fn with_metrics_sink(self, sink: Arc<dyn MetricsSink>) -> Self

Attaches an observability sink: every record emits one ObsEvent::Cost. Sink failures are warned, never propagated.

Source

pub fn pricing(&self) -> &PricingTable

The pricing table backing this tracker.

Source

pub async fn record( &self, provider: Option<&str>, model: &str, prompt_tokens: usize, completion_tokens: usize, ) -> f64

Records one LLM call and returns its USD cost.

Models absent from the table price at 0.0 but still count toward token / call aggregates. The observability event (when attached) is exported after aggregation; export failure only logs a warning.

Source

pub async fn record_usage( &self, provider: Option<&str>, model: &str, usage: &TokenUsage, ) -> f64

Records one call from a provider-annotated TokenUsage.

Source

pub async fn total_cost_usd(&self) -> f64

Cumulative USD spend (the value the budget gate reads).

Source

pub async fn report(&self) -> CostReport

Snapshot report of everything recorded so far.

Source

pub async fn records(&self) -> Vec<CostRecord>

Every individual call recorded so far (oldest first).

Source

pub async fn reset(&self)

Resets all accumulation (e.g. start a new run while keeping the same session-scoped tracker).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more