Skip to main content

Event

Struct Event 

Source
#[non_exhaustive]
pub struct Event {
Show 25 fields pub id: String, pub session_id: Option<String>, pub project_id: String, pub event_type: String, pub timestamp: SystemTime, pub duration: Option<Duration>, pub input_tokens: Option<u32>, pub output_tokens: Option<u32>, pub sdk_language: Option<String>, pub agentcat_version: Option<String>, pub server_name: Option<String>, pub server_version: Option<String>, pub client_name: Option<String>, pub client_version: Option<String>, pub identify_actor_given_id: Option<String>, pub identify_actor_name: Option<String>, pub identify_actor_data: Option<Map<String, Value>>, pub resource_name: Option<String>, pub parameters: Option<Value>, pub response: Option<Value>, pub user_intent: Option<Value>, pub is_error: Option<bool>, pub error: Option<Value>, pub tags: Option<BTreeMap<String, String>>, pub properties: Option<Map<String, Value>>,
}
Expand description

An event as AgentCat publishes it, as the hook of Options::redact_event sees it. The hook may change any field. It cannot add a field that events do not have, and the SDK restores the system fields (id, session_id, project_id, event_type and timestamp) when the hook changes them.

The free-form fields (parameters, response, user_intent, error, identify_actor_data and properties) hold JSON values, as the published event carries them.

To unit-test a redact_event hook, build an event with Event::default, set the fields the hook reads, and call the hook with it.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: String

The ID of the event.

§session_id: Option<String>

The session the event belongs to.

§project_id: String

The project the event is published to.

§event_type: String

The kind of event, such as mcp:tools/call.

§timestamp: SystemTime

When the event happened.

§duration: Option<Duration>

How long it took.

§input_tokens: Option<u32>

The estimated tokens of the request.

§output_tokens: Option<u32>

The estimated tokens of the response.

§sdk_language: Option<String>

The language of the SDK: "Rust".

§agentcat_version: Option<String>

The version of the SDK.

§server_name: Option<String>

The name of the MCP server.

§server_version: Option<String>

The version of the MCP server.

§client_name: Option<String>

The name of the MCP client.

§client_version: Option<String>

The version of the MCP client.

§identify_actor_given_id: Option<String>

The ID of the caller in the customer’s system.

§identify_actor_name: Option<String>

The display name of the caller.

§identify_actor_data: Option<Map<String, Value>>

Other data about the caller.

§resource_name: Option<String>

The name of the tool or resource.

§parameters: Option<Value>

The parameters of the call.

§response: Option<Value>

The response of the call.

§user_intent: Option<Value>

Why the agent made the call.

§is_error: Option<bool>

Whether the call failed.

§error: Option<Value>

The error of the call.

§tags: Option<BTreeMap<String, String>>

The tags of the event.

§properties: Option<Map<String, Value>>

The properties of the event.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Self

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 Event

Source§

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

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

impl Default for Event

Source§

fn default() -> Self

An empty event: id, project_id and event_type are empty, timestamp is the Unix epoch, and every other field is None. Set the fields a test needs:

use agentcat_sdk::Event;
use serde_json::json;

let mut event = Event::default();
event.parameters = Some(json!({"api_key": "fake-secret-42"}));
Source§

impl PartialEq for Event

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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 = !

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