signalfx 2.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f4d9b5d2fd10a70d0b431b6e6d4200e3f4634ff5
-  data.tar.gz: 711835760cb429f574c776435eba20a46b45afa1
+SHA256:
+  metadata.gz: 670a3ffcd46baae47aaefbcb622426e9fae027750802206e7bd74b6fecb9928a
+  data.tar.gz: 6a757389d9ef2f19b4f58747f0d6ef762a9f809a189b0b1c7692ef950236e093
 SHA512:
-  metadata.gz: c9ab6fa6dc20607bb4516534e674206af91bb8ffd7304e2b579a36cbcb1cd85dc23e0b2e25620bec371738b90d4dedb00bc5af22bf7871370167b8470d74f739
-  data.tar.gz: 9f3d726b842f389cc7e5732b3124d376898cd5639fe657133420c6633bf3ee811c82d139ea4261726f7440842fc98a421819ca3bcd343f6382a21d388212168b
+  metadata.gz: 751e1649262c8e0d0d3fa6ccc02e71ec602ff166cc7a78d6b0e1c41a514983dfd8e106cd22dfabb9400f48d484a0b3eebe72d50dd0507b3369ddc3e813772217
+  data.tar.gz: b9db8d6fdbed7c32a8f64fa449a36a7830d6f70e1be3606a2bd863046cea6f8f437204b7106f52be8afac3c56b1a7e5a06ae604754637356dd7bb47c4c03eaa8

data/.gitignore

@@ -33,9 +33,9 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/.travis.yml

@@ -1,6 +1,11 @@
-sudo: required
 language: ruby
-dist: trusty
+dist: xenial
+os: linux
+
+# See: https://docs.travis-ci.com/user/languages/ruby/#bundler-20
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 
 rvm:
   - 2.2.3

data/README.md

@@ -31,9 +31,33 @@ installing a more recent gem.  Building and installing signalfx from source will
 
 ## Usage
 
-### API access token
 
-To use this library, you need a SignalFx API access token, which can be obtained from the SignalFx organization you want to report data into.
+### Configuring your endpoints
+
+In order to send your data to the correct realm, you may need to configure your 
+endpoints. If no endpoints are set manually, this library uses the ``us0`` realm by default. 
+If you are not in this realm, you will need to explicitly set the
+endpoint config options below. To determine if you are in a different realm and need to
+explicitly set the endpoints, check your profile page in the SignalFx 
+web application. 
+
+```ruby
+require('signalfx')
+# Create client with alternate ingest endpoint
+client = SignalFx.new('ORG_TOKEN', ingest_endpoint: 'https://ingest.{REALM}.signalfx.com',
+                      stream_endpoint: 'https:/stream.{REALM}.signalfx.com')
+
+```
+
+### Access tokens
+
+To use this library, you will also need to specify an access token when requesting
+one of those clients. For the ingest client, you need to specify your
+organization access token (which can be obtained from the
+SignalFx organization you want to report data into). For the SignalFlow client, either an
+organization access token or a user access token may be used. For more
+information on access tokens, see the API's [authentication documentation](https://developers.signalfx.com/basics/authentication.html).
+
 
 ### Create client
 
@@ -105,6 +129,11 @@ actually make it to SignalFx).
 To send data through a HTTP proxy, set the environment variable `http_proxy`
 with the proxy URL.
 
+The SignalFlow client by default will use the proxy set in the `http_proxy`
+envvar by default. To send SignalFlow websocket data through a separate proxy,
+set the `proxy_url` keyword arg on the `client.signalflow` call.
+
+
 ### Sending multi-dimensional data
 
 Reporting dimensions for the data is also optional, and can be
