Struct Options

pub struct Options {
    pub api_key: String,
    pub api_host: String,
    pub dataset: String,
    pub sample_rate: usize,
}

Options is a subset of the global libhoney config that focuses on the configuration of the client itself.

Fields

api_key: String

api_key is the Honeycomb authentication token. If it is specified during libhoney initialization, it will be used as the default API key for all events. If absent, API key must be explicitly set on a builder or event. Find your team’s API keys at https://ui.honeycomb.io/account

api_host: String

api_host is the hostname for the Honeycomb API server to which to send this event. default: https://api.honeycomb.io/

dataset: String

dataset is the name of the Honeycomb dataset to which to send these events. If it is specified during libhoney initialization, it will be used as the default dataset for all events. If absent, dataset must be explicitly set on a builder or event.

sample_rate: usize

sample_rate is the rate at which to sample this event. Default is 1, meaning no sampling. If you want to send one event out of every 250 times Send() is called, you would specify 250 here.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.