sumologic-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9348d8d0deeb5aaee506aaa542e6e3764a23944b18b7116cc500e70a61daf749
+  data.tar.gz: dab1c3be242d91ec6541ef085f2232443e506f9feb797196cd0483c28f00c398
+SHA512:
+  metadata.gz: 22b57078ddb8b816387fac0b7305e4e647049471863189e7a5a55910914420b400a30e1e16b6b4d368af37d9be2508ca1abfd0966de7da556ce8376471616356
+  data.tar.gz: cd15cdc787769c4380eba58da16145a6e86942c616c0d75357bf607bae2120720ff22380eb9c9e5221f9ced61765d7df47417a955fa061d7f2fe655e09970ea5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+sudo: false
+
+rvm:
+  - 2.5.1
+  - jruby
+
+before_install: gem install bundler -v 1.16.1
+script: bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at josacar@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sumologic-metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    sumologic-metrics (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (11.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 11.0)
+  rspec (~> 3.7)
+  sumologic-metrics!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jose Luis Salas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Sumologic::Metrics
+
+[![Build Status](https://www.travis-ci.org/josacar/sumologic-metrics.svg?branch=master)](https://www.travis-ci.org/josacar/sumologic-metrics)
+
+Upload metrics to Sumologic!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sumologic-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sumologic-metrics
+
+## Usage
+
+```ruby
+require 'sumologic-metrics'
+
+url = ENV.fetch('SUMOLOGIC_ENDPOINT')
+
+metrics = Sumologic::Metrics.new(collector_uri: url)
+metrics.push('cluster=prod node=lb-1 metric=cpu  ip=2.2.3.4 team=infra 99.12 1528020619')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/josacar/sumologic-metrics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sumologic::Metrics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/josacar/sumologic-metrics/blob/master/CODE_OF_CONDUCT.md).
+
+## Thanks
+
+- SegmentIO for their [analytics-ruby](https://github.com/segmentio/analytics-ruby) gem

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sumologic/metrics'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sumologic/metrics/backoff_policy.rb

@@ -0,0 +1,47 @@
+require 'sumologic/metrics/defaults'
+
+module Sumologic; class Metrics
+  class BackoffPolicy
+    include Sumologic::Metrics::Defaults::BackoffPolicy
+
+    # @param [Hash] opts
+    # @option opts [Numeric] :min_timeout_ms The minimum backoff timeout
+    # @option opts [Numeric] :max_timeout_ms The maximum backoff timeout
+    # @option opts [Numeric] :multiplier The value to multiply the current
+    #   interval with for each retry attempt
+    # @option opts [Numeric] :randomization_factor The randomization factor
+    #   to use to create a range around the retry interval
+    def initialize(opts = {})
+      @min_timeout_ms = opts[:min_timeout_ms] || MIN_TIMEOUT_MS
+      @max_timeout_ms = opts[:max_timeout_ms] || MAX_TIMEOUT_MS
+      @multiplier = opts[:multiplier] || MULTIPLIER
+      @randomization_factor = opts[:randomization_factor] || RANDOMIZATION_FACTOR
+
+      @attempts = 0
+    end
+
+    # @return [Numeric] the next backoff interval, in milliseconds.
+    def next_interval
+      interval = @min_timeout_ms * (@multiplier**@attempts)
+      interval = add_jitter(interval, @randomization_factor)
+
+      @attempts += 1
+
+      [interval, @max_timeout_ms].min
+    end
+
+    private
+
+    def add_jitter(base, randomization_factor)
+      random_number = rand
+      max_deviation = base * randomization_factor
+      deviation = random_number * max_deviation
+
+      if random_number < 0.5
+        base - deviation
+      else
+        base + deviation
+      end
+    end
+  end
+end; end

data/lib/sumologic/metrics/client.rb

@@ -0,0 +1,124 @@
+require 'thread'
+require 'time'
+
+require 'sumologic/metrics/defaults'
+require 'sumologic/metrics/logging'
+require 'sumologic/metrics/utils'
+require 'sumologic/metrics/worker'
+
+module Sumologic; class Metrics
+  class Client
+    include Sumologic::Metrics::Utils
+    include Sumologic::Metrics::Logging
+
+    # @param [Hash] opts
+    # @option opts [String] :collector_uri Your project's collector_uri
+    # @option opts [FixNum] :max_queue_size Maximum number of calls to be
+    #   remain queued.
+    # @option opts [Proc] :on_error Handles error calls from the API.
+    def initialize(opts = {})
+      symbolize_keys!(opts)
+
+      @queue = Queue.new
+      @collector_uri = opts[:collector_uri]
+      @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
+      @options = opts
+      @worker_mutex = Mutex.new
+      @worker = Worker.new(@queue, @collector_uri, @options)
+
+      check_collector_uri!
+
+      at_exit { @worker_thread && @worker_thread[:should_exit] = true }
+    end
+
+    # Synchronously waits until the worker has flushed the queue.
+    #
+    # Use only for scripts which are not long-running, and will specifically
+    # exit
+    def flush
+      while !@queue.empty? || @worker.is_requesting?
+        ensure_worker_running
+        sleep(0.1)
+      end
+    end
+
+    # Pushes a metric
+    #
+    # @see https://help.sumologic.com/Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/Upload-Data-to-an-HTTP-Source#About_the_Carbon_2.0_example_data_points
+    #
+    # @param [String] metric
+    def push(metric)
+      check_presence!(metric)
+      check_carbon_format!(metric)
+
+      enqueue(metric)
+    end
+
+    # @return [Fixnum] number of metrics in the queue
+    def queued_metrics
+      @queue.length
+    end
+
+    private
+
+    # private: Enqueues the action.
+    #
+    # returns Boolean of whether the item was added to the queue.
+    def enqueue(metric)
+      if @queue.length < @max_queue_size
+        @queue << metric
+        ensure_worker_running
+
+        true
+      else
+        logger.warn(
+          'Queue is full, dropping events. The :max_queue_size ' \
+          'configuration parameter can be increased to prevent this from ' \
+          'happening.'
+        )
+        false
+      end
+    end
+
+    # private: Ensures that a string is non-empty
+    #
+    # obj    - String|Number that must be non-blank
+    #
+    def check_presence!(obj)
+      if obj.nil? || (obj.is_a?(String) && obj.empty?)
+        raise ArgumentError, 'metric must be given'
+      end
+    end
+
+    # private: Checks that the collector_uri is properly initialized
+    def check_collector_uri!
+      raise ArgumentError, 'collector URI must be initialized' if @collector_uri.nil?
+    end
+
+    # private: Checks the metric is Carbon 2
+    def check_carbon_format!(metric)
+      tag = '[^\s]+=[^\s]+'
+      intrinsic_tags = "(?<intrinsic_tags>#{tag}(?: #{tag})+)"
+      meta_tags = "(?<meta_tags>#{tag}(?:\s#{tag})*)"
+      value = '(?<value>[\d|\.]+)'
+      timestamp = '(?<timestamp>\d+)'
+      r = Regexp.new(/#{intrinsic_tags}  (?:#{meta_tags}\s)?#{value} #{timestamp}/)
+      raise ArgumentError, 'metric should be in Carbon 2 format' unless r.match?(metric)
+    end
+
+
+    def ensure_worker_running
+      return if worker_running?
+      @worker_mutex.synchronize do
+        return if worker_running?
+        @worker_thread = Thread.new do
+          @worker.run
+        end
+      end
+    end
+
+    def worker_running?
+      @worker_thread && @worker_thread.alive?
+    end
+  end
+end; end

data/lib/sumologic/metrics/defaults.rb

@@ -0,0 +1,29 @@
+module Sumologic; class Metrics; module Defaults
+  module Request
+    HEADERS = {
+      'Content-Type' => 'application/vnd.sumologic.carbon2',
+      'User-Agent' => "sumologic-metrics/#{Sumologic::Metrics::VERSION}"
+    }.freeze
+    RETRIES = 10
+  end
+
+  module Queue
+    MAX_SIZE = 10_000
+  end
+
+  module Metric
+    MAX_BYTES = 32_768 # 32Kb
+  end
+
+  module MetricBatch
+    MAX_BYTES = 512_000 # 500Kb
+    MAX_SIZE = 100
+  end
+
+  module BackoffPolicy
+    MIN_TIMEOUT_MS = 100
+    MAX_TIMEOUT_MS = 10_000
+    MULTIPLIER = 1.5
+    RANDOMIZATION_FACTOR = 0.5
+  end
+end; end; end

data/lib/sumologic/metrics/logging.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+module Sumologic; class Metrics; module Logging
+  class << self
+    def logger
+      @logger ||= begin
+                    logger = Logger.new(STDOUT)
+                    logger.level = Logger::INFO
+                    logger.progname = 'Sumologic::Metrics'
+                    logger
+                  end
+    end
+
+    attr_writer :logger
+  end
+
+  def self.included(base)
+    class << base
+      def logger
+        Logging.logger
+      end
+    end
+  end
+
+  def logger
+    Logging.logger
+  end
+end; end; end

data/lib/sumologic/metrics/metric.rb

@@ -0,0 +1,21 @@
+require 'sumologic/metrics/defaults'
+
+module Sumologic; class Metrics
+  class Metric
+    def initialize(content)
+      @content = content
+    end
+
+    def too_big?
+      size > Defaults::Metric::MAX_BYTES
+    end
+
+    def size
+      @content.bytesize
+    end
+
+    def to_s
+      @content
+    end
+  end
+end; end

data/lib/sumologic/metrics/metric_batch.rb

@@ -0,0 +1,60 @@
+require 'forwardable'
+require 'sumologic/metrics/logging'
+
+module Sumologic; class Metrics
+  # A batch of `metric`s to be sent to the API
+  class MetricBatch
+    extend Forwardable
+    include Sumologic::Metrics::Logging
+    include Sumologic::Metrics::Defaults::MetricBatch
+
+    def initialize(max_metric_count)
+      @metrics = []
+      @max_metric_count = max_metric_count
+      @size = 0
+    end
+
+    def <<(metric)
+      if metric.too_big?
+        logger.error('a metric exceeded the maximum allowed size')
+      else
+        @metrics << metric
+        @size += metric.size + 2 # One byte for new line
+      end
+    end
+
+    def full?
+      item_count_exhausted? || size_exhausted?
+    end
+
+    def clear
+      @metrics.clear
+      @json = 0
+    end
+
+    def to_s
+      @metrics.join("\n")
+    end
+
+    def_delegators :@metrics, :empty?
+    def_delegators :@metrics, :length
+
+    private
+
+    def item_count_exhausted?
+      @metrics.length >= @max_metric_count
+    end
+
+    # We consider the max size here as just enough to leave room for one more
+    # metric of the largest size possible. This is a shortcut that allows us
+    # to use a native Ruby `Queue` that doesn't allow peeking. The tradeoff
+    # here is that we might fit in less metrics than possible into a batch.
+    #
+    # The alternative is to use our own `Queue` implementation that allows
+    # peeking, and to consider the next metric size when calculating whether
+    # the metric can be accomodated in this batch.
+    def size_exhausted?
+      @size >= (MAX_BYTES - Defaults::Metric::MAX_BYTES)
+    end
+  end
+end; end

data/lib/sumologic/metrics/request.rb

@@ -0,0 +1,128 @@
+require 'sumologic/metrics/defaults'
+require 'sumologic/metrics/utils'
+require 'sumologic/metrics/response'
+require 'sumologic/metrics/logging'
+require 'sumologic/metrics/backoff_policy'
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module Sumologic; class Metrics
+  class Request
+    include Sumologic::Metrics::Defaults::Request
+    include Sumologic::Metrics::Utils
+    include Sumologic::Metrics::Logging
+
+    # public: Creates a new request object to send metrics batch
+    #
+    def initialize(options = {})
+      @headers = options[:headers] || HEADERS
+      @retries = options[:retries] || RETRIES
+      @backoff_policy =
+        options[:backoff_policy] || Sumologic::Metrics::BackoffPolicy.new
+
+      uri = URI(options.fetch(:uri))
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.set_debug_output(logger) if logger.level == Logger::DEBUG
+      http.use_ssl = uri.scheme == 'https'
+      http.read_timeout = 8
+      http.open_timeout = 4
+
+      @path = uri.path
+      @http = http
+    end
+
+    # public: Posts the write key and batch of messages to the API.
+    #
+    # returns - Response of the status and error if it exists
+    def post(batch)
+      last_response, exception = retry_with_backoff(@retries) do
+        status_code, body, message = send_request(batch)
+
+        should_retry = should_retry_request?(status_code, body)
+
+        [Response.new(status_code, message), should_retry]
+      end
+
+      if exception
+        logger.error(exception.message)
+        exception.backtrace.each { |line| logger.error(line) }
+        Response.new(-1, "Connection error: #{exception}")
+      else
+        last_response
+      end
+    end
+
+    private
+
+    def should_retry_request?(status_code, body)
+      if status_code >= 500
+        true # Server error
+      elsif status_code == 429
+        true # Rate limited
+      elsif status_code >= 400
+        logger.error(body)
+        false # Client error. Do not retry, but log
+      else
+        false
+      end
+    end
+
+    # Takes a block that returns [result, should_retry].
+    #
+    # Retries upto `retries_remaining` times, if `should_retry` is false or
+    # an exception is raised. `@backoff_policy` is used to determine the
+    # duration to sleep between attempts
+    #
+    # Returns [last_result, raised_exception]
+    def retry_with_backoff(retries_remaining, &block)
+      result, caught_exception = nil
+      should_retry = false
+
+      begin
+        result, should_retry = yield
+        return [result, nil] unless should_retry
+      rescue StandardError => e
+        p e
+        should_retry = true
+        caught_exception = e
+      end
+
+      if should_retry && (retries_remaining > 1)
+        sleep(@backoff_policy.next_interval.to_f / 1000)
+        retry_with_backoff(retries_remaining - 1, &block)
+      else
+        [result, caught_exception]
+      end
+    end
+
+    # Sends a request for the batch, returns [status_code, body]
+    def send_request(batch)
+      payload = batch.to_s
+      request = Net::HTTP::Post.new(@path, @headers)
+
+      if self.class.stub
+        logger.debug "stubbed request to #{@path}: " \
+          "batch = '#{batch}'"
+
+        [200, '', 'OK']
+      else
+        # If `start` is not called, Ruby adds a 'Connection: close' header to
+        # all requests, preventing us from reusing a connection for multiple
+        # HTTP requests
+        @http.start unless @http.started?
+
+        response = @http.request(request, payload)
+        [response.code.to_i, response.body, response.message]
+      end
+    end
+
+    class << self
+      attr_writer :stub
+
+      def stub
+        @stub || ENV['STUB']
+      end
+    end
+  end
+end; end

data/lib/sumologic/metrics/response.rb

@@ -0,0 +1,13 @@
+module Sumologic; class Metrics
+  class Response
+    attr_reader :status, :message
+
+    # public: Simple class to wrap responses from the API
+    #
+    #
+    def initialize(status = 200, message = nil)
+      @status = status
+      @message = message
+    end
+  end
+end; end

data/lib/sumologic/metrics/utils.rb

@@ -0,0 +1,29 @@
+require 'securerandom'
+
+module Sumologic; class Metrics
+  module Utils
+    module_function
+
+    # public: Return a new hash with keys converted from strings to symbols
+    #
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(k, v), memo|
+        memo[k.to_sym] = v
+      end
+    end
+
+    # public: Convert hash keys from strings to symbols in place
+    #
+    def symbolize_keys!(hash)
+      hash.replace(symbolize_keys(hash))
+    end
+
+    # public: Return a new hash with keys as strings
+    #
+    def stringify_keys(hash)
+      hash.each_with_object({}) do |(k, v), memo|
+        memo[k.to_s] = v
+      end
+    end
+  end
+end; end

data/lib/sumologic/metrics/version.rb

@@ -0,0 +1,5 @@
+module Sumologic
+  class Metrics
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/sumologic/metrics/worker.rb

@@ -0,0 +1,59 @@
+require 'sumologic/metrics/defaults'
+require 'sumologic/metrics/metric'
+require 'sumologic/metrics/metric_batch'
+require 'sumologic/metrics/request'
+require 'sumologic/metrics/utils'
+
+module Sumologic; class Metrics
+  class Worker
+    include Sumologic::Metrics::Utils
+    include Sumologic::Metrics::Defaults
+
+    # public: Creates a new worker
+    #
+    # The worker continuously takes metrics off the queue
+    # and makes requests to the Sumologic api
+    #
+    # queue   - Queue synchronized between client and worker
+    # collector_uri  - String of the unique collector URI
+    # options - Hash of worker options
+    #           batch_size - Fixnum of how many items to send in a batch
+    #           on_error   - Proc of what to do on an error
+    #
+    def initialize(queue, collector_uri, options = {})
+      symbolize_keys! options
+      @queue = queue
+      @collector_uri = collector_uri
+      @on_error = options[:on_error] || proc { |status, message| }
+      batch_size = options[:batch_size] || Defaults::MetricBatch::MAX_SIZE
+      @batch = MetricBatch.new(batch_size)
+      @lock = Mutex.new
+      @request = options[:request] || Request.new(uri: collector_uri)
+    end
+
+    # public: Continuously runs the loop to check for new events
+    #
+    def run
+      until Thread.current[:should_exit]
+        return if @queue.empty?
+
+        @lock.synchronize do
+          until @batch.full? || @queue.empty?
+            @batch << Metric.new(@queue.pop)
+          end
+        end
+
+        res = @request.post(@batch)
+        @on_error.call(res.status, res.message) unless res.status == 200
+
+        @lock.synchronize { @batch.clear }
+      end
+    end
+
+    # public: Check whether we have outstanding requests.
+    #
+    def is_requesting?
+      @lock.synchronize { !@batch.empty? }
+    end
+  end
+end; end

data/lib/sumologic/metrics.rb

@@ -0,0 +1,42 @@
+require 'sumologic/metrics/backoff_policy'
+require 'sumologic/metrics/client'
+require 'sumologic/metrics/defaults'
+require 'sumologic/metrics/metric'
+require 'sumologic/metrics/metric_batch'
+require 'sumologic/metrics/logging'
+require 'sumologic/metrics/worker'
+require 'sumologic/metrics/request'
+require 'sumologic/metrics/response'
+require 'sumologic/metrics/utils'
+require 'sumologic/metrics/version'
+require 'sumologic/metrics/worker'
+
+module Sumologic
+  class Metrics
+    # Initializes a new instance of {Sumologic::Metrics::Client}, to which all
+    # method calls are proxied.
+    #
+    # @param options includes options that are passed down to
+    #   {Sumologic::Metrics::Client#initialize}
+    # @option options [Boolean] :stub (false) If true, requests don't hit the
+    #   server and are stubbed to be successful.
+    def initialize(options = {})
+      Request.stub = options[:stub] if options.key?(:stub)
+      @client = Sumologic::Metrics::Client.new(options)
+    end
+
+    def method_missing(message, *args, &block)
+      if @client.respond_to?(message)
+        @client.send(message, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @client.respond_to?(method_name) || super
+    end
+
+    include Logging
+  end
+end

data/lib/sumologic-metrics.rb

@@ -0,0 +1 @@
+require 'sumologic/metrics'

data/sumologic-metrics.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sumologic/metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sumologic-metrics'
+  spec.version       = Sumologic::Metrics::VERSION
+  spec.authors       = ['Jose Luis Salas']
+  spec.email         = ['josacar@users.noreply.github.com']
+
+  spec.summary       = 'Sumologic metrics worker'
+  spec.description   = 'Send metrics to Sumologic in the background in batches'
+  spec.homepage      = 'https://github.com/josacar/sumologic-metrics'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: sumologic-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Luis Salas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Send metrics to Sumologic in the background in batches
+email:
+- josacar@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sumologic-metrics.rb
+- lib/sumologic/metrics.rb
+- lib/sumologic/metrics/backoff_policy.rb
+- lib/sumologic/metrics/client.rb
+- lib/sumologic/metrics/defaults.rb
+- lib/sumologic/metrics/logging.rb
+- lib/sumologic/metrics/metric.rb
+- lib/sumologic/metrics/metric_batch.rb
+- lib/sumologic/metrics/request.rb
+- lib/sumologic/metrics/response.rb
+- lib/sumologic/metrics/utils.rb
+- lib/sumologic/metrics/version.rb
+- lib/sumologic/metrics/worker.rb
+- sumologic-metrics.gemspec
+homepage: https://github.com/josacar/sumologic-metrics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Sumologic metrics worker
+test_files: []