null_statsd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdcda9d6bbce5d1ed55cac57ca33e769c6bfc9b2e18b4a3b852d183f37258d90
+  data.tar.gz: 9cb8dd40167d522dd1eb21dfce10e7e1318b2b20492465d5e110e6ae9c043769
+SHA512:
+  metadata.gz: 4501b0cfc958c6c872ed08dcc2ed0ef0e2c0903f9211a067970fc0d6b3f2821dd2e8061958e12275860afb29ffdd99f114ac4bc064cb48914b1f577f8ac4f2e8
+  data.tar.gz: 5ce718a612489f86b4f2c5502c9eedf2e14f465696a2f09860c0403f05d82faef948465057c0d5c71b8c2785972568696a47d6d50c5d9b1488eab23b9d066989

data/.github/workflows/rspec.yml

@@ -0,0 +1,23 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  RSpec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', 'head']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run RSpec
+        run: bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in null_statsd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Imad Mouaddine
+
+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,168 @@
+# NullStatsd
+
+NullStatsd is a [Statsd](https://github.com/statsd/statsd) implementation which utilizes the
+[Null Object Pattern](https://en.wikipedia.org/wiki/Null_object_pattern), allowing for a fully
+stubbed Statsd object in your development and testing environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'null_statsd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install null_statsd
+
+## Usage
+
+Create a thin wrapper around your Statsd implementation:
+
+```ruby
+module MyStatsd
+  def self.new
+    if ENV["STATSD_HOST"] # OR if Rails.development || Rails.staging ...
+      Statsd.new(statsd_host, statsd_port, *additional_params)
+    else
+      NullStatsd::Statsd.new(host: statsd_host, port: statsd_port, logger: Rails.logger)
+    end
+  end
+end
+```
+
+Create an instance and use it as normal:
+
+```ruby
+MyStatsd.new.increment(...)
+```
+
+Notice that your `statsd` endpoint is _not_ receiving data. Also notice that your _logs_ are
+receiving data.
+
+```
+[NullStatsD host:42] Incrementing media.book.consumed with opts {"genre":"science_fiction"}
+[NullStatsD host:42] Decrementing media.book.on_hand
+[NullStatsD host:42] Recording timing info in book.checkout -> 0.512917 sec
+```
+
+### Supported API
+
+```ruby
+instance = NullStatsd::Statsd.new(host: "fake.com", port: 4242, logger: Logger.new($stdout))
+```
+
+> [NullStatsD :-] Connecting to fake Statsd, pretending to be on fake.com:4242
+
+#### increment(stat, opts = {})
+
+```ruby
+instance.increment "media.book.consumed", genre: "horror"
+```
+
+> [NullStatsD :-] Incrementing media.book.consumed with opts genre:horror
+
+#### decrement(stat, opts = {})
+
+```ruby
+instance.decrement "media.book.on_hand", genre: "science fiction"
+```
+
+> [NullStatsD :-] Decrementing media.book.on_hand with opts genre:science fiction
+
+#### count(stat, opts = {})
+
+```ruby
+instance.count "responses", 3
+```
+
+> [NullStatsD :-] Increasing responses by 3
+
+#### guage(stat, opts = {})
+
+```ruby
+instance.guage "media.book.return_time", 12, measurement: "days"
+```
+
+> [NullStatsD :-] Setting guage media.book.return_time to 12 with opts measurement:days
+
+#### histogram(stat, opts = {})
+
+```ruby
+instance.histogram "media.book.lent.hour", 42
+```
+
+> [NullStatsD :-] Logging histogram media.book.lent.hour -> 42
+
+#### timing(stat, ms, opts = {})
+
+```ruby
+instance.timing "book checkout", 94, tags: "speedy"
+```
+
+> [NullStatsD :-] Timing book checkout at 94 ms with opts tags:speedy
+
+#### set(stat, opts = {})
+
+```ruby
+instance.set "media.book.lent", 10_000_000
+```
+
+> [NullStatsD :-] Setting media.book.lent to 10000000
+
+#### service_check(stat, opts = {})
+
+```ruby
+instance.service_check "door.locked", "ok"
+```
+
+> [NullStatsD :-] Service check door.locked: ok
+
+#### event(stat, opts = {})
+
+```ruby
+instance.event "Leak", "The library roof has a leak on the west end. Please take care"
+```
+
+> [NullStatsD :-] Event Leak: The library roof has a leak on the west end. Please take care
+
+#### time(stat, opts = {})
+
+```ruby
+instance.time("media.movie.consume") do
+  Movie.new().watch
+end
+```
+
+> [NullStatsD :-] Recording timing info in media.movie.consumed -> 12323 sec
+
+#### close(stat, opts = {})
+
+```ruby
+instance.close
+```
+
+> [NullStatsD :-] Close called
+
+## Testing
+
+`rake spec`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Bug reports and pull requests are welcome on GitHub.

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 "null_statsd"
+
+# 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

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/null_statsd/statsd.rb

@@ -0,0 +1,104 @@
+require "json"
+
+module NullStatsd
+  class Statsd
+    attr_accessor :namespace, :host, :port, :logger
+
+    def initialize(host:, port:, logger:)
+      @host = host
+      @port = port
+      @namespace = ""
+      @logger = logger
+      notify "Connecting to fake Statsd, pretending to be on #{host}:#{port}"
+    end
+
+    def increment(stat, opts = {})
+      notify "Incrementing #{stat}#{opts_string(opts)}"
+    end
+
+    def decrement(stat, opts = {})
+      notify "Decrementing #{stat}#{opts_string(opts)}"
+    end
+
+    def count(stat, count, opts = {})
+      notify "Increasing #{stat} by #{count}#{opts_string(opts)}"
+    end
+
+    def gauge(stat, value, opts = {})
+      notify "Setting gauge #{stat} to #{value}#{opts_string(opts)}"
+    end
+
+    def histogram(stat, value, opts = {})
+      notify "Logging histogram #{stat} -> #{value}#{opts_string(opts)}"
+    end
+
+    def timing(stat, ms, _sample_rate = 1, opts = {})
+      notify "Timing #{stat} at #{ms} ms#{opts_string(opts)}"
+    end
+
+    def set(stat, value, opts = {})
+      notify "Setting #{stat} to #{value}#{opts_string(opts)}"
+    end
+
+    def service_check(name, status, opts = {})
+      notify "Service check #{name}: #{status}#{opts_string(opts)}"
+    end
+
+    def event(title, text, opts = {})
+      notify "Event #{title}: #{text}#{opts_string(opts)}"
+    end
+
+    def close
+      notify "Close called"
+    end
+
+    def batch
+      yield self
+    end
+
+    def time(stat, opts = {})
+      time_in_sec, result = benchmark { yield }
+      notify "Recording timing info in #{stat} -> #{time_in_sec} sec#{opts_string(opts)}"
+      result
+    end
+
+    def with_namespace(namespace)
+      new_ns = dup
+      if @namespace == "" || @namespace == nil
+        new_ns.namespace = namespace
+      else
+        new_ns.namespace = "#{@namespace}.#{namespace}"
+      end
+      if block_given?
+        yield new_ns
+      else
+        new_ns
+      end
+    end
+
+    private
+
+    def identifier_string
+      if @namespace && @namespace != ""
+        "[NullStatsD #{@host}:#{@port}-#{@namespace}]"
+      else
+        "[NullStatsD #{@host}:#{@port}]"
+      end
+    end
+
+    def benchmark(&block)
+      start = Time.now
+      result = block.call
+      elapsed_time = Time.now - start
+      return elapsed_time, result
+    end
+
+    def notify(msg)
+      logger.debug "#{identifier_string} #{msg}"
+    end
+
+    def opts_string(opts)
+      opts.empty? ? nil : " with opts #{opts.to_json}"
+    end
+  end
+end

data/lib/null_statsd/version.rb

@@ -0,0 +1,3 @@
+module NullStatsd
+  VERSION = "1.0.0"
+end

data/lib/null_statsd.rb

@@ -0,0 +1,6 @@
+require "null_statsd/version"
+require "null_statsd/statsd"
+
+module NullStatsd
+
+end

data/null_statsd.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "null_statsd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "null_statsd"
+  spec.version       = NullStatsd::VERSION
+  spec.authors       = ["Imad Mouaddine"]
+  spec.email         = ["imouaddine@usertesting.com"]
+  spec.summary       = %q{Implements null pattern for Statsd client}
+  spec.description   = %q{Implements null pattern for Statsd client}
+  spec.homepage      = "https://github.com/usertesting/null_statsd"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|UserTesting.png)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.1"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rspec-cover_it", "~> 0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: null_statsd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Imad Mouaddine
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-cover_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Implements null pattern for Statsd client
+email:
+- imouaddine@usertesting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- UserTesting.png
+- bin/console
+- bin/setup
+- lib/null_statsd.rb
+- lib/null_statsd/statsd.rb
+- lib/null_statsd/version.rb
+- null_statsd.gemspec
+homepage: https://github.com/usertesting/null_statsd
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Implements null pattern for Statsd client
+test_files: []