Module: SignalFx

Defined in:
lib/signalfx.rb

Class Method Summary collapse

Class Method Details

.new(api_token, enable_aws_unique_id: false, ingest_endpoint: SignalFX::Config::DEFAULT_INGEST_ENDPOINT, api_endpoint: SignalFX::Config::DEFAULT_API_ENDPOINT, timeout: SignalFX::Config::DEFAULT_TIMEOUT, batch_size: SignalFX::Config::DEFAULT_BATCH_SIZE, user_agents: []) ⇒ Object

SignalFx API client. This class presents a programmatic interface to SignalFx’s metadata and ingest APIs. At the time being, only ingest is supported; more will come later.

Parameters:

  • api_token —

    • Your private SignalFx token

  • enable_aws_unique_id (defaults to: false) —

    • boolean, ‘false` by default.

    If ‘true`, library will retrieve Amazon unique identifier and set it as `AWSUniqueId` dimension for each datapoint and event. Use this option only if your application deployed to Amazon

  • ingest_endpoint (defaults to: SignalFX::Config::DEFAULT_INGEST_ENDPOINT) —

    • string

  • api_endpoint (defaults to: SignalFX::Config::DEFAULT_API_ENDPOINT) —

    • string

  • timeout (defaults to: SignalFX::Config::DEFAULT_TIMEOUT) —

    • number

  • batch_size (defaults to: SignalFX::Config::DEFAULT_BATCH_SIZE) —

    • number

  • user_agents (defaults to: []) —

    • array



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/signalfx.rb', line 24

def self.new(api_token, enable_aws_unique_id: false, ingest_endpoint: SignalFX::Config::DEFAULT_INGEST_ENDPOINT,
    api_endpoint: SignalFX::Config::DEFAULT_API_ENDPOINT, timeout: SignalFX::Config::DEFAULT_TIMEOUT,
    batch_size: SignalFX::Config::DEFAULT_BATCH_SIZE, user_agents: [])
  begin
    require_relative './proto/signal_fx_protocol_buffers.pb'
    ProtoBufSignalFx.new(api_token, enable_aws_unique_id: enable_aws_unique_id, ingest_endpoint: ingest_endpoint,
                         api_endpoint: api_endpoint, timeout: timeout,
                         batch_size: batch_size, user_agents: user_agents)

  rescue Exception => e
    puts "Protocol Buffers not installed properly. Switch to JSON.
          #{e}"
    JsonSignalFx.new(api_token, enable_aws_unique_id: enable_aws_unique_id, ingest_endpoint: ingest_endpoint,
                     api_endpoint: api_endpoint, timeout: timeout,
                     batch_size: batch_size, user_agents: user_agents)
  end


end