Skip to main content

UsageTracker

Struct UsageTracker 

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

Accumulates token usage and execution statistics over a single task run.

The default task handlers create one UsageTracker per task, thread it through run_tool_loop, and - when usage metadata is enabled - merge metadata into the task’s metadata field once the task reaches a terminal state.

Counters are split into two groups:

  • Token usage (prompt_tokens / completion_tokens / total_tokens), summed from each CompletionUsage the gateway returns. Every add_token_usage call also bumps an internal llm_calls counter so metadata can decide whether a usage block is meaningful.
  • Execution stats (iterations / messages / tool_calls / failed_tools), counted as the agent loop runs.

All mutators take &self (interior mutability via a Mutex) so the tracker can be shared behind a shared reference across .await points.

Implementations§

Source§

impl UsageTracker

Source

pub fn new() -> Self

Source

pub fn add_token_usage(&self, usage: &CompletionUsage)

Add the token counts from one chat-completion response and record that an LLM call was made.

Source

pub fn increment_iteration(&self)

Count one pass through the agent’s model ↔ tool loop.

Source

pub fn add_messages(&self, count: usize)

Count count conversation messages produced during the loop (the default handlers use this for tool-result messages fed back to the model).

Source

pub fn increment_tool_calls(&self)

Count one dispatched tool call.

Source

pub fn increment_failed_tools(&self)

Count one tool call that failed (missing handler or handler error).

Source

pub fn has_usage(&self) -> bool

Whether anything worth reporting was recorded. Mirrors the Go ADK: true when at least one LLM call, iteration, message, or tool call happened.

Source

pub fn metadata(&self) -> Map<String, Value>

Build the metadata object merged into a terminal task. Always emits an execution_stats block; only emits a usage block when at least one LLM call contributed token counts (otherwise the zeros would be misleading).

Trait Implementations§

Source§

impl Debug for UsageTracker

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for UsageTracker

Source§

fn default() -> UsageTracker

Returns the “default value” for a type. Read more

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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