leafy 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1b49abac340e348e0156101514c137676b3d991421c131aa1e17e355569c9100
-  data.tar.gz: 783a600f3f1e2a0f5342e8b089a485e8db4b9a895e7181808b8f4c15d454688b
+SHA1:
+  metadata.gz: 8ee2759101c056ce54047bf36e2d4408312453d4
+  data.tar.gz: 158faa4349ea468d9b9ba732fa7cceec01a8b494
 SHA512:
-  metadata.gz: 5066ea41848d6382a7c8265ebe3782a3c4dde5d8bccf7318f0d797c176e2fc17aa85212d42d1725f092eafe192545aff7ef367d553356f66b82980ff24698403
-  data.tar.gz: 3e4122b4e40c43ddb0780d5b6d0a009bfec9a953fd81780cec701655be8ffc03e743f8be4586d7800051148322ef6324765ad0d72a20a4939c0accb630b52224
+  metadata.gz: a8f85ba0d4c9c46c0935db0e8f669c45c92b34fc47527c522524c621d99c3a3ecceac8492e18142c4b1ade72232cbcdcd3f15d8b5b7a380b41efefadecb54a43
+  data.tar.gz: de57665cb7ce27bfac0325c3c0aad6ad94a191598bd63536153c9c7bb031cb4978ae4cc4885e40b4ced3022307b6bcdd8c17b099bd612ca18529287c9acaf2a2

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - jruby
+  - 2.2
+  - 2.3
+  - 2.4
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'pry'
+gem 'byebug', platform: :mri
+gem 'coveralls', require: false
+

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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/README.md

