Struct Event

pub struct Event { /* private fields */ }

Event is used to hold data that can be sent to Honeycomb. It can also specify overrides of the config settings (client::Options).

Implementations

impl Event

pub fn new(options: &Options) -> Self

new creates a new event with the passed ClientOptions

pub fn send<T: Sender>(&mut self, client: &mut Client<T>) -> Result<()>

send dispatches the event to be sent to Honeycomb, sampling if necessary.

If you have sampling enabled (i.e. sample_rate >1), send will only actually transmit data with a probability of 1/sample_rate. No error is returned whether or not traffic is sampled, however, the Response sent down the response channel will indicate the event was sampled in the errors Err field.

Send inherits the values of required fields from ClientOptions. If any required fields are specified in neither ClientOptions nor the Event, send will return an error. Required fields are api_host, api_key, and dataset. Values specified in an Event override ClientOptions.

Once you send an event, any addition calls to add data to that event will return without doing anything. Once the event is sent, it becomes immutable.

pub fn send_presampled<T: Sender>( &mut self, client: &mut Client<T>, ) -> Result<()>

send_presampled dispatches the event to be sent to Honeycomb.

Sampling is assumed to have already happened. send_presampled will dispatch every event handed to it, and pass along the sample rate. Use this instead of send() when the calling function handles the logic around which events to drop when sampling.

send_presampled inherits the values of required fields from Config. If any required fields are specified in neither Config nor the Event, send will return an error. Required fields are api_host, api_key, and dataset. Values specified in an Event override Config.

Once you send an event, any addition calls to add data to that event will return without doing anything. Once the event is sent, it becomes immutable.

pub fn set_sample_rate(&mut self, sample_rate: usize)

Set options sample_rate on the event

pub fn set_timestamp(&mut self, timestamp: DateTime<Utc>)

Set timestamp on the event

pub fn set_metadata(&mut self, metadata: Metadata)

Set metadata on the event

pub fn metadata(&self) -> Metadata

Get event metadata

pub fn fields(&self) -> HashMap<String, Value>

Get event fields

pub fn get_fields_mut(&mut self) -> &mut HashMap<String, Value>

Get event fields (mutable)

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl FieldHolder for Event

fn add_field(&mut self, name: &str, value: Value)

add_field adds a field to the current (event/builder) fields

fn add_func<F>(&mut self, func: F)

where F: Fn() -> Result<(String, Value)>,

add_func iterates over the results from func (until Err) and adds the results to the event/builder fields

fn add(&mut self, data: HashMap<String, Value>)

add data to the current (event/builder) fields