Skip to main content

TokenUsageRecord

Struct TokenUsageRecord 

Source
pub struct TokenUsageRecord {
Show 20 fields pub ts: String, pub session_id: String, pub model: String, pub provider: String, pub message_count: usize, pub cache_creation_input_tokens: u64, pub cache_read_input_tokens: u64, pub input_tokens: u64, pub output_tokens: u64, pub thinking_tokens: u64, pub system_tokens: u32, pub summary_tokens: u32, pub window_tokens: u32, pub total_tokens: u32, pub max_context_tokens: u32, pub budget_limit: u32, pub prompt_cached_tool_outputs: usize, pub prompt_cached_tool_tokens_saved: u32, pub truncation_occurred: bool, pub segments_removed: usize,
}
Expand description

One per-LLM-call usage record. Flattened for line-oriented analysis (jq / DuckDB / pandas over the JSONL).

Fields§

§ts: String

RFC3339 wall-clock timestamp captured when the call completed.

§session_id: String§model: String§provider: String§message_count: usize

Conversation length (message count) at emit time — a monotonic-ish ordinal to correlate records with conversation growth.

§cache_creation_input_tokens: u64§cache_read_input_tokens: u64§input_tokens: u64

Non-cached “fresh” input tokens (server-reported), disjoint from the two cache counts. The precise prompt size is input_tokens + cache_read + cache_creation, and the exact cache-hit ratio is cache_read / that_sum.

§output_tokens: u64§thinking_tokens: u64§system_tokens: u32§summary_tokens: u32§window_tokens: u32§total_tokens: u32§max_context_tokens: u32§budget_limit: u32§prompt_cached_tool_outputs: usize§prompt_cached_tool_tokens_saved: u32§truncation_occurred: bool§segments_removed: usize

Implementations§

Source§

impl TokenUsageRecord

Source

pub fn new( ts: String, session_id: &str, model: &str, provider: &str, message_count: usize, usage: Option<&TokenBudgetUsage>, cache_creation_input_tokens: u64, cache_read_input_tokens: u64, input_tokens: u64, output_tokens: u64, thinking_tokens: u64, ) -> Self

Build a record from the prompt-side budget snapshot (usage) and the server-side stream stats. The cache-creation count lives only on the stream output — it is not part of TokenBudgetUsage — so it is passed in explicitly.

Source

pub fn to_json_line(&self) -> Result<String, Error>

Serialize to a single-line JSON string (no trailing newline; the storage layer frames the line).

Trait Implementations§

Source§

impl Clone for TokenUsageRecord

Source§

fn clone(&self) -> TokenUsageRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenUsageRecord

Source§

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

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

impl Serialize for TokenUsageRecord

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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