fluent-plugin-dogstatsd-soluto 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a6dabb02edcae148aa3b5b082258f23e257ecb19c186e6bef72ae8d0c72f741
+  data.tar.gz: '071587cee1ded3bd7b4978052d02aacdcf3692a59044dd4b7efc0194115c157a'
+SHA512:
+  metadata.gz: 5156da0001e52c95a19906ec2ae67043ae96872f45d92b5f585f604da0ef81ae6822a390996e75b28cc4e94f3a84956778693e78c95b89f3a968e33d2b8f7343
+  data.tar.gz: 3b9449c91f445f2068ac6a08d6786f89be3b223d9740ca8f6c62c8c16af2318ffdc290260200f195010d07fda73a2a59c69f5254d03377897f63d4426a5e794f

data/.github/workflows/gempush.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/run_tests.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler -v 2.0.2
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Portions Copyright (c) 2020 Soluto
+Portions Copyright (c) 2014 Ryota Arai
+
+MIT License
+
+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,108 @@
+# fluent-plugin-dogstatsd
+
+Fluend plugin for Dogstatsd, that is statsd server for Datadog.
+This plugin was forked to use dogstatsd-ruby package version 4, which provide better performance (DNS Caching included).
+
+## Installation
+
+    $ gem install fluent-plugin-dogstatsd
+
+## Usage
+
+```
+$ echo '{"type": "increment", "key": "apache.requests", "tags": {"url": "/"}}' | fluent-cat dogstatsd.hello
+$ echo '{"type": "histogram", "key": "apache.response_time", "value": 10.5, "tags": {"url": "/hello"}}' | fluent-cat dogstatsd.hello
+$ echo '{"type": "event", "title": "Deploy", "text": "New revision"}' | fluent-cat dogstatsd.hello
+```
+
+Supported types are `increment`, `decrement`, `count`, `gauge`, `histogram`, `timing`, `set` and `event`.
+
+## Configuration
+
+```
+<match dogstatsd.*>
+  type dogstatsd
+
+  # Dogstatsd host
+  host localhost
+
+  # Dogstatsd port
+  port 8125
+
+  # Use tag of fluentd record as key sent to Dogstatsd
+  use_tag_as_key false
+
+  # (Treat fields in a record as tags)
+  # flat_tags true
+
+  # (Metric type in Datadog.)
+  # metric_type increment
+
+  # Default: "value"
+  # value_key Value
+</match>
+```
+
+## Example
+
+### Count log lines
+
+```apache
+<source>
+  type tail
+  path /tmp/sample.log
+  tag datadog.increment.sample
+  format ...
+</source>
+
+<match datadog.increment.*>
+  type dogstatsd
+  metric_type increment
+  flat_tags true
+  use_tag_as_key true
+</match>
+```
+
+### Histogram
+
+```apache
+<source>
+  type tail
+  path /tmp/sample.log
+  tag datadog.histogram.sample
+  format /^(?<value>[^ ]*) (?<host>[^ ]*)$/
+</source>
+
+<match datadog.histogram.*>
+  type dogstatsd
+  metric_type histogram
+  flat_tags true
+  use_tag_as_key true
+</match>
+```
+
+### MySQL threads
+
+```apache
+<source>
+  type mysql_query
+  tag datadog.histogram.mysql_threads
+  query SHOW VARIABLES LIKE 'Thread_%'
+</source>
+
+<match datadog.histogram.mysql_threads>
+  type dogstatsd
+  metric_type histogram
+  value_key Value
+  flat_tags true
+  use_tag_as_key true
+</match>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/soluto/fluent-plugin-dogstatsd/fork )
+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

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/plugin/*.rb']
+end
+

data/fluent-plugin-dogstatsd.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluent/plugin/dogstatsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-dogstatsd-soluto"
+  spec.version       = Fluent::Plugin::Dogstatsd::VERSION
+  spec.authors       = ["Shai Katz"]
+  spec.email         = ["shai@soluto.com"]
+  spec.summary       = %q{Fluent plugin for Dogstatsd, that is statsd server for Datadog.}
+  spec.homepage      = "https://github.com/soluto/fluent-plugin-dogstatsd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluentd", [">= 0.14.10", "< 2"]
+  spec.add_dependency "dogstatsd-ruby", "~> 4.7.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/dogstatsd.rb

@@ -0,0 +1,9 @@
+require "fluent/plugin/dogstatsd/version"
+
+module Fluent
+  module Plugin
+    module Dogstatsd
+      # Your code goes here...
+    end
+  end
+end

data/lib/fluent/plugin/dogstatsd/version.rb

@@ -0,0 +1,7 @@
+module Fluent
+  module Plugin
+    module Dogstatsd
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/fluent/plugin/out_dogstatsd.rb

@@ -0,0 +1,108 @@
+module Fluent
+  class DogstatsdOutput < BufferedOutput
+    Plugin.register_output('dogstatsd', self)
+
+    config_param :host, :string, :default => nil
+    config_param :port, :integer, :default => nil
+    config_param :use_tag_as_key, :bool, :default => false
+    config_param :use_tag_as_key_if_missing, :bool, :default => false
+    config_param :flat_tags, :bool, :default => false
+    config_param :flat_tag, :bool, :default => false # obsolete
+    config_param :metric_type, :string, :default => nil
+    config_param :value_key, :string, :default => nil
+    config_param :sample_rate, :float, :default => nil
+
+    unless method_defined?(:log)
+      define_method(:log) { $log }
+    end
+
+    attr_accessor :statsd
+
+    def initialize
+      super
+
+      require 'datadog/statsd' # dogstatsd-ruby
+    end
+
+    def start
+      super
+
+      host = @host || '127.0.0.1'
+      port = @port || 8125
+
+      @statsd ||= Datadog::Statsd.new(host, port)
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      @statsd.batch do |s|
+        chunk.msgpack_each do |tag, time, record|
+          key = if @use_tag_as_key
+                  tag
+                else
+                  record.delete('key')
+                end
+
+          if !key && @use_tag_as_key_if_missing
+            key = tag
+          end
+
+          unless key
+            log.warn "'key' is not specified. skip this record:", tag: tag
+            next
+          end
+
+          value = record.delete(@value_key || 'value')
+
+          options = {}
+          title = record.delete('title')
+          text  = record.delete('text')
+          type  = @metric_type || record.delete('type')
+          sample_rate = @sample_rate || record.delete('sample_rate')
+
+          if sample_rate
+            options[:sample_rate] = sample_rate
+          end
+
+          tags = if @flat_tags || @flat_tag
+                   record
+                 else
+                   record['tags']
+                 end
+          if tags
+            options[:tags] = tags.map do |k, v|
+              "#{k}:#{v}"
+            end
+          end
+
+          case type
+          when 'increment'
+            s.increment(key, options)
+          when 'decrement'
+            s.decrement(key, options)
+          when 'count'
+            s.count(key, value, options)
+          when 'gauge'
+            s.gauge(key, value, options)
+          when 'histogram'
+            s.histogram(key, value, options)
+          when 'timing'
+            s.timing(key, value, options)
+          when 'set'
+            s.set(key, value, options)
+          when 'event'
+            options[:alert_type] = record['alert_type']
+            s.event(title, text, options)
+          when nil
+            log.warn "type is not provided (You can provide type via `metric_type` in config or `type` field in a record."
+          else
+            log.warn "Type '#{type}' is unknown."
+          end
+        end
+      end
+    end
+  end
+end

data/test/plugin/test_out_dogstatsd.rb

@@ -0,0 +1,171 @@
+require 'test_helper'
+
+class DummyStatsd
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def batch
+    yield(self)
+  end
+
+  %i!increment decrement count gauge histogram timing set event!.each do |name|
+    define_method(name) do |*args|
+      @messages << [name, args].flatten
+    end
+  end
+end
+
+class DogstatsdOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    require 'fluent/plugin/out_dogstatsd'
+  end
+
+  def teardown
+  end
+
+  def test_configure
+    d = create_driver(<<-EOC)
+      type dogstatsd
+      host HOST
+      port 12345
+    EOC
+
+    assert_equal('HOST', d.instance.host)
+    assert_equal(12345, d.instance.port)
+  end
+
+  def test_write
+    d = create_driver
+
+    d.emit({'type' => 'increment', 'key' => 'hello.world1'}, Time.now.to_i)
+    d.emit({'type' => 'increment', 'key' => 'hello.world2'}, Time.now.to_i)
+    d.emit({'type' => 'decrement', 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'count', 'value' => 10, 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'gauge', 'value' => 10, 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'histogram', 'value' => 10, 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'timing', 'value' => 10, 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'set', 'value' => 10, 'key' => 'hello.world'}, Time.now.to_i)
+    d.emit({'type' => 'event', 'title' => 'Deploy', 'text' => 'Revision', 'alert_type' => 'test', 'key' => 'hello.world'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'hello.world1', {}],
+      [:increment, 'hello.world2', {}],
+      [:decrement, 'hello.world', {}],
+      [:count, 'hello.world', 10, {}],
+      [:gauge, 'hello.world', 10, {}],
+      [:histogram, 'hello.world', 10, {}],
+      [:timing, 'hello.world', 10, {}],
+      [:set, 'hello.world', 10, {}],
+      [:event, 'Deploy', 'Revision', {:'alert_type' => 'test'}],
+    ], d.instance.statsd.messages)
+  end
+
+  def test_flat_tag
+    d = create_driver(<<-EOC)
+#{default_config}
+flat_tag true
+    EOC
+
+    d.emit({'type' => 'increment', 'key' => 'hello.world', 'tagKey' => 'tagValue'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'hello.world', {tags: ["tagKey:tagValue"]}],
+    ], d.instance.statsd.messages,)
+  end
+
+  def test_metric_type
+    d = create_driver(<<-EOC)
+#{default_config}
+metric_type decrement
+    EOC
+
+    d.emit({'key' => 'hello.world', 'tags' => {'tagKey' => 'tagValue'}}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:decrement, 'hello.world', {tags: ["tagKey:tagValue"]}],
+    ], d.instance.statsd.messages)
+  end
+
+  def test_use_tag_as_key
+    d = create_driver(<<-EOC)
+#{default_config}
+use_tag_as_key true
+    EOC
+
+    d.emit({'type' => 'increment'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'dogstatsd.tag', {}], 
+    ], d.instance.statsd.messages, )
+  end
+
+  def test_use_tag_as_key_fallback
+    d = create_driver(<<-EOC)
+#{default_config}
+use_tag_as_key_if_missing true
+    EOC
+
+    d.emit({'type' => 'increment'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'dogstatsd.tag', {}],
+    ], d.instance.statsd.messages, )
+  end
+
+  def test_tags
+    d = create_driver
+    d.emit({'type' => 'increment', 'key' => 'hello.world', 'tags' => {'key' => 'value'}}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'hello.world', {tags: ["key:value"]}],
+    ], d.instance.statsd.messages)
+  end
+
+  def test_sample_rate_config
+    d = create_driver(<<-EOC)
+#{default_config}
+sample_rate .5
+    EOC
+
+    d.emit({'type' => 'increment', 'key' => 'tag'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'tag', {sample_rate: 0.5}],
+    ], d.instance.statsd.messages)
+  end
+
+  def test_sample_rate
+    d = create_driver
+    d.emit({'type' => 'increment', 'sample_rate' => 0.5, 'key' => 'tag'}, Time.now.to_i)
+    d.run
+
+    assert_equal([
+      [:increment, 'tag', {sample_rate: 0.5}],
+    ], d.instance.statsd.messages)
+  end
+
+  private
+  def default_config
+    <<-EOC
+    type dogstatsd
+    EOC
+  end
+
+  def create_driver(conf = default_config)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::DogstatsdOutput, 'dogstatsd.tag').configure(conf).tap do |d|
+      d.instance.statsd = DummyStatsd.new
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'fluent/test'
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-dogstatsd-soluto
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shai Katz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: 
+email:
+- shai@soluto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".github/workflows/run_tests.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-dogstatsd.gemspec
+- lib/fluent/plugin/dogstatsd.rb
+- lib/fluent/plugin/dogstatsd/version.rb
+- lib/fluent/plugin/out_dogstatsd.rb
+- test/plugin/test_out_dogstatsd.rb
+- test/test_helper.rb
+homepage: https://github.com/soluto/fluent-plugin-dogstatsd
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Fluent plugin for Dogstatsd, that is statsd server for Datadog.
+test_files:
+- test/plugin/test_out_dogstatsd.rb
+- test/test_helper.rb