@@ -174,9 +203,23 @@ sending events.
 
 You can run SignalFlow computations as well.  This library supports all of the
 functionality described in our [API docs for
-SignalFlow](https://developers.signalfx.com/reference#signalflowconnect). Right
+SignalFlow](https://developers.signalfx.com/signalflow_reference.html). Right
 now, the only supported transport mechanism is WebSockets.
 
+#### Configure the SignalFlow client endpoint
+
+By default, this library connects to the `us0` stream endpoint.
+If you are not in this realm, you will need to explicitly set the
+endpoint config options below when creating the client. 
+To determine if you are in a different realm and need to
+explicitly set the endpoints, check your profile page in the SignalFx web application.
+
+```ruby
+client = SignalFx.new('ORG_TOKEN', ingest_endpoint: 'https://ingest.{REALM}.signalfx.com',
+                      stream_endpoint: 'https:/stream.{REALM}.signalfx.com')
+```
+
+
 To create a new SignalFlow client instance from an existing SignalFx client:
 
 ```ruby

data/lib/signalfx/signal_fx_client.rb

@@ -171,8 +171,11 @@ class SignalFxClient
   #
   # @return [SignalFlowClient] a newly instantiated client, configured with the
   #   api token and endpoints from this class
-  def signalflow
-    SignalFlowClient.new(@api_token, @stream_endpoint)
+  def signalflow(proxy_url: nil, debug: false)
+    if ENV["http_proxy"] and proxy_url == nil
+      proxy_url = ENV["http_proxy"]
+    end
+    SignalFlowClient.new(@api_token, @stream_endpoint, proxy_url: proxy_url, debug: debug)
   end
 
   protected

data/lib/signalfx/signalflow/client.rb

@@ -19,8 +19,8 @@ require_relative "./websocket"
 # our API reference for SignalFlow}.  Hash keys will be symbols instead of
 # strings.
 class SignalFlowClient
-  def initialize(api_token, stream_endpoint)
-    @transport = SignalFlowWebsocketTransport.new(api_token, stream_endpoint)
+  def initialize(api_token, stream_endpoint, proxy_url = nil)
+    @transport = SignalFlowWebsocketTransport.new(api_token, stream_endpoint, proxy_url)
   end
 
   # Start a computation and attach to its output. If using WebSockets (the

data/lib/signalfx/signalflow/websocket.rb

@@ -2,12 +2,18 @@
 
 require 'json'
 require 'thread'
-require 'websocket-client-simple'
+require 'faye/websocket'
 
 require_relative './binary'
 require_relative './channel'
 require_relative './computation'
 
+class WebsocketError < StandardError
+  def initialize(ws_err)
+    super ws_err.message
+  end
+end
+
 
 # A WebSocket transport for SignalFlow.  This should not be used directly by
 # end-users.
@@ -17,14 +23,17 @@ class SignalFlowWebsocketTransport
   # A lower bound on the amount of time to wait for a computation to start
   COMPUTATION_START_TIMEOUT_SECONDS = 30
 
-  def initialize(api_token, stream_endpoint, logger: Logger.new(STDOUT, progname: "signalfx"))
+  def initialize(api_token, stream_endpoint, proxy_url: nil, logger: Logger.new(STDOUT, progname: "signalfx"), debug: false)
     @api_token = api_token
     @stream_endpoint = stream_endpoint
     @logger = logger
     @compress = true
+    @proxy_url = proxy_url
+    @debug = debug
 
     @lock = Mutex.new
     @close_reason = nil
+    @last_error = nil
     reinit
   end
 
@@ -188,6 +197,9 @@ class SignalFlowWebsocketTransport
           # The socket will be closed by the server if auth isn't successful
           # within 5 seconds so no point in waiting longer
           if Time.now - start_time > 5 || @close_reason
+            if @last_error
+              raise WebsocketError.new(@last_error)
+            end
             raise "Could not authenticate to SignalFlow WebSocket: #{@close_reason}"
           end
           sleep 0.1
@@ -200,7 +212,11 @@ class SignalFlowWebsocketTransport
   private :send_msg
 
   def on_close(msg)
-    @close_reason = "(#{msg.code}, #{msg.data})"
+    if @debug
+      @logger.info("Websocket on_close: #{msg}")
+    end
+
+    @close_reason = "(#{msg.code}, #{msg.reason})"
     @chan_callbacks.keys.each do |channel_name|
       invoke_callback_for_channel({ :event => "CONNECTION_CLOSED" }, channel_name)
     end
@@ -208,21 +224,31 @@ class SignalFlowWebsocketTransport
     reinit
   end
 
+  def on_error(e)
+    @logger.error("ERROR #{e.inspect}")
+    @last_error = e
+  end
+
+
   def on_message(m)
-    begin
-      return if m.type == :ping
-      if m.type == :close
-        on_close(m)
-        return
-      end
+    if @debug
+      @logger.info("Websocket on_message: #{m}")
+    end
 
-      message_received(m.data, m.type == :text)
+    is_text = m.data.kind_of?(String)
+
+    begin
+      message_received(m.data, is_text)
     rescue Exception => e
       @logger.error("Error processing SignalFlow message: #{e.backtrace.first}: #{e.message} (#{e.class})")
     end
   end
 
   def on_open
+    if @debug
+      @logger.info("Websocket on_open")
+    end
+
     @ws.send({
       :type => "authenticate",
       :token => @api_token,
@@ -233,26 +259,38 @@ class SignalFlowWebsocketTransport
   # reactor.
   def startup_client
     this = self
-    WebSocket::Client::Simple.connect("#{@stream_endpoint}/v2/signalflow/connect",
-                                      # Verification is disabled by default so this is essential
-                                      {verify_mode: OpenSSL::SSL::VERIFY_PEER}) do |ws|
-      @ws = ws
-      ws.on :error do |e|
-        @logger.error("ERROR #{e.inspect}")
-      end
 
-      ws.on :close do |e|
-        this.on_close(e)
-      end
+    options = {
+      :tls => {
+        :verify_peer => true,
+      }
+    }
+    if @proxy_url
+      options[:proxy] = {
+       :origin  => @proxy_url,
+      }
+    end
+    Thread.new {
+      EM.run {
+        @ws = Faye::WebSocket::Client.new("#{@stream_endpoint}/v2/signalflow/connect", [], options)
+        @ws.on :error do |e|
+          this.on_error(e)
+        end
 
-      ws.on :message do |m|
-        this.on_message(m)
-      end
+        @ws.on :close do |e|
+          this.on_close(e)
+          EM.stop_event_loop
+        end
 
-      ws.on :open do
-        this.on_open
-      end
-    end
+        @ws.on :message do |m|
+          this.on_message(m)
+        end
+
+        @ws.on :open do
+          this.on_open
+        end
+      }
+    }
   end
   private :startup_client
 
@@ -294,7 +332,8 @@ class SignalFlowWebsocketTransport
     if is_text
       JSON.parse(raw_msg, {:symbolize_names => true})
     else
-      BinaryMessageParser.parse(raw_msg)
+      # Convert the byte array to a string
+      BinaryMessageParser.parse(raw_msg.pack("c*"))
     end
   end
   private :parse_message

data/lib/signalfx/version.rb

@@ -1,8 +1,8 @@
-# Copyright (C) 2015-2016 SignalFx, Inc. All rights reserved.
+# Copyright (C) 2015-2020 SignalFx, Inc. All rights reserved.
 
 module SignalFx
   module Version
-    VERSION = '2.1.0'
+    VERSION = '3.1.1'
     NAME = 'signalfx-ruby-client'
   end
 end

data/signalfx.gemspec

@@ -29,13 +29,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "webmock", "~> 2.3.1"
   spec.add_development_dependency "thin", "~> 1.7"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "faye-websocket", "~> 0.10.7"
 
   # protobuf enforces this check but builds with a newer Ruby version so it's not enabled.
   # Incorporating here to allow 2.2.0-1 users to successfully build and install signalfx.
@@ -44,5 +43,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "protobuf", ">= 3.5.1"
   spec.add_dependency "rest-client", "~> 2.0"
-  spec.add_dependency 'websocket-client-simple', "~> 0.3.0"
+  spec.add_dependency "faye-websocket", ">= 0.10.7", "< 0.12.0"
+  spec.add_dependency "thor", "= 0.20.0"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalfx
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - SignalFx, Inc
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faye-websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +137,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: websocket-client-simple
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.20.0
 description: This is a programmatic interface in Ruby for SignalFx's metadata and
   ingest APIs. It is meant to provide a base for communicating with SignalFx APIs
   that can be easily leveraged by scripts and applications to interact with SignalFx
@@ -177,7 +183,6 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -202,7 +207,7 @@ homepage: https://signalfx.com
 licenses:
 - Apache Software License v2 © SignalFx
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,9 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby client library for SignalFx
 test_files: []

data/Gemfile.lock

@@ -1,121 +0,0 @@
-PATH
-  remote: .
-  specs:
-    signalfx (2.1.0)
-      activesupport (>= 3.2)
-      protobuf (>= 3.5.1)
-      rest-client (~> 2.0)
-      websocket-client-simple (~> 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    daemons (1.2.4)
-    diff-lcs (1.2.5)
-    docile (1.3.1)
-    domain_name (0.5.20180417)
-      unf (>= 0.0.5, < 1.0.0)
-    event_emitter (0.2.6)
-    eventmachine (1.2.5)
-    faye-websocket (0.10.7)
-      eventmachine (>= 0.12.0)
-      websocket-driver (>= 0.5.1)
-    hashdiff (0.3.7)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    i18n (1.1.0)
-      concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    method_source (0.8.2)
-    middleware (0.1.0)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
-    minitest (5.11.3)
-    netrc (0.11.0)
-    protobuf (3.8.4)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    public_suffix (3.0.2)
-    rack (2.0.3)
-    rake (10.4.2)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    slop (3.6.0)
-    thin (1.7.2)
-      daemons (~> 1.0, >= 1.0.9)
-      eventmachine (~> 1.0, >= 1.0.4)
-      rack (>= 1, < 3)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.5)
-    webmock (2.3.2)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-    websocket (1.2.8)
-    websocket-client-simple (0.3.0)
-      event_emitter
-      websocket
-    websocket-driver (0.6.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.10)
-  faye-websocket (~> 0.10.7)
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.3)
-  signalfx!
-  simplecov
-  thin (~> 1.7)
-  webmock (~> 2.3.1)
-
-BUNDLED WITH
-   1.16.3