Class: Wavefront::Write
- Inherits:
-
Object
- Object
- Wavefront::Write
- 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
Instance Attribute Summary collapse
-
#creds ⇒ Object
readonly
Returns the value of attribute creds.
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
-
#opts ⇒ Object
readonly
Returns the value of attribute opts.
-
#writer ⇒ Object
readonly
Returns the value of attribute writer.
Instance Method Summary collapse
- #chunk_size ⇒ Object
-
#close ⇒ Object
Wrapper to the writer class’s #close method.
-
#composite_response(responses) ⇒ Object
Compound the responses of all chunked writes into one.
- #data_format ⇒ Object
-
#defaults ⇒ Object
Chunk size gets overriden.
-
#hash_to_wf(point) ⇒ Object
Convert a validated point to a string conforming to community.wavefront.com/docs/DOC-1031.
-
#initialize(creds = {}, opts = {}) ⇒ Write
constructor
Construct an object which gives the user an interface for writing points to Wavefront.
- #manage_conn ⇒ Object
-
#open ⇒ Object
Wrapper to the writer class’s #open method.
-
#paths_to_deltas(points) ⇒ Array[Hash]
Prefix all paths in a points array (as passed to #write_delta() with a delta symbol.
- #point_hash(point) ⇒ Object
-
#raw(points, openclose = manage_conn) ⇒ Object
Send raw data to a Wavefront proxy, optionally automatically opening and closing the connection.
-
#send_point(point) ⇒ Object
Wrapper for the writer class’s #send_point method.
- #setup_options(user, defaults) ⇒ Object
- #tags_or_nothing(tags) ⇒ Object
-
#validation ⇒ Object
The method used to validate the data we wish to write.
-
#write(points = [], openclose = manage_conn, prefix = nil) ⇒ Boolean
A wrapper to the writer class’s #write method.
-
#write_delta(points, openclose = manage_conn) ⇒ Object
A wrapper method around #write() which guarantees all points will be sent as deltas.
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_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_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.
53 54 55 56 57 58 59 |
# File 'lib/wavefront-sdk/write.rb', line 53 def initialize(creds = {}, opts = {}) @opts = (opts, defaults) @creds = creds (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.
19 20 21 |
# File 'lib/wavefront-sdk/write.rb', line 19 def creds @creds end |
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
19 20 21 |
# File 'lib/wavefront-sdk/write.rb', line 19 def logger @logger end |
#opts ⇒ Object (readonly)
Returns the value of attribute opts.
19 20 21 |
# File 'lib/wavefront-sdk/write.rb', line 19 def opts @opts end |
#writer ⇒ Object (readonly)
Returns the value of attribute writer.
19 20 21 |
# File 'lib/wavefront-sdk/write.rb', line 19 def writer @writer end |
Instance Method Details
#chunk_size ⇒ Object
197 198 199 |
# File 'lib/wavefront-sdk/write.rb', line 197 def chunk_size opts[:chunk_size] || writer.chunk_size end |
#close ⇒ Object
Wrapper to the writer class’s #close method.
87 88 89 |
# File 'lib/wavefront-sdk/write.rb', line 87 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.
114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/wavefront-sdk/write.rb', line 114 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 |
#data_format ⇒ Object
231 232 233 |
# File 'lib/wavefront-sdk/write.rb', line 231 def data_format :wavefront end |
#defaults ⇒ Object
Chunk size gets overriden
63 64 65 66 67 68 69 70 71 72 |
# File 'lib/wavefront-sdk/write.rb', line 63 def defaults { tags: nil, writer: :socket, noop: false, novalidate: false, noauto: false, verbose: false, debug: false, 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.
208 209 210 211 212 213 214 |
# File 'lib/wavefront-sdk/write.rb', line 208 def hash_to_wf(point) raise Wavefront::Exception::InvalidMetricName unless point[:path] raise Wavefront::Exception::InvalidMetricValue unless point[:value] format('%<path>s %<value>s %<ts>s source=%<source>s %<tags>s %<opttags>s', point_hash(point)).squeeze(' ').strip end |
#manage_conn ⇒ Object
128 129 130 |
# File 'lib/wavefront-sdk/write.rb', line 128 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.
81 82 83 |
# File 'lib/wavefront-sdk/write.rb', line 81 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
151 152 153 |
# File 'lib/wavefront-sdk/write.rb', line 151 def paths_to_deltas(points) [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } } end |
#point_hash(point) ⇒ Object
216 217 218 219 220 221 222 223 |
# File 'lib/wavefront-sdk/write.rb', line 216 def point_hash(point) point.dup.tap do |p| p[:ts] ||= nil p[:source] ||= HOSTNAME p[:tags] = (p.fetch(:tags, nil)) p[:opttags] = (opts.fetch(:tags, nil)) end 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.)
181 182 183 184 185 186 187 188 189 |
# File 'lib/wavefront-sdk/write.rb', line 181 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
159 160 161 162 163 164 165 166 167 |
# File 'lib/wavefront-sdk/write.rb', line 159 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
74 75 76 |
# File 'lib/wavefront-sdk/write.rb', line 74 def (user, defaults) defaults.merge(user) end |
#tags_or_nothing(tags) ⇒ Object
225 226 227 228 229 |
# File 'lib/wavefront-sdk/write.rb', line 225 def () return nil unless .to_wf_tag end |
#validation ⇒ Object
The method used to validate the data we wish to write.
193 194 195 |
# File 'lib/wavefront-sdk/write.rb', line 193 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.
99 100 101 102 103 104 105 106 107 |
# File 'lib/wavefront-sdk/write.rb', line 99 def write(points = [], openclose = manage_conn, prefix = nil) resps = [points].flatten.each_slice(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.
141 142 143 |
# File 'lib/wavefront-sdk/write.rb', line 141 def write_delta(points, openclose = manage_conn) write(paths_to_deltas(points), openclose) end |