logstash-output-dogstatsd 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cb8720939c32309a703107f259983b53df4207c
+  data.tar.gz: 754cac540de40f10618bbadbfa4f0494bc014721
+SHA512:
+  metadata.gz: 892f9d95c67a7ecfb8e4ce7529559efa1d622be0f87d3beb3f931a9ec10408c7eedbe419b587b99485027ace7600d371e0dbd43909b3d06a3c55028891551fdc
+  data.tar.gz: d2f85fb11a8d0dc3d0639d72e3a89fe3b89c9b66d533c02f8a3a53949612e3165ebf8f30a03dcefdf130680becb22ec25944ba6811d0d438b9ceca225e58dcfa

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  HardTabs:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop']
+
+  TrailingWhitespace:
+    enabled: true
+
+# Overcommit will use the repo's Gemfile when loading the Bundler context
+gemfile: Gemfile

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.20

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.9.0
+- First version of logstash-output-dogstatsd, forked from v1.1.0 of
+  logstash-output-statsd.

data/CONTRIBUTORS

@@ -0,0 +1,23 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* David Warden (dfwarden)
+* Graham Bleach (bleach)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Kurt Hurtado (kurtado)
+* Michael Leinartas (mleinart)
+* Parker DeBardelaben (parkerd)
+* Pere Urbón (purbon)
+* Pete Fritchman (fetep)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* alistar79
+* piavlo
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/outputs/dogstatsd.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+# This is a hack to load the dogstatsd-ruby gem's statsd.rb file into a
+# namespace so as to not clobber the top-level Statsd provided by the
+# much-more-popular Statsd gem. The problem is that both gems have a file named
+# 'statsd.rb' that you are supposed to load. Why did Datadog not name their file
+# differently? Who knows!
+# (see: https://github.com/DataDog/dogstatsd-ruby/pull/3)
+module Datadog
+  module_eval(File.read(Gem.find_files('**/statsd.rb').grep(/dogstatsd/).first))
+end
+
+# dogstatsd is a fork of the statsd protocol which aggregates statistics, such
+# as counters and timers, and ships them over UDP to the dogstatsd-server
+# running as part of the Datadog Agent. Dogstatsd adds support for metric tags,
+# which are used to slice metrics along various dimensions.
+#
+# You can learn about statsd here:
+#
+# * http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/[Etsy blog post announcing statsd]
+# * https://github.com/etsy/statsd[statsd on github]
+#
+# A simple example usage of this is to count HTTP hits by response code; to learn
+# more about that, check out the ../tutorials/metrics-from-logs[log metrics tutorial]
+#
+# Example:
+# [source,ruby]
+# output {
+#  dogstatsd {
+#   metric_tags => {
+#     "host" => "%{host}"
+#   }
+#   count => {
+#    "http.bytes" => "%{bytes}"
+#   }
+#  }
+# }
+class LogStash::Outputs::Dogstatsd < LogStash::Outputs::Base
+  ## Regex stolen from statsd code
+  RESERVED_CHARACTERS_REGEX = /[\:\|\@]/
+  config_name "dogstatsd"
+
+  # The address of the dogstatsd server.
+  config :host, :validate => :string, :default => "localhost"
+
+  # The port to connect to on your dogstatsd server.
+  config :port, :validate => :number, :default => 8125
+
+  # An increment metric. Metric names as array.
+  config :increment, :validate => :array, :default => []
+
+  # A decrement metric. Metric names as array.
+  config :decrement, :validate => :array, :default => []
+
+  # A histogram metric, which a statsd timing but conceptually maps to any
+  # numeric value, not just durations. `metric_name => value` as hash
+  config :histogram, :validate => :hash, :default => {}
+
+  # A count metric. `metric_name => count` as hash
+  config :count, :validate => :hash, :default => {}
+
+  # A set metric. `metric_name => "string"` to append as hash
+  config :set, :validate => :hash, :default => {}
+
+  # A gauge metric. `metric_name => gauge` as hash.
+  config :gauge, :validate => :hash, :default => {}
+
+  # The sample rate for the metric.
+  config :sample_rate, :validate => :number, :default => 1
+
+  # The tags to apply to each metric.
+  config :metric_tags, :validate => :hash, :default => {}
+
+  public
+  def register
+    @client = Datadog::Statsd.new(@host, @port)
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+    @logger.debug? and @logger.debug("Event: #{event}")
+
+    tags = process_tags(event, @metric_tags)
+    metric_opts = { :sample_rate => @sample_rate, :tags => tags }
+
+    @increment.each do |metric|
+      @client.increment(event.sprintf(metric), metric_opts)
+    end
+
+    @decrement.each do |metric|
+      @client.decrement(event.sprintf(metric), metric_opts)
+    end
+
+    @count.each do |metric, val|
+      @client.count(event.sprintf(metric), event.sprintf(val), metric_opts)
+    end
+
+    @histogram.each do |metric, val|
+      @client.histogram(event.sprintf(metric), event.sprintf(val), metric_opts)
+    end
+
+    @set.each do |metric, val|
+      @client.set(event.sprintf(metric), event.sprintf(val), metric_opts)
+    end
+
+    @gauge.each do |metric, val|
+      @client.gauge(event.sprintf(metric), event.sprintf(val), metric_opts)
+    end
+  end # def receive
+
+  private
+  # Returns an array of tags like ["tag1:value1", "tag2:value2"]
+  def process_tags(event, tags)
+    tags.map { |k, v| event.sprintf(k) + ':' + event.sprintf(v) }
+  end
+end # class LogStash::Outputs::Statsd