@@ -0,0 +1,109 @@
+[gem]: https://rubygems.org/gems/leafy
+[travis]: https://travis-ci.org/leafy-metrics/leafy
+[gemnasium]: https://gemnasium.com/leafy-metrics/leafy
+[codeclimate]: https://codeclimate.com/github/leafy-metrics/leafy
+[coveralls]: https://coveralls.io/r/leafy-metrics/leafy
+[codeissues]: https://codeclimate.com/github/leafy-metrics/leafy
+
+# Port of Dropwizard Metrics-Core
+
+[![Gem Version](https://badge.fury.io/rb/leafy.svg)][gem]
+[![Build Status](https://travis-ci.org/leafy-metrics/leafy.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/badges/github.com/leafy-metrics/leafy.svg)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/leafy-metrics/leafy/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/leafy-metrics/leafy/badge.svg?branch=master)][coveralls]
+[![Issue Count](https://codeclimate.com/github/leafy-metrics/leafy/badges/issue_count.svg)][codeissues]
+
+This is literal port of [http://metrics.dropwizard.io/3.1.0/](http://metrics.dropwizard.io/3.1.0/). as the naming convention of Java is slightly different some internal variable names still following the Java naming convention. all public method names are using Ruby naming conventions.
+
+There are also serveral parts missing, they are easy to add to contributions here are welcome.
+
+Most work was only possible to excelant [concurrency-ruby gem](https://github.com/ruby-concurrency/concurrent-ruby) which allows to copy most concurrency semantic one to one over to ruby. This gem really made the port a `copy and paste` and then `find and replace` job.
+
+## State of the Code
+
+Currently no Reporters are there. once they are in place things are ready to be used.
+
+## Rubygems/Bundler
+
+```
+gem install leafy
+```
+
+or Gemfile:
+```
+gem 'leafy'
+```
+
+## Getting Started
+
+
+``` Ruby
+registry = Leafy::Core::MetricRegistry.new
+meter = registry.meter('throughput')
+
+reporter = Leafy::Core::ConsoleReporter::Builder.for_registry(registry) do
+  output_to STDERR
+  shutdown_executor_on_stop true
+end
+reporter.start(0, 10) # no initial_delay, report any 10 seconds
+
+meter.mark(10)
+
+```
+
+use `irb -rleafy/core/metric_registry -rleafy/core/console_reporter` to start irb and copy and paste above code snippet.
+
+## Note on spawning processes
+
+``` Ruby
+registry = Leafy::Core::MetricRegistry.new
+meter = registry.meter('throughput')
+
+Process.fork do
+  reporter = Leafy::Core::ConsoleReporter::Builder.for_registry(registry) do
+    output_to STDOUT
+    shutdown_executor_on_stop true
+  end
+  reporter.start(0, 10) # no initial_delay, report any 10 seconds
+  while true; end
+end
+
+meter.mark(10)
+
+```
+
+Here the reporter runs in different process and can not see the values on the meter changed by main process.
+
+See [Puma cluster config](puma.rb) for an example configuration of puma.
+
+## Misssing Bits from Dropwizard
+
+### Gauge
+
+none of the is done.
+
+### Reservoir
+
+only the `SlidingWindowReservoir` and its `UniformSnapshot` is implemented.
+
+### MetricRegistry
+
+* no listeners
+* no MetricSet
+* no MetricFilters on collection methods
+* no customer builder via Supplier
+* no Gauge factory methods
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## Alternative Libraries
+
+* [Ruby-Metrics](https://github.com/johnewart/ruby-metrics)
+* maybe others
+
+## Meta-Foo
+
+be happy and enjoy.

data/leafy.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "leafy/core/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "leafy"
+  spec.version       = Leafy::Core::VERSION
+  spec.authors       = [""]
+  spec.email         = [""]
+  spec.summary       = "Port of Dropwizards metrics-core to pure ruby"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/leafy-metrics/leafy"
+  spec.license       = "APL2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/lib/leafy/core/adder.rb

@@ -0,0 +1,28 @@
+require 'concurrent/thread_safe/util/adder'
+
+module Leafy
+  module Core
+    class Adder < Concurrent::ThreadSafe::Util::Adder
+      
+      # Returns the current sum.  The returned value is _NOT_ an
+      # atomic snapshot: Invocation in the absence of concurrent
+      # updates returns an accurate result, but concurrent updates that
+      # occur while the sum is being calculated might not be
+      # incorporated.
+      def sum_then_reset
+        x = base
+        self.base = 0
+        current_cells = cells
+        if current_cells
+          current_cells.each do |cell|
+            if cell
+              x += cell.value
+              cell.value = 0
+            end
+          end
+        end
+        x
+      end
+    end
+  end
+end

data/lib/leafy/core/clock.rb

@@ -0,0 +1,29 @@
+# An abstraction for how time passes. It is passed to {@link Timer} to track timing.
+module Leafy
+  module Core
+    class Clock 
+      # Returns the current time tick.
+      #
+      # @return time tick in nanoseconds
+      def tick
+        (Time.now.to_f * 1000000000).to_i
+      end
+
+      # Returns the current time in milliseconds.
+      #
+      # @return time in milliseconds
+      def time
+        (Time.now.to_f * 1000000).to_i
+      end
+
+      # The default clock to use.
+      #
+      # @return the default {@link Clock} instance
+      def self.default_clock
+        DEFAULT
+      end
+
+      DEFAULT = Clock.new
+    end
+  end
+end

data/lib/leafy/core/console_reporter.rb

@@ -0,0 +1,157 @@
+require_relative 'scheduled_reporter'
+require_relative 'clock'
+module Leafy
+  module Core
+    class ConsoleReporter < ScheduledReporter
+
+      class Builder
+        def self.for_registry(registry, &block)
+          result = new(registry)
+          if block_given?
+            result.instance_eval(&block)
+            result.build
+          else
+            result
+          end
+        end
+
+        def initialize(registry)
+          @registry = registry
+        end
+
+        def shutdown_executor_on_stop(value)
+          @shutdown_executor_on_stop = value
+        end
+
+        def output_to(output)
+          @output = output
+          self
+        end
+
+        def with_clock(clock)
+          @clock = clock
+          self
+        end
+
+        def schedule_on(executor)
+          @executor = executor
+        end
+
+        def build
+          ConsoleReporter.new(@registry,
+                    #locale,
+                    #timeZone,
+                    #rateUnit,
+                    #durationUnit,
+                    #filter,
+                    @executor,
+                    @shutdown_executor_on_stop,
+                    clock: @clock, output: @output)
+                    #disabledMetricAttributes
+        end
+      end
+
+      CONSOLE_WIDTH = 80
+      attr_reader :output, :clock
+      def initialize(registry, executor = nil, shutdownExecutorOnStop = true, output: nil, clock: nil)
+        super(registry, 'console-reporter', executor, shutdownExecutorOnStop)
+        @output = output || STDOUT
+        @clock = clock || Clock.default_clock
+      end
+
+      def print_report(metric, name, print_method)
+        unless metric.empty?
+          printWithBanner("-- #{name}", '-')
+          metric.each do |k,v|
+            output.puts(k)
+            print_method.call(v)
+          end
+          output.puts
+        end
+      end
+      private :print_report
+
+      def do_report(gauges,
+                    counters,
+                    histograms,
+                    meters,
+                    timers)
+        dateTime = Time.at(@clock.time / 1000000.0).utc
+        printWithBanner(dateTime.to_s, '=');
+        output.puts
+
+        print_report(gauges, 'Gauges', method(:printGauge))
+        print_report(counters, 'Counters', method(:printCounter))
+        print_report(histograms, 'Histograms', method(:printHistogram))
+        print_report(meters, 'Meters', method(:printMeter))
+        print_report(timers, 'Timers', method(:printTimer))
+
+        output.puts
+        output.flush
+      end
+
+      def printMeter(meter)
+        output.printf("             count = %d\n", meter.count)
+        output.printf("         mean rate = %2.2f events/%s\n", convert_rate(meter.mean_rate), rate_unit)
+        output.printf("     1-minute rate = %2.2f events/%s\n", convert_rate(meter.one_minute_rate), rate_unit)
+        output.printf("     5-minute rate = %2.2f events/%s\n", convert_rate(meter.five_minute_rate), rate_unit)
+        output.printf("    15-minute rate = %2.2f events/%s\n", convert_rate(meter.fifteen_minute_rate), rate_unit)
+      end
+      private :printMeter
+
+      def printCounter(counter)
+        output.printf("             count = %d\n", counter.count)
+      end
+      private :printCounter
+
+      def printGauge(gauge)
+        output.printf("             value = %s\n", gauge.value)
+      end
+      private :printGauge
+
+      def printHistogram(histogram)
+        output.printf("             count = %d\n", histogram.count)
+        snapshot = histogram.snapshot
+        output.printf("               min = %d\n", snapshot.min)
+        output.printf("               max = %d\n", snapshot.max)
+        output.printf("              mean = %2.2f\n", snapshot.mean)
+        output.printf("            stddev = %2.2f\n", snapshot.std_dev)
+        output.printf("            median = %2.2f\n", snapshot.median)
+        output.printf("              75%% <= %2.2f\n", snapshot.get_75th_percentile)
+        output.printf("              95%% <= %2.2f\n", snapshot.get_95th_percentile)
+        output.printf("              98%% <= %2.2f\n", snapshot.get_98th_percentile)
+        output.printf("              99%% <= %2.2f\n", snapshot.get_99th_percentile)
+        output.printf("            99.9%% <= %2.2f\n", snapshot.get_999th_percentile)
+      end
+      private :printHistogram
+
+      def printTimer(timer)
+        snapshot = timer.snapshot
+        output.printf("             count = %d\n", timer.count)
+        output.printf("         mean rate = %2.2f calls/%s\n", convert_rate(timer.mean_rate), rate_unit)
+        output.printf("     1-minute rate = %2.2f calls/%s\n", convert_rate(timer.one_minute_rate), rate_unit)
+        output.printf("     5-minute rate = %2.2f calls/%s\n", convert_rate(timer.five_minute_rate), rate_unit)
+        output.printf("    15-minute rate = %2.2f calls/%s\n", convert_rate(timer.fifteen_minute_rate), rate_unit)
+
+        output.printf("               min = %2.2f %s\n", convert_duration(snapshot.min), duration_unit)
+        output.printf("               max = %2.2f %s\n", convert_duration(snapshot.max), duration_unit)
+        output.printf("              mean = %2.2f %s\n", convert_duration(snapshot.mean), duration_unit)
+        output.printf("            stddev = %2.2f %s\n", convert_duration(snapshot.std_dev), duration_unit)
+        output.printf("            median = %2.2f %s\n", convert_duration(snapshot.median), duration_unit)
+        output.printf("              75%% <= %2.2f %s\n", convert_duration(snapshot.get_75th_percentile), duration_unit)
+        output.printf("              95%% <= %2.2f %s\n", convert_duration(snapshot.get_95th_percentile), duration_unit)
+        output.printf("              98%% <= %2.2f %s\n", convert_duration(snapshot.get_98th_percentile), duration_unit)
+        output.printf("              99%% <= %2.2f %s\n", convert_duration(snapshot.get_99th_percentile), duration_unit)
+        output.printf("            99.9%% <= %2.2f %s\n", convert_duration(snapshot.get_999th_percentile), duration_unit)
+      end
+      private :printTimer
+
+      def printWithBanner(string, char)
+        output.print(string)
+        output.print(' ')
+        (CONSOLE_WIDTH - string.size - 1).times { output.print(char) }
+        output.puts
+      end
+    end
+  end
+end