Class: Wavefront::Write

Inherits:
Object
  • Object
show all
Includes:
Validators
Defined in:
lib/wavefront-sdk/write.rb

Overview

This class helps you send points to Wavefront. It is extended by the Write and Report classes, which respectively handle point ingestion by a proxy and directly to the API.

Direct Known Subclasses

Distribution, Report

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Validators

#uuid?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

#initialize(creds = {}, opts = {}) ⇒ Write

Construct an object which gives the user an interface for writing points to Wavefront. The actual writing is handled by

a Wavefront::Writer

subclass.



51
52
53
54
55
56
57
 
# File 'lib/wavefront-sdk/write.rb', line 51

def initialize(creds = {}, opts = {})
  @opts = setup_options(opts, defaults)
  @creds = creds
  wf_point_tags?(opts[:tags]) if opts[:tags]
  @logger = Wavefront::Logger.new(opts)
  @writer = setup_writer
end

Instance Attribute Details

#creds ⇒ Object (readonly)

Returns the value of attribute creds.



17
18
19
 
# File 'lib/wavefront-sdk/write.rb', line 17

def creds
  @creds
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



17
18
19
 
# File 'lib/wavefront-sdk/write.rb', line 17

def logger
  @logger
end

#opts ⇒ Object (readonly)

Returns the value of attribute opts.



17
18
19
 
# File 'lib/wavefront-sdk/write.rb', line 17

def opts
  @opts
end

#writer ⇒ Object (readonly)

Returns the value of attribute writer.



17
18
19
 
# File 'lib/wavefront-sdk/write.rb', line 17

def writer
  @writer
end

Instance Method Details

#close ⇒ Object

Wrapper to the writer class’s #close method.



84
85
86
 
# File 'lib/wavefront-sdk/write.rb', line 84

def close
  writer.close
end

#composite_response(responses) ⇒ Object

Compound the responses of all chunked writes into one. It will be ‘ok’ only if everything passed.



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/wavefront-sdk/write.rb', line 109

def composite_response(responses)
  result = responses.all?(&:ok?) ? 'OK' : 'ERROR'
  summary = { sent: 0, rejected: 0, unsent: 0 }

  %i[sent rejected unsent].each do |k|
    summary[k] = responses.map { |r| r.response[k] }.inject(:+)
  end

  Wavefront::Response.new(
    { status:   { result: result, message: nil, code: nil },
      response: summary.to_h }.to_json, nil
  )
end

#defaults ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/wavefront-sdk/write.rb', line 59

def defaults
  { tags:        nil,
    writer:      :socket,
    noop:        false,
    novalidate:  false,
    noauto:      false,
    verbose:     false,
    debug:       false,
    chunk_size:  1000,
    chunk_pause: 0 }
end

#hash_to_wf(point) ⇒ Object

Convert a validated point to a string conforming to community.wavefront.com/docs/DOC-1031. No validation is done here.



199
200
201
202
203
204
 
# File 'lib/wavefront-sdk/write.rb', line 199

def hash_to_wf(point)
  format('%s %s %s source=%s %s %s',
         *point_array(point)).squeeze(' ').strip
rescue StandardError
  raise Wavefront::Exception::InvalidPoint
end

#manage_conn ⇒ Object 



123
124
125
 
# File 'lib/wavefront-sdk/write.rb', line 123

def manage_conn
  opts[:noauto] ? false : true
end

#open ⇒ Object

Wrapper to the writer class’s #open method. Using this you can manually open a connection and re-use it.



78
79
80
 
# File 'lib/wavefront-sdk/write.rb', line 78

def open
  writer.open
end

#paths_to_deltas(points) ⇒ Array[Hash]

Prefix all paths in a points array (as passed to #write_delta() with a delta symbol



146
147
148
 
# File 'lib/wavefront-sdk/write.rb', line 146

def paths_to_deltas(points)
  [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } }
end

#point_array(point) ⇒ Object

Make an array which can be used by #hash_to_wf.

Raises:



211
212
213
214
215
216
217
218
 
# File 'lib/wavefront-sdk/write.rb', line 211

def point_array(point)
  [point[:path] || raise,
   point[:value] || raise,
   point.fetch(:ts, nil),
   point.fetch(:source, HOSTNAME),
   point[:tags]&.to_wf_tag,
   opts[:tags]&.to_wf_tag]
end

#raw(points, openclose = manage_conn) ⇒ Object

Send raw data to a Wavefront proxy, optionally automatically opening and closing the connection. (Or not, if that does not make sense in the context of the writer.)



176
177
178
179
180
181
182
183
184
 
# File 'lib/wavefront-sdk/write.rb', line 176

def raw(points, openclose = manage_conn)
  writer.open if openclose && writer.respond_to?(:open)

  begin
    [points].flatten.each { |p| writer.send_point(p) }
  ensure
    writer.close if openclose && writer.respond_to?(:close)
  end
end

#send_point(point) ⇒ Object

Wrapper for the writer class’s #send_point method



154
155
156
157
158
159
160
161
162
 
# File 'lib/wavefront-sdk/write.rb', line 154

def send_point(point)
  if opts[:noop]
    logger.log "Would send: #{point}"
    return
  end

  logger.log("Sending: #{point}", :debug)
  writer.send_point(point)
end

#setup_options(user, defaults) ⇒ Object 



71
72
73
 
# File 'lib/wavefront-sdk/write.rb', line 71

def setup_options(user, defaults)
  defaults.merge(user)
end

#validation ⇒ Object

The method used to validate the data we wish to write.



188
189
190
 
# File 'lib/wavefront-sdk/write.rb', line 188

def validation
  :wf_point?
end

#write(points = [], openclose = manage_conn, prefix = nil) ⇒ Boolean

A wrapper to the writer class’s #write method. Writers implement this method differently, Check the appropriate class documentation for @return information etc. The signature is always the same.

Raises:

  • any exceptions raised by the writer classes are passed through



96
97
98
99
100
101
102
103
104
 
# File 'lib/wavefront-sdk/write.rb', line 96

def write(points = [], openclose = manage_conn, prefix = nil)
  resps = [points].flatten.each_slice(opts[:chunk_size]).map do |chunk|
    resp = writer.write(chunk, openclose, prefix)
    sleep(opts[:chunk_pause])
    resp
  end

  composite_response(resps)
end

#write_delta(points, openclose = manage_conn) ⇒ Object

A wrapper method around #write() which guarantees all points will be sent as deltas. You can still manually prefix any metric with a delta symbol and use #write(), but depending on your use-case, this method may be safer. It’s easy to forget the delta.



136
137
138
 
# File 'lib/wavefront-sdk/write.rb', line 136

def write_delta(points, openclose = manage_conn)
  write(paths_to_deltas(points), openclose)
end