data/logstash-output-dogstatsd.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-dogstatsd'
+  s.version         = '1.2.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Send metrics to StatsD"
+  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Tom Dooner"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-input-generator'
+
+  # This version is pinned exactly to ensure that upgrades don't break the
+  # gnarly `module_eval` hack in lib/logstash/outputs/dogstatsd.rb.
+  s.add_runtime_dependency 'dogstatsd-ruby', '= 1.5'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'overcommit'
+end
+

data/spec/outputs/dogstatsd_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'logstash/outputs/dogstatsd'
+require_relative '../spec_helper'
+
+describe LogStash::Outputs::Dogstatsd do
+  let(:output) { described_class.new(config) }
+
+  let(:config) do
+    {
+      'host' => '127.0.0.1',
+      'port' => 8125
+    }.merge(metric_config)
+  end
+  let(:metric_config) { {} }
+
+  describe 'registration and teardown' do
+    it 'registers without errors' do
+      output = LogStash::Plugin.lookup('output', 'dogstatsd').new
+      expect { output.register }.to_not raise_error
+    end
+  end
+
+  describe '#send' do
+    before { output.register }
+    subject { output.receive(LogStash::Event.new(event)) }
+
+    let(:event) { { 'something_count' => 10 } }
+
+    context 'increment metrics' do
+      let(:metric_config) { { 'increment' => [metric_to_track] } }
+      let(:metric_to_track) { 'metric.name.here' }
+
+      context 'with a plain ol metric name' do
+        it 'tracks' do
+          expect_any_instance_of(Datadog::Statsd).to receive(:send_to_socket)
+            .with("#{metric_to_track}:1|c")
+          subject
+        end
+      end
+
+      context 'with tags' do
+        let(:metric_config) { super().merge('metric_tags' => { 'foo' => '%{value}' }) }
+        let(:event) { { 'value' => 'helloworld' } }
+
+        it 'sprintf tags' do
+          expect_any_instance_of(Datadog::Statsd).to receive(:send_to_socket)
+            .with("#{metric_to_track}:1|c|#foo:helloworld")
+          subject
+        end
+      end
+    end
+
+    context 'histogram metrics' do
+      let(:metric_to_track) { 'metric.name.here' }
+      let(:metric_config) { { 'histogram' => { '%{metric_name}' => '%{track_value}' } } }
+      let(:event) { super().merge('metric_name' => metric_to_track, 'track_value' => 123) }
+
+      context 'with tags in the metric name and value' do
+        it 'tracks' do
+          expect_any_instance_of(Datadog::Statsd).to receive(:send_to_socket)
+            .with("#{metric_to_track}:123|h")
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/dogstatsd'
+
+RSpec.configure do |c|
+  c.before do
+    allow_any_instance_of(Datadog::Statsd).to receive(:send_to_socket)
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-dogstatsd
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Tom Dooner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-input-generator
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .overcommit.yml
+- .ruby-version
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- Rakefile
+- lib/logstash/outputs/dogstatsd.rb
+- logstash-output-dogstatsd.gemspec
+- spec/outputs/dogstatsd_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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.4.6
+signing_key:
+specification_version: 4
+summary: Send metrics to StatsD
+test_files:
+- spec/outputs/dogstatsd_spec.rb
+- spec/spec_helper.rb