polyseerio 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8358926a5d67bc28c9bc79a638d5095d8c69c33c
-  data.tar.gz: d208509a37081b80f9fdd863b87d086f45ee6f16
+  metadata.gz: 16f2ef0fd6b6622958565152391927ab6ae358e7
+  data.tar.gz: 9166ea14ae11b4c31a068501e9f10aac305ba309
 SHA512:
-  metadata.gz: 34422281004974f2fa7197f75523651cc32483cc042b724ec6d72fdb81c180c8923a8747c27686374b9238b0ede340917bc5df44b708ec1e6d564a27a94176fe
-  data.tar.gz: 4980c3839bd68d77c8267ef361e4962c8a1b29938ab385f261fbe18b44d27624ef3869162d50e91d43c5737b15f36017879f9a76d1f26d3474e5304251d2debb
+  metadata.gz: bb3b8b002effa1260fba13e39b656a63328fb539e6b33b6ce80b7745b23c671993221fab0b02588ff43ce5a606eecd825bb0a3345ba2bf5acea87d0b099cd6b2
+  data.tar.gz: 88edf82571ff4fcba7583d57a501774d2fb61abd17d91a29302c5d0b9f533eab8df881263bf61ed00dc9b5c11f9ec320ca3ffaa30e779b24ada9bf75663cd941

data/README.md

