Struct dogstatsd::Options

pub struct Options {
    pub from_addr: String,
    pub to_addr: String,
    pub namespace: String,
    pub default_tags: Vec<String>,
    pub socket_path: Option<String>,
    pub batching_options: Option<BatchingOptions>,
}

The struct that represents the options available for the Dogstatsd client.

Fields

from_addr: String

The address of the udp socket we’ll bind to for sending.

to_addr: String

The address of the udp socket we’ll send metrics and events to.

namespace: String

A namespace to prefix all metrics with, joined with a ‘.’.

default_tags: Vec<String>

Default tags to include with every request.

socket_path: Option<String>

OPTIONAL, if defined, will use UDS instead of UDP and will ignore UDP options

batching_options: Option<BatchingOptions>

OPTIONAL, if defined, will utilize batching for sending metrics

Implementations

impl Options

pub fn new( from_addr: &str, to_addr: &str, namespace: &str, default_tags: Vec<String>, socket_path: Option<String>, batching_options: Option<BatchingOptions> ) -> Self

Create a new options struct by supplying values for all fields.

Examples

  use dogstatsd::Options;

  let options = Options::new("127.0.0.1:9000", "127.0.0.1:9001", "", vec!(String::new()), None, None);

Trait Implementations

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

Create a new options struct with all the default settings.

Examples

  use dogstatsd::Options;

  let options = Options::default();

  assert_eq!(
      Options {
          from_addr: "0.0.0.0:0".into(),
          to_addr: "127.0.0.1:8125".into(),
          namespace: String::new(),
          default_tags: vec!(),
          socket_path: None,
          batching_options: None,
      },
      options
  )

impl PartialEq for Options

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Options