datadog_metrics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c4854b755cf8dfd6d6cb3c0ddc83c368a8733efb6d99ad6dbfddcd83e706677
+  data.tar.gz: 1b0168cb2249f4b2191b0d68b3cd52cd311d860f848e0e03e607094c12cbb9a0
+SHA512:
+  metadata.gz: 4c82ea521485affcfc97f9ba8845716b3260aabf20c861ef356d88f2b0b45fd79b9d5262185b167fd391e1c66ceaef0f4d24369c05037d1027228bc1f282fcae
+  data.tar.gz: a651fb8a9d560c8aea596ae534ed9da1138e7a9280f4668a919f235e43bf512b178193370a21e8c4ff2d4e99b3bb630e94acaecd439f6e4db418b744549f55bb

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+Initial release

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 datadog_metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    datadog_metrics (1.0.0)
+      dogstatsd-ruby (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    dogstatsd-ruby (4.6.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  datadog_metrics!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Will Jessop
+
+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,61 @@
+# DatadogMetrics
+
+DatadogMetrics provides a convenient wrapper around sending metrics to Datadog in your Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datadog_metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install datadog_metrics
+
+## Usage
+
+For Rails, create an initialiser, eg. `config/initializers/datadog_metrics.rb` containing something like:
+
+```ruby
+Rails.configuration.datadog_metrics = if ["development", "test"].include? Rails.env
+  require "datadog_metrics/logger"
+  DatadogMetrics.new(DatadogLogger.new(Datadog::Statsd.new))
+else
+  DatadogMetrics.new
+end
+```
+
+The development/test branch will use the DatadogMetrics built-in logger to log the metrics that would have been sent, rather than logging them to Datadog.
+
+## 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).
+
+## Updating the gem version
+
+To update it, first bump the version appropriately in the `version.rb` file. Afterwards build the gem by running:
+```bash
+  gem build datadog_metrics.gemspec
+```
+
+Then either use the ```rake push``` rake task to push the gem to rubygems.
+
+## Versioning / Changes
+
+DatadogMetrics uses [semantic versioning](https://semver.org/), please respect that when making changes. When you make changes please log these in the CHANGELOG.md file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wjessop/datadog_metrics.
+
+## License
+
+MIT, see LICENSE file.

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 "datadog_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/datadog_metrics.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "datadog_metrics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "datadog_metrics"
+  spec.version       = DatadogMetrics::VERSION
+  spec.authors       = ["Will Jessop"]
+  spec.email         = ["will@willj.net"]
+
+  spec.summary       = %q{Send metrics to Datadog}
+  spec.description   = %q{Send metrics to Datadog with this one simple trick}
+  spec.homepage      = "https://github.com/wjessop/datadog_metrics"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/wjessop/datadog_metrics"
+    spec.metadata["changelog_uri"] = "https://github.com/wjessop/datadog_metrics/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "dogstatsd-ruby", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/datadog_metrics.rb

@@ -0,0 +1,100 @@
+require "datadog_metrics/version"
+
+require 'datadog/statsd'
+
+# The default endpoint is the local dogstatsd agent which we can
+# talk to using the ruby client:
+#
+# https://github.com/DataDog/dogstatsd-ruby
+#
+# In development we will pass an object that just logs what it
+# would have reported to DataDog to the local log file, and in
+# test we pass an object we can test with.
+
+class DatadogMetrics
+  class << self
+    def default_tags=(tags)
+      @default_tags = tags.transform_keys(&:to_s).freeze
+    end
+
+    def default_tags
+      @default_tags ||= {}
+    end
+  end
+
+  attr_reader :endpoint
+
+  def initialize(endpoint = Datadog::Statsd.new(ENV.fetch("STATS_HOST", "localhost"), 8125))
+    @endpoint = endpoint
+  end
+
+  def time(stat, opt={}, &block)
+    opt[:tags] = format_tags(opt[:tags]) if opt.key?(:tags)
+
+    @endpoint.time(stat, opt) do
+      yield
+    end
+  end
+
+  def timing(metric, ms, tags: {})
+    @endpoint.timing(metric, ms, tags: format_tags(tags))
+  end
+
+  def increment(metric, tags: {})
+    @endpoint.increment(metric, tags: format_tags(tags))
+  end
+
+  def decrement(metric, tags: {})
+    @endpoint.decrement(metric, tags: format_tags(tags))
+  end
+
+  def count(metric, count, tags: {})
+    @endpoint.count(metric, count, tags: format_tags(tags))
+  end
+
+  def increment_with_tags(metric, tags)
+    @endpoint.increment(metric, tags: format_tags(tags))
+  end
+
+  def count_with_tags(metric, count, tags: {})
+    @endpoint.count(metric, count, tags: format_tags(tags))
+  end
+
+  def gauge(metric, value, tags=[], sample_rate=1, **opts)
+    tags = opts[:tags] if opts.key?(:tags)
+    @endpoint.gauge(metric, value, tags: format_tags(tags), sample_rate: sample_rate)
+  end
+
+  def histogram(metric, value, tags: {})
+    @endpoint.histogram(metric, value, tags: format_tags(tags))
+  end
+
+  def histogram_with_tags(metric, value, tags)
+    @endpoint.histogram(metric, value, tags: format_tags(tags))
+  end
+
+  def event(metric, value, tags: {})
+    @endpoint.event(metric, value, tags: format_tags(tags))
+  end
+
+  def batch
+    @endpoint.batch(&proc { yield(endpoint)})
+  end
+
+  private
+
+  def format_tags(tags)
+    return [] if tags.nil?
+
+    if tags.is_a?(Array)
+      tags = tags.each_with_object({}) do |tag, hash|
+        key, rest = tag.split(':', 2)
+        hash[key] = rest
+      end
+    end
+
+    self.class.default_tags.
+      merge(tags).
+      map { |key, value| [key, value].compact.join(':') }
+  end
+end

data/lib/datadog_metrics/logger.rb

@@ -0,0 +1,15 @@
+# Datadoglogger is designed to be used in Development mode and will log the
+# metrics that would have been sent to datadog without the need to run dogstatsd
+# locally.
+class DatadogLogger
+  (Datadog::Statsd.instance_methods - Object.instance_methods).each do |method|
+    define_method(method) do |*args, &block|
+      Rails.logger.info "Datadog: '#{method}' called on the Datadog logger with args: #{args.inspect}"
+      block.call if block
+    end
+  end
+
+  def initialize(target)
+    @target = target
+  end
+end

data/lib/datadog_metrics/testing/fake_datadog_metrics.rb

@@ -0,0 +1,30 @@
+# Mock statsd class to record data during the specs.
+class FakeDatadogMetrics
+  attr_accessor :metrics
+
+  delegate :empty?, to: :metrics
+
+  def initialize
+    self.metrics = []
+  end
+
+  def increment(*arguments)
+    metrics << [:increment, *arguments]
+  end
+
+  def increment_with_tags(*arguments)
+    metrics << [:increment, *arguments]
+  end
+
+  def histogram_with_tags(*arguments)
+    metrics << [:histogram, *arguments]
+  end
+
+  def count_with_tags(*arguments)
+    metrics << [:count, *arguments]
+  end
+
+  def gauge(*arguments)
+    metrics << [:guage, *arguments]
+  end
+end

data/lib/datadog_metrics/testing/rspec_matchers.rb

@@ -0,0 +1,67 @@
+RSpec::Matchers.define :have_logged do |expected|
+  # The string to display for the expected value.
+  # NOTE Regexp#inspect is nicer than Regexp#to_s but we don't want to inspect
+  #      the String and show the surrounding quotes.
+	expected_string = expected.is_a?(Regexp) ? expected.inspect : expected.to_s
+
+	# Whether the line matches.
+	matching_line = lambda do |line|
+		case expected
+		when String
+			line.include? expected
+		when Regexp
+			line.match expected
+		else
+			raise 'Must provide a String or Regexp'
+		end
+	end
+
+
+  # # Whether the severity matches.
+  # # NOTE This matches the conventional Logger format, which has the severity tag
+  # #      followed by ' -- :'. (Technically, the logger's progname goes between
+  # #      the '--' and the ':', but it is unset for the Rails logger.) If this
+  # #      format is changed, it may cause false reports and need to be changed
+  # #      here as well.
+  # matching_severity = ->(line, severity) { severity ? line.include?("#{severity} -- :") : true }
+
+  match do |actual|
+    # # NOTE: Only the new StringIO-backed Logger object will respond to logdev.
+    # raise 'Logger has not been faked. Make sure you include the shared context.' \
+    #   unless actual.respond_to? :logdev
+
+    # # The logger has a log device which has a device -- this is our StringIO.
+    # io = actual.logdev.dev
+
+    # # Writing to the StringIO advances its seek cursor so we must rewind.
+    # io.rewind
+
+    # io.each_line.any? do |line|
+    #   matching_line.call(line) && matching_severity.call(line, @severity)
+    # end
+  end
+
+  description { "logs a metric matching #{expected_string}" }
+
+  # # See http://ruby-doc.org/stdlib-2.5.3/libdoc/logger/rdoc/Logger/Severity.html
+  # # NOTE The defined? check is needed because of the way this block is
+  # #      metaprogrammatically evaluated.
+  # SEVERITIES = %i[debug error fatal info unknown warn].freeze unless defined? SEVERITIES
+
+  # chain(:with_severity) do |severity|
+  #   raise "unknown severity #{severity.inspect}, severities are #{SEVERITIES.to_sentence}" \
+  #     unless SEVERITIES.include? severity
+
+  #   # NOTE The use of a matcher instantiates an object so we can use instance
+  #   #      variables to pass information around.
+  #   @severity = severity == :unknown ? 'ANY' : severity.to_s.upcase
+  # end
+
+  failure_message do |actual|
+    message  = 'Expected that DatadogMetrics would have logged a metric'
+    # message += " of severity #{@severity}" if @severity
+    message += " matching:\n  #{expected_string}"
+    message += "\n\nLogged:\n#{actual.logdev.dev.string}"
+    message
+  end
+end

data/lib/datadog_metrics/version.rb

@@ -0,0 +1,3 @@
+class DatadogMetrics
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: datadog_metrics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Jessop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send metrics to Datadog with this one simple trick
+email:
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- datadog_metrics.gemspec
+- lib/datadog_metrics.rb
+- lib/datadog_metrics/logger.rb
+- lib/datadog_metrics/testing/fake_datadog_metrics.rb
+- lib/datadog_metrics/testing/rspec_matchers.rb
+- lib/datadog_metrics/version.rb
+homepage: https://github.com/wjessop/datadog_metrics
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wjessop/datadog_metrics
+  source_code_uri: https://github.com/wjessop/datadog_metrics
+  changelog_uri: https://github.com/wjessop/datadog_metrics/blob/master/CHANGELOG.md
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Send metrics to Datadog
+test_files: []