Class: Wavefront::Writer::Api

Inherits:
Core
  • Object
show all
Defined in:
lib/wavefront-sdk/writers/api.rb

Overview

Send points direct to Wavefront’s API. This requires an endpoint, a token, and HTTPS egress.

Instance Attribute Summary

Attributes inherited from Core

#calling_class, #conn, #creds, #logger, #opts, #summary

Instance Method Summary collapse

Methods inherited from Core

#hash_to_wf, #initialize, #prefix_points, #respond, #screen_points, #send_point, #valid_point?, #write

Methods included from Validators

#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_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::Writer::Core

Instance Method Details

#api_path ⇒ Object 



15
16
17
 
# File 'lib/wavefront-sdk/writers/api.rb', line 15

def api_path
  '/report'
end

#open ⇒ Object 



11
12
13
 
# File 'lib/wavefront-sdk/writers/api.rb', line 11

def open
  @conn = Wavefront::ApiCaller.new(self, creds, opts)
end

#validate_credentials(creds) ⇒ Object

Raises:



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/wavefront-sdk/writers/api.rb', line 19

def validate_credentials(creds)
  unless creds.key?(:endpoint)
    raise(Wavefront::Exception::CredentialError,
          'credentials must contain API endpoint')
  end

  return true if creds.key?(:token)

  raise(Wavefront::Exception::CredentialError,
        'credentials must contain API token')
end