Skip to main content

UsageReporter

Struct UsageReporter 

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

Reporter that aggregates token usage and cost across the entire run.

UsageReporter listens for AgentEvent::UsageUpdated and AgentEvent::TurnFinished events and maintains a running UsageSummary. After the loop completes, call summary to read the totals.

§Example

use agentkit_reporting::UsageReporter;
use agentkit_loop::LoopObserver;

let mut reporter = UsageReporter::new();

// ...pass `reporter` to the agent loop, then afterwards:
let summary = reporter.summary();
println!(
    "tokens: {} in / {} out",
    summary.totals.input_tokens,
    summary.totals.output_tokens,
);

Implementations§

Source§

impl UsageReporter

Source

pub fn new() -> Self

Creates a new UsageReporter with zeroed counters.

Source

pub fn summary(&self) -> &UsageSummary

Returns a reference to the current UsageSummary.

Trait Implementations§

Source§

impl Default for UsageReporter

Source§

fn default() -> UsageReporter

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

impl LoopObserver for UsageReporter

Source§

fn handle_event(&mut self, event: AgentEvent)

Called synchronously for every AgentEvent emitted by the loop driver.

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, 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, 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.