Module dogstatsc

dogstatsc is public client API module to send several reqeusts for DogStatsD.

Copyright © (C) 2018, tkyshm

Authors: tkyshm.

Description

dogstatsc is public client API module to send several reqeusts for DogStatsD.

Function Index

send_events/2 send events to DogStatsD.
send_events/3 send events to DogStatsD with options.
send_metrics/3 send metrics to DogStatsD.
send_metrics/4 send metrics to DogStatsD with options.
send_service_check/2 send service check to DogStatsD.
send_service_check/3 send service check to DogStatsD with option.

Function Details

send_events/2

send_events(Name::string(), Text::string()) -> ok

send events to DogStatsD.

send_events/3

send_events(Name::string(), Text::string(), Opts::map()) -> ok

send events to DogStatsD with options.

  Opts = #{
    timestamp = non_neg_integer() (epoch time)
    hostname = string()
    aggregation_key = string()
    priority = dogstatsc_datagram:priority()
    source_type_name = string()
    alert_type = dogstatsc_datagram:alert_type() (default: info)
    tags = dogstatsc_datagra:tags() | undefined
  }
  

See also: dogstatsc_datagram:alert_type(), dogstatsc_datagram:priority(), dogstatsc_datagram:tags().

send_metrics/3

send_metrics(Name::string(), Typ::dogstatsc_datagram:metric_type(), Val::float()) -> ok

send metrics to DogStatsD.

send_metrics/4

send_metrics(Name::string(), Typ::dogstatsc_datagram:metric_type(), Val::float(), Opts::map()) -> ok

send metrics to DogStatsD with options.

  Opts = #{
    rate = float() (0 to 1)
    tags = dogstatsc_datagra:tags() | undefined
  }.
  

See also: dogstatsc_datagram:metric_type(), dogstatsc_datagram:tags().

send_service_check/2

send_service_check(Name::string(), SC::dogstatsc_datagra:service_check()) -> ok

send service check to DogStatsD.

send_service_check/3

send_service_check(Name::string(), SC::dogstatsc_datagra:status(), Opts::map()) -> ok

send service check to DogStatsD with option.

  Opts = #{
    timestamp = non_neg_integer() epoch time (sec)
    hostname = string()
    message = string() | undefined
    tags = dogstatsc_datagra:tags() | undefined
  }
  

See also: dogstatsc_datagram:tags().


Generated by EDoc