@@ -4,6 +4,12 @@
 
 The official Polyseer.io SDK for Ruby. Detailed API information can be found at (https://polyseer.io/documentation).
 
+## About
+
+Polyseer.io is an Integrated Development Platform that instantly
+provides teams with the resources needed to build, support, and maintain world 
+class software products.
+
 ## Requirements
   - Ruby
   - gem
@@ -20,14 +26,15 @@ To add to your project Gemfile, insert:
 
 ## Example
 
-Examples are available in /example
+Be sure to check out the examples in /example.
 
 ## Environment Variables
 
 Certain values can be set in environment variables:
 
-  * POLYSEERIO_TOKEN access-token used for API calls
-  * RAILS_ENV        the current environment
+  * POLYSEERIO_TOKEN     access-token used for API calls
+  * RAILS_ENV            the current environment
+  * POLYSEERIO_LOG_LEVEL SDK logging level
 
 ## Usage
 
@@ -63,7 +70,7 @@ delaying and chaining async work.
 
 ## Example
 
-Examples are available in /example
+Be sure to check out the examples in /example.
 
 ## SDK Resources
 
@@ -74,20 +81,20 @@ client has been created you may use any of its resources.
 ### Polyseerio
 
   * Polyseerio
-    * .`start(options = {}) ⇒ Polyseerio::Client`
-      * Create a client and start an Agent.
-      * `options (Hash)`
-        - `:env`        environment variable that holds the current environment
-        - `:token`      an api token
-        - `:token_env`  if no token is provided, this environment variable will be checked
-        - `:agent`      a hash that will be used when starting this client's agent
-        - `:upsert_env` if an environment cannot be found it will be created
-        - `:version`    api version to use
-        - `:timeout`    integer containing number of ms to wait for server responses
-        - `:deduce`     if the environment should be deduced when not supplied
     * .`make(options = {}) ⇒ Polyseerio::Client`
       * Create a client.
       * `options (Hash)` see Polyseerio.start options.
+        - `:deduce (Boolean)` if the environment should be deduced when not supplied
+        - `:env (String)` environment variable that holds the current environment
+        - `:timeout (Integer)` integer containing number of ms to wait for server responses
+        - `:token (String)` an api token
+        - `:token_env (String)` if no token is provided, this environment variable will be checked
+        - `:upsert_env (Boolean)` if an environment cannot be found it will be created
+        - `:version (String)` api version to use
+    * .`start(options = {}) ⇒ Polyseerio::Client`
+      * Create a client and start an Agent.
+      * `options (Hash)`
+        - `:agent (Hash)` agent options (see client.start_agent options)
     * `::Enum`
       * `::Color (Hash)` platform color values
       * `::Determiner (Hash)` expectation deteriner types
@@ -104,17 +111,34 @@ client has been created you may use any of its resources.
     * `.current_environment ⇒ client.Environment`
       * Resolves the current environment **IF** it has been deduced.
     * `.start_agent(options = {}) ⇒ Polyseerio::Client`  
-      * Starts the Polyseer.io agent. Will use passed options or config.agent from client construction.
-    * `.Alert`
-    * `.Channel`
-    * `.Environment`
-    * `.Event`
-    * `.Expectation`
-    * `.Instance`
-    * `.LogicBlock`
-    * `.Member`
-    * `.Settings`
-    * `.Task`
+      * Starts the Polyseer.io agent for this client.
+      * `options`
+        - `.attach (Boolean)`
+        - `.attach_strategy (Symbol)`
+        - `.name (String)` instance name (will be used as a unique id)
+        - `.description (String)` a description of this instance
+        - `.group (String)` what group this instance belongs to
+        - `.direction (String)` the monitoring direction (inbound) // force this
+        - `.subtype (Polyseerio::Enum::Subtype)` the instance subtype: periodic or long_running.
+        - `.expectation` will be upserted for this instance
+          - `.is_alive (Boolean)` create an expectation that this process is alive
+        - `.fact`
+          - `.engine (Boolean)` the current ruby engine
+          - `.gid (Boolean)` the group if othe process is running under
+          - `.launch_arguments (Boolean)` command used to launch the instance
+          - `.pid (Boolean)` the id of the process
+          - `.platform (Boolean)` the operating platform of
+          - `.ruby_version (Boolean)` the version of ruby being used
+          - `.uid (Boolean)` user id the process is running as
+        - `.metric`
+          - `.cpu (Boolean)` track user and system cpu usage
+          - `.memory (Boolean)` track memory usage
+          - `.uptime (Boolean)` track process uptime
+        - `.event`
+          - `.start (Boolean)` event notice when agent starts
+          - `.stop (Boolean)` event notice when agent stops
+        - `.process_event`
+          - `.exit (Boolean)` event notice on process exit
     
 ### Alert
 
@@ -305,3 +329,8 @@ Requires the environment to have a root level access-token defined as:
 ### All
 
     make test
+
+## Debugging
+
+Set the environment variable POLYSEERIO_LOG_LEVEL to debug in order to get
+detailed logging information.

data/lib/agent/agent.rb

@@ -12,6 +12,8 @@ module Polyseerio
 
       # Starts the agent.
       def start(*args)
+        Polyseerio.log 'debug', 'Starting agent.'
+
         Executor.setup(client, *args)
                 .then do |instance|
                   @instance = instance

data/lib/agent/default_config.rb

@@ -24,8 +24,13 @@ module Polyseerio
         is_alive: true
       },
       fact: {
-        pid: true,
-        gid: true
+        Enum::Fact::ENGINE => true,
+        Enum::Fact::GID => true,
+        Enum::Fact::LAUNCH_ARGUMENTS => true,
+        Enum::Fact::PID => true,
+        Enum::Fact::PLATFORM => true,
+        Enum::Fact::RUBY_VERSION => true,
+        Enum::Fact::UID => true
       },
       metric: {
         memory: true,

data/lib/agent/enum.rb

@@ -11,8 +11,13 @@ module Polyseerio
       end
 
       module Fact
-        PID  = :pid
-        GID  = :gid
+        ENGINE           = :engine
+        GID              = :gid
+        LAUNCH_ARGUMENTS = :launch_arguments
+        PID              = :pid
+        PLATFORM         = :platform
+        RUBY_VERSION     = :ruby_version
+        UID              = :uid
       end
 
       module Signal

data/lib/agent/executor.rb

@@ -11,6 +11,8 @@ module Polyseerio
     module Executor
       # Setsup a client's agent.
       def self.setup(client, options = {})
+        Polyseerio.log 'debug', 'Setting up client agent.'
+
         options = Polyseerio::Helper.defaults(options, DEFAULT_CONFIG)
 
         Concurrent::Promise.new do
@@ -42,6 +44,7 @@ module Polyseerio
             Concurrent::Promise.zip(*setups).execute.value
 
             # Start monitoring.
+            Polyseerio.log 'debug', 'Attaching instance to Polyseer.io'
             instance.attach.execute.value
 
             instance

data/lib/agent/handler/fact.rb

@@ -4,12 +4,34 @@ module Polyseerio
     module Handler
       def self.fact
         {
-          Fact::PID => proc do |_config, client|
-            client.instance.set_fact('pid', ::Process.pid)
+          Fact::ENGINE => proc do |_config, client|
+            client.instance.add_fact('engine', RUBY_ENGINE)
           end,
 
           Fact::GID => proc do |_config, client|
-            client.instance.set_fact('gid', ::Process.gid)
+            client.instance.add_fact('gid', ::Process.gid)
+          end,
+
+          Fact::LAUNCH_ARGUMENTS => proc do |_config, client|
+            value = ARGV.join('')
+
+            client.instance.add_fact('launch_arguments', value)
+          end,
+
+          Fact::PID => proc do |_config, client|
+            client.instance.add_fact('pid', ::Process.pid)
+          end,
+
+          Fact::PLATFORM => proc do |_config, client|
+            client.instance.add_fact('platform', RUBY_PLATFORM)
+          end,
+
+          Fact::RUBY_VERSION => proc do |_config, client|
+            client.instance.add_fact('ruby_version', RUBY_VERSION)
+          end,
+
+          Fact::UID => proc do |_config, client|
+            client.instance.add_fact('uid', ::Process.uid)
           end
         }
       end

data/lib/agent/helper.rb

@@ -23,7 +23,9 @@ module Polyseerio
       def self.create_handler(iteratee)
         proc do |map, client, config, type, *args|
           if map.key? type.to_sym
-            if config.key? type
+            if config.key? type # to_sym?
+              Polyseerio.log 'debug', "Performing handler work for: #{type}."
+
               # TODO: unit-test passed args
               work = config.fetch(type)
                            .map(&iteratee.call(map.fetch(type), client, *args))
@@ -42,6 +44,8 @@ module Polyseerio
       # Returns a setup handler function.
       @setup = proc do |handlers_outer, *args_outer|
         setup_iterator = proc do |handlers, key, value, *args|
+          Polyseerio.log 'debug', "Setting up handler for: #{key}."
+
           handler = handlers.fetch(key)
 
           if handler.respond_to? :call
@@ -59,6 +63,8 @@ module Polyseerio
 
       @teardown = proc do |handlers_outer, *args_outer|
         teardown_iterator = proc do |handlers, key, _value, *args|
+          Polyseerio.log 'debug', "Tearing down handler for: #{key}."
+
           if handlers.fetch(key).key? Handler::Interface::TEARDOWN
             handlers.fetch(key).fetch(Handler::Interface::TEARDOWN).call(*args)
           else

data/lib/constant.rb

@@ -1,12 +1,13 @@
 module Polyseerio
   module Constant
-    ACCESS_TOKEN_HEADER  = 'X-AUTH-HEADER'.freeze
-    DEFAULT_API_BASE_URL = 'api.polyseer.io/polyseer'.freeze
-    DEFAULT_API_PROTOCOL = 'https://'.freeze
-    DEFAULT_API_VERSION  = 'v1'.freeze
-    DEFAULT_ENV          = 'RAILS_ENV'.freeze
-    DEFAULT_ENVIRONMENT  = 'development'.freeze
-    DEFAULT_TIMEOUT      = 10_000
-    DEFAULT_TOKEN_ENV    = 'POLYSEERIO_TOKEN'.freeze
+    ACCESS_TOKEN_HEADER     = 'X-AUTH-HEADER'.freeze
+    DEFAULT_API_BASE_URL    = 'api.polyseer.io/polyseer'.freeze
+    DEFAULT_API_PROTOCOL    = 'https://'.freeze
+    DEFAULT_API_VERSION     = 'v1'.freeze
+    DEFAULT_ENV             = 'RAILS_ENV'.freeze
+    DEFAULT_ENVIRONMENT     = 'development'.freeze
+    DEFAULT_HEARTBEAT_DELAY = 30_000
+    DEFAULT_TIMEOUT         = 10_000
+    DEFAULT_TOKEN_ENV       = 'POLYSEERIO_TOKEN'.freeze
   end
 end

data/lib/log.rb

@@ -0,0 +1,52 @@
+require 'logger'
+
+# Introduces a logger into the main module.
+module Polyseerio
+  class << self
+    attr_writer :logger
+
+    # Convert a string log level to a severity.
+    def level_to_severity(level) # rubocop:disable all
+      case level
+      when 'debug'
+        Logger::DEBUG
+      when 'error'
+        Logger::ERROR
+      when 'fatal'
+        Logger::FATAL
+      when 'info'
+        Logger::INFO
+      when 'unknown'
+        Logger::UNKNOWN
+      when 'warn'
+        Logger::WARN
+      else
+        raise ArgumentError, "Unsupported log level: #{level}."
+      end
+    end
+
+    # Gem logger.
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.level = if ENV.key? 'POLYSEERIO_LOG_LEVEL'
+                      level_to_severity ENV['POLYSEERIO_LOG_LEVEL']
+                    else
+                      Logger::ERROR
+                    end
+
+        log.progname = name
+      end
+    end
+
+    # Convenience logging method.
+    def log(severity, *args)
+      severity = if severity.is_a? String
+                   level_to_severity severity
+                 else
+                   severity
+                 end
+
+      logger.log(severity, *args)
+    end
+  end
+end

data/lib/polyseerio.rb

@@ -2,6 +2,7 @@ require 'resource/factory'
 require 'request'
 require 'middleware'
 require 'constant'
+require 'log'
 require 'enum'
 require 'client'
 require 'url_builder'
@@ -52,10 +53,12 @@ module Polyseerio
   }.freeze
 
   # Create a client and start it's agent.
-  def self.start(*args)
-    client = make(*args)
+  def self.start(options = {})
+    options = Helper.defaults(options, DEFAULT_CLIENT_OPTIONS)
+
+    client = make(options)
 
-    client.start_agent
+    client.start_agent(options[:agent])
   end
 
   @make_call_count = 0

data/lib/resource/base.rb

@@ -48,6 +48,16 @@ module Polyseerio
         id.nil?
       end
 
+      # TODO: move towards this
+      def get(key, default = nil)
+        @attributes.fetch(key, default)
+      end
+
+      # TODO: move towards this
+      def set(key, value)
+        @attributes[key] = value
+      end
+
       def method_missing(name, *args) # rubocop:disable all
         # Setter.
         if name =~ /^(\w+)=$/
@@ -60,8 +70,8 @@ module Polyseerio
         @attributes.fetch(name, nil)
       end
 
-      def respond_to_missing?(_method_name)
-        true
+      def respond_to_missing?(method_name)
+        !methods.include(method_name)
       end
 
       private

data/lib/resource/helper.rb

@@ -13,6 +13,11 @@ module Polyseerio
 
       # Given a request path an eid is returned or nil
       def self.get_eid_from_resource_path(path)
+        # TODO: consolidate with regex?
+        if path.include? '/environments/name/'
+          return path.split('/environments/name/').last
+        end
+
         result = EID_REGEX.match path
 
         return result if result.nil?

data/lib/sdk/factory.rb

@@ -12,7 +12,7 @@ module Polyseerio
 
         statics = statics.each_with_object({}, &accumulator)
 
-        # curry request,  resource, and options
+        # curry request, resource, and options
         statics.each_with_object(statics) do |(name, static), hash|
           if static.arity > 3
             hash[name] = static.curry.call(request, resource, options)
@@ -27,7 +27,11 @@ module Polyseerio
     module Method
       # Generates method (instance) functions.
       def self.factory(_request, _resource, methods = [], _options = {})
-        methods.each_with_object({}, &Helper.accumulate_procs('method', MAP))
+        accumulator = Helper.accumulate_procs('method', MAP)
+
+        methods = methods.each_with_object({}, &accumulator)
+
+        methods
       end
     end
   end

data/lib/sdk/helper.rb

@@ -6,6 +6,16 @@ module Polyseerio
   module SDK
     # SDK helpers.
     module Helper
+      # Takes a hash and returns a new one that only contains values
+      # that are blocks / procs / anything callable aka resolvable.
+      def self.remove_non_resolving_values(hash)
+        hash.each_with_object({}) do |(key, value), acc|
+          acc[key] = value if value.respond_to? :call
+
+          acc
+        end
+      end
+
       # Takes an instance and returns a uri.
       def self.instance_to_uri(instance)
         URL.get_resource_path(

data/lib/sdk/method/add_fact.rb

@@ -4,9 +4,9 @@ module Polyseerio
     module Method
       def self.add_fact
         proc do |instance, key, value|
-          instance.facts ||= {}
+          instance._facts ||= {}
 
-          instance.facts[key] = value
+          instance._facts[key] = value
         end
       end
     end

data/lib/sdk/method/add_gauge.rb

@@ -4,9 +4,9 @@ module Polyseerio
     module Method
       def self.add_gauge
         proc do |instance, key, value|
-          instance.gauges ||= {}
+          instance._gauges ||= {}
 
-          instance.gauges[key] = value
+          instance._gauges[key] = value
         end
       end
     end

data/lib/sdk/method/attach.rb

@@ -1,5 +1,6 @@
 require 'sdk/helper'
 require 'concurrent'
+require 'constant'
 
 module Polyseerio
   module SDK
@@ -7,13 +8,29 @@ module Polyseerio
     module Method
       def self.attach
         proc do |instance|
+          options = Polyseerio::Helper.defaults(
+            {},
+            delay: Constant::DEFAULT_HEARTBEAT_DELAY
+          )
+
           uri = Helper.instance_to_uri instance
 
+          options[:delay] = Polyseerio::Helper.ms_to_seconds options[:delay]
+
           Concurrent::Promise.new do
-            heartbeat_thread = Thread.new(instance.request) do |req|
-              loop do
-                req.post("#{uri}/heartbeat", {}).execute.value
-                sleep(5)
+            heartbeat_thread = Thread.new(instance, options) do |inst, opts|
+              begin
+                loop do
+                  payload = {}
+
+                  Polyseerio.log 'debug', 'Sending heartbeat.'
+                  inst.request.post("#{uri}/heartbeat", payload).execute.value
+
+                  sleep(opts[:delay])
+                end
+              rescue => err
+                Polyseerio.log 'error', 'Heartbeat failed.'
+                Polyseerio.log 'error', err.message
               end
             end
 

data/polyseerio.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'polyseerio'
-  gem.version     = '0.0.1'
+  gem.version     = '0.0.2'
   gem.authors     = ['Nicolas Feigenbaum']
   gem.email       = ['support@kognizant.com']
   gem.description = 'The official Polyseer.io SDK for Ruby.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyseerio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas Feigenbaum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -138,6 +138,7 @@ files:
 - lib/constant.rb
 - lib/enum.rb
 - lib/helper.rb
+- lib/log.rb
 - lib/middleware.rb
 - lib/polyseerio.rb
 - lib/request.rb
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Polyseer.io SDK for Ruby.