Class: StatsD::Instrument::DogStatsDDatagramBuilder

Inherits:
DatagramBuilder show all
Defined in:
lib/statsd/instrument/dogstatsd_datagram_builder.rb

Overview

Note:

This class is part of the new Client implementation that is intended to become the new default in the next major release of this library.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatagramBuilder

#c, #d, #g, #h, #initialize, #kv, #ms, #s, unsupported_datagram_types

Constructor Details

This class inherits a constructor from StatsD::Instrument::DatagramBuilder

Class Method Details

.datagram_class ⇒ Object 



11
12
13
 
# File 'lib/statsd/instrument/dogstatsd_datagram_builder.rb', line 11

def datagram_class
  StatsD::Instrument::DogStatsDDatagram
end

Instance Method Details

#_e(title, text, timestamp: nil, hostname: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil, tags: nil) ⇒ String

Constructs an event datagram.

Parameters:

  • title (String) —

    Event title.

  • text (String) —

    Event description. Newlines are allowed.

  • timestamp (Time) (defaults to: nil) —

    The of the event. If not provided, Datadog will interpret it as the current timestamp.

  • hostname (String) (defaults to: nil) —

    A hostname to associate with the event.

  • aggregation_key (String) (defaults to: nil) —

    An aggregation key to group events with the same key.

  • priority (String) (defaults to: nil) —

    Priority of the event. Either "normal" (default) or "low".

  • source_type_name (String) (defaults to: nil) —

    The source type of the event.

  • alert_type (String) (defaults to: nil) —

    Either "error", "warning", "info" (default) or "success".

  • tags (Array, Hash) (defaults to: nil) —

    Tags to associate with the event.

Returns:

  • (String) —

    The correctly formatted service check datagram

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/statsd/instrument/dogstatsd_datagram_builder.rb', line 34

def _e(title, text, timestamp: nil, hostname: nil, aggregation_key: nil, priority: nil,
  source_type_name: nil, alert_type: nil, tags: nil)

  escaped_title = "#{@prefix}#{title}".gsub("\n", '\n')
  escaped_text = text.gsub("\n", '\n')

  datagram = +"_e{#{escaped_title.length},#{escaped_text.length}}:#{escaped_title}|#{escaped_text}"
  datagram << "|h:#{hostname}" if hostname
  datagram << "|d:#{timestamp.to_i}" if timestamp
  datagram << "|k:#{aggregation_key}" if aggregation_key
  datagram << "|p:#{priority}" if priority
  datagram << "|s:#{source_type_name}" if source_type_name
  datagram << "|t:#{alert_type}" if alert_type

  unless @default_tags.nil?
    datagram << @default_tags
  end

  unless tags.nil? || tags.empty?
    datagram << (@default_tags.nil? ? "|#" : ",")
    compile_tags(tags, datagram)
  end

  datagram
end

#_sc(name, status, timestamp: nil, hostname: nil, tags: nil, message: nil) ⇒ String

Constructs a service check datagram.

Parameters:

  • name (String) —

    Name of the service

  • status (Symbol) —

    Either :ok, :warning, :critical or :unknown

  • timestamp (Time) (defaults to: nil) —

    The moment when the service was checked. If not provided, Datadog will interpret it as the current timestamp.

  • hostname (String) (defaults to: nil) —

    A hostname to associate with the check.

  • tags (Array, Hash) (defaults to: nil) —

    Tags to associate with the check.

  • message (String) (defaults to: nil) —

    A message describing the current state of the service check.

Returns:

  • (String) —

    The correctly formatted service check datagram

See Also:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/statsd/instrument/dogstatsd_datagram_builder.rb', line 72

def _sc(name, status, timestamp: nil, hostname: nil, tags: nil, message: nil)
  status_number = status.is_a?(Integer) ? status : SERVICE_CHECK_STATUS_VALUES.fetch(status.to_sym)

  datagram = +"_sc|#{@prefix}#{normalize_name(name)}|#{status_number}"
  datagram << "|h:#{hostname}" if hostname
  datagram << "|d:#{timestamp.to_i}" if timestamp

  unless @default_tags.nil?
    datagram << @default_tags
  end

  unless tags.nil? || tags.empty?
    datagram << (@default_tags.nil? ? "|#" : ",")
    compile_tags(tags, datagram)
  end

  datagram << "|m:#{normalize_name(message)}" if message
  datagram
end

#latency_metric_type ⇒ Object 



15
16
17
 
# File 'lib/statsd/instrument/dogstatsd_datagram_builder.rb', line 15

def latency_metric_type
  :d
end