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
-
#close ⇒ Object
Wrapper to the writer class’s #close method.
-
#flush ⇒ Object
Wrapper around writer class’s #flush method.
-
#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_array(point) ⇒ Object
Make an array which can be used by #hash_to_wf.
-
#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
-
#validation ⇒ Object
The method used to validate the data we wish to write.
-
#write(points = [], openclose = manage_conn, prefix = nil) ⇒ Object
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_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.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/wavefront-sdk/write.rb', line 44 def initialize(creds = {}, opts = {}) defaults = { tags: nil, writer: :socket, noop: false, novalidate: false, noauto: false, verbose: false, debug: false } @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.
16 17 18 |
# File 'lib/wavefront-sdk/write.rb', line 16 def creds @creds end |
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
16 17 18 |
# File 'lib/wavefront-sdk/write.rb', line 16 def logger @logger end |
#opts ⇒ Object (readonly)
Returns the value of attribute opts.
16 17 18 |
# File 'lib/wavefront-sdk/write.rb', line 16 def opts @opts end |
#writer ⇒ Object (readonly)
Returns the value of attribute writer.
16 17 18 |
# File 'lib/wavefront-sdk/write.rb', line 16 def writer @writer end |
Instance Method Details
#close ⇒ Object
Wrapper to the writer class’s #close method.
73 74 75 |
# File 'lib/wavefront-sdk/write.rb', line 73 def close writer.close end |
#flush ⇒ Object
Wrapper around writer class’s #flush method
88 89 90 |
# File 'lib/wavefront-sdk/write.rb', line 88 def flush writer.flush 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.
168 169 170 171 172 173 |
# File 'lib/wavefront-sdk/write.rb', line 168 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
92 93 94 |
# File 'lib/wavefront-sdk/write.rb', line 92 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.
67 68 69 |
# File 'lib/wavefront-sdk/write.rb', line 67 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
115 116 117 |
# File 'lib/wavefront-sdk/write.rb', line 115 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.
180 181 182 183 184 185 186 187 |
# File 'lib/wavefront-sdk/write.rb', line 180 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.)
145 146 147 148 149 150 151 152 153 |
# File 'lib/wavefront-sdk/write.rb', line 145 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
123 124 125 126 127 128 129 130 131 |
# File 'lib/wavefront-sdk/write.rb', line 123 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
60 61 62 |
# File 'lib/wavefront-sdk/write.rb', line 60 def (user, defaults) defaults.merge(user) end |
#validation ⇒ Object
The method used to validate the data we wish to write.
157 158 159 |
# File 'lib/wavefront-sdk/write.rb', line 157 def validation :wf_point? end |
#write(points = [], openclose = manage_conn, prefix = nil) ⇒ Object
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.
82 83 84 |
# File 'lib/wavefront-sdk/write.rb', line 82 def write(points = [], openclose = manage_conn, prefix = nil) writer.write(points, openclose, prefix) 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.
105 106 107 |
# File 'lib/wavefront-sdk/write.rb', line 105 def write_delta(points, openclose = manage_conn) write(paths_to_deltas(points), openclose) end |