netflix-spectator-rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7f6b3e0e0113f8cbe55f8fd1e18767ace79da07883cc9df6cd6b852e01d3b3c
+  data.tar.gz: 805eba8ac1097710ce1b6a960dbc981bd5f42be458d38d94b129dea837601c46
+SHA512:
+  metadata.gz: 93a47c61d075d109db3c807e44b4476915965d17c452eabaec369c1901b09611b4b8eee2054eda1fb0d39e011bfc91bb60e46d7ea8ea9e434d921547318b1b78
+  data.tar.gz: c459973b622af7b87e524c0416d49ef334c83df510cc1e70da78d02929f5e5fb3db629265dcc9d85e24b6bb055a6984a15774c261eed661d02cfcef4ff3d3621

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spectator.gemspec'
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+- 2.5.1
+before_install: gem install bundler -v 1.16.1
+script: "./buildViaTravis.sh"
+deploy:
+  provider: rubygems
+  api_key:
+    secure: XGHhdcV4r3jxgL652dd+iKjkleu/djs99H4M5i3Hp1uPhv8P6lenTKnSByW3zzN37MSLbTs2NVnncnj5zOBnVYQf/0gok3cki9Qj/7m4XyOx5irn1dWR/MwuuWuzVU1DxDz8+27f8yNs8uz6b4dlDdI4aa5qQfJQW1v/lgXV+exTVoSvNPsAzE/I8v5v5n4rzycnNBx1bV0U4jfKx0vNmUKUhhQCaD1Uw77JcRvOkZYY26MD9xDf7bOMaAdAh2TSX54wvplyrjQltZsVA5/lvmR1U3ngvGnaZ3McypAB543+0MiCEdHASlJd0tFDMCC444b0Z38MWTklekEJd5OzF4s1amVD5SND5PRUqtrRonggLdszFa+Cw2tCDM5RcLQPrmcHPK6uIGn+vMmWDmmlvsFuzsxQ6Qmnur4iUh9A7c8y3Ic0b+MFxR9Er+C4xxxOS+R/C4+960/+KHKDoamcJ54FJb2JUSryXAlRkQQu9KOHplqgkUNvIb86Ekzg+em3AgsDdPQgUWhqJ4U7oTzMd0ww9K9p1Gol3UH2LkH5iOjAj/g9RhQNmMQCA3U9unqcZFCieYRhuVr4TFpRCmBOu1nuFs4g7KpUXcAifvx1A2s7DOTOyIzMsgtVIS0RcgvgfvLQArz8A696fZJ6+9YTd3jPyGZZ1gKxCw7Ep0UZw0U=
+  gem: netflix-spectator-rb
+  on:
+    tags: true
+    repo: Netflix/spectator-rb

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in spectator.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    netflix-spectator-rb (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  netflix-spectator-rb!
+  rake (~> 10.0)
+  rubocop (~> 0.55)
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/OSSMETADATA

@@ -0,0 +1 @@
+osslifecycle=active

data/README.md

@@ -0,0 +1,110 @@
+[![Build Status](https://travis-ci.org/Netflix/spectator-rb.svg?branch=master)](https://travis-ci.org/Netflix/spectator-rb) 
+# Netflix-Spectator-rb
+
+> :warning: Experimental
+
+Simple library for instrumenting code to record dimensional time series.
+
+## Description
+
+This implements a basic [Spectator](https://github.com/Netflix/spectator)
+library for instrumenting ruby applications, sending metrics to an Atlas
+aggregator service.
+
+## Instrumenting Code
+
+```ruby
+require 'spectator'
+
+class Response
+  attr_accessor :status, :size
+
+  def initialize(status, size)
+    @status = status
+    @size = size
+  end
+end
+
+class Request
+  attr_reader :country
+
+  def initialize(country)
+    @country = country
+  end
+end
+
+class ExampleServer
+  def initialize(registry)
+    @registry = registry
+    @req_count_id = registry.new_id('server.requestCount')
+    @req_latency = registry.timer('server.requestLatency')
+    @resp_sizes = registry.distribution_summary('server.responseSizes')
+  end
+
+  def handle_request(request)
+    start = @registry.clock.monotonic_time
+
+    # initialize response
+    response = Response.new(200, 64)
+
+    # Update the counter id with dimensions based on the request. The
+    # counter will then be looked up in the registry which should be
+    # fairly cheap, such as lookup of id object in a map
+    # However, it is more expensive than having a local variable set
+    # to the counter.
+    cnt_id = @req_count_id.with_tag(:country, request.country)
+                          .with_tag(:status, response.status.to_s)
+    @registry.counter_with_id(cnt_id).increment
+
+    # ...
+    @req_latency.record(@registry.clock.monotonic_time - start)
+    @resp_sizes.record(response.size)
+  end
+end
+
+config = {
+  common_tags: { :'nf.app' => 'foo' },
+  frequency: 0.5,
+  uri: 'http://localhost:8080/api/v4/publish'
+}
+
+registry = Spectator::Registry.new(config)
+registry.start
+
+server = ExampleServer.new(registry)
+
+# ...
+# process some requests
+requests = [Request.new('us'), Request.new('ar'), Request.new('ar')]
+requests.each { |req| server.handle_request(req) }
+sleep(2)
+
+registry.stop
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spectator-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spectator-rb
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Netflix/spectator-rb.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'spectator'
+
+# 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/buildViaTravis.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+set -x
+
+bundle exec rake test
+bundle exec rake rubocop

data/lib/spectator/atomic_number.rb

@@ -0,0 +1,49 @@
+module Spectator
+  # Thread safe number operations
+  class AtomicNumber
+    def initialize(init)
+      @value = init
+      @lock = Mutex.new
+    end
+
+    def set(value)
+      @lock.synchronize { @value = value }
+    end
+
+    def get
+      @lock.synchronize { @value }
+    end
+
+    def get_and_set(value)
+      @lock.synchronize do
+        tmp = @value
+        @value = value
+        tmp
+      end
+    end
+
+    def get_and_add(amount)
+      @lock.synchronize do
+        tmp = @value
+        @value += amount
+        tmp
+      end
+    end
+
+    def add_and_get(amount)
+      @lock.synchronize { @value += amount }
+    end
+
+    def max(value)
+      v = value.to_f
+      @lock.synchronize do
+        @value = v if v > @value || @value.nan?
+      end
+      @value
+    end
+
+    def to_s
+      "AtomicNumber{#{@value}}"
+    end
+  end
+end

data/lib/spectator/clock.rb

@@ -0,0 +1,57 @@
+module Spectator
+  # A timing source that can be used to access the current time as an object,
+  # and a high resolution monotonic time
+  class SystemClock
+    # A monotonically increasing number of nanoseconds. This is useful for
+    # recording times, or benchmarking.
+    # Note that this is not guaranteed to be steady.
+    # In other words each tick of the underlying clock may not
+    # be the same length (e.g. some seconds might be longer than others)
+    # @return A monotonic number of nanoseconds
+    def monotonic_time
+      MonotonicTime.time_in_nanoseconds
+    end
+
+    # @return a time object for the current time
+    def wall_time
+      Time.now
+    end
+  end
+
+  # A timing source useful in unit tests that can be used to mock the methods in
+  # SystemClock
+  class ManualClock
+    attr_accessor :wall_time
+    attr_accessor :monotonic_time
+
+    # Get a new object using 2000-1-1 0:0:0 UTC as the default time,
+    # and 0 nanoseconds as the number of nanos reported by monotonic_time
+    def initialize(wall_init: Time.utc(2000, 'jan', 1, 0, 0, 0), mono_time: 0)
+      @wall_time = wall_init
+      @monotonic_time = mono_time
+    end
+  end
+
+  # Gather a monotonically increasing number of nanoseconds.
+  # If Process::CLOCK_MONOTONIC is available  we use that, otherwise we attempt
+  # to use java.lang.System.nanoTime if running in jruby, and fallback
+  # to the Time.now implementation
+  module MonotonicTime
+    module_function
+
+    if defined? Process::CLOCK_MONOTONIC
+      def time_in_nanoseconds
+        Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+      end
+    elsif (defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby') == 'jruby'
+      def time_in_nanoseconds
+        java.lang.System.nanoTime
+      end
+    else
+      def time_in_nanoseconds
+        t = Time.now
+        t.to_i * 10**9 + t.nsec
+      end
+    end
+  end
+end

data/lib/spectator/counter.rb

@@ -0,0 +1,34 @@
+require 'spectator/atomic_number'
+require 'spectator/measure'
+
+module Spectator
+  # A counter is used to measure the rate at which an event is occurring
+  class Counter
+    # Initialize a new instance setting its id, and starting the
+    # count at 0
+    def initialize(id)
+      @id = id
+      @count = AtomicNumber.new(0)
+    end
+
+    # Increment the counter by delta
+    def increment(delta = 1)
+      @count.add_and_get(delta)
+    end
+
+    # Get the current count as a list of Measure and reset the count to 0
+    def measure
+      [Measure.new(@id.with_stat('count'), @count.get_and_set(0))]
+    end
+
+    # Read the current count. Calls to measure will reset it
+    def count
+      @count.get
+    end
+
+    # Get a string representation for debugging purposes
+    def to_s
+      "Counter{id=#{@id}, count=#{@count.get}}"
+    end
+  end
+end

data/lib/spectator/distribution_summary.rb

@@ -0,0 +1,53 @@
+require 'spectator/atomic_number'
+
+module Spectator
+  # Track the sample distribution of events. An example would be the response
+  # sizes for requests hitting an http server.
+  #
+  # The class will report measurements for the total amount, the count, max,
+  # and the  total of the square of the amounts recorded
+  # (useful for computing a standard deviation)
+  class DistributionSummary
+    # Initialize a new DistributionSummary instance with a given id
+    def initialize(id)
+      @id = id
+      @count = AtomicNumber.new(0)
+      @total_amount = AtomicNumber.new(0)
+      @total_sq = AtomicNumber.new(0)
+      @max = AtomicNumber.new(Float::NAN)
+    end
+
+    # Update the statistics kept by the summary with the specified amount.
+    def record(amount)
+      return if amount < 0
+      @count.add_and_get(1)
+      @total_amount.add_and_get(amount)
+      @total_sq.add_and_get(amount * amount)
+      @max.max(amount)
+    end
+
+    # Get the current amount
+    def count
+      @count.get
+    end
+
+    # Return the total amount
+    def total_amount
+      @total_amount.get
+    end
+
+    # Get a list of measurements, and reset the stats
+    # The stats returned are the current count, the total amount,
+    # the sum of the square of the amounts recorded, and the max value
+    def measure
+      cnt = Measure.new(@id.with_stat('count'), @count.get_and_set(0))
+      tot = Measure.new(@id.with_stat('totalAmount'),
+                        @total_amount.get_and_set(0))
+      tot_sq = Measure.new(@id.with_stat('totalOfSquares'),
+                           @total_sq.get_and_set(0))
+      mx = Measure.new(@id.with_stat('max'), @max.get_and_set(Float::NAN))
+
+      [cnt, tot, tot_sq, mx]
+    end
+  end
+end