fluent-plugin-datadog-statsd 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0254e7fcf0db14365edc9da7b649980870d2476
+  data.tar.gz: 314c972da0424382b58d2d29d297417e4fbe7fc1
+SHA512:
+  metadata.gz: 47f5876be1f19b7c8e87a3ad2f96b3dd9189d524039b6c66ace55ef05aa3e6b829a7c2e65ac0ae6775253bf8f62545e50f36609ceae6f43ea8ed7a18414b5f5f
+  data.tar.gz: 228384d08b2fde79da98ed471bd2cc54803204c8c96277eea61a81b809c307f98e3703361d03fe19b5bec05fb40fe2d2d731b1d5fa51cc7b4e1106f3201ceac7

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://www.rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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,89 @@
+# fluentd-plugin-datadog-statsd
+
+Fluend output plugin for Dogstatsd. 
+
+[![Build Status](https://travis-ci.org/kikusu/fluentd-plugin-datadog-statsd.svg?branch=master)](https://travis-ci.org/kikusu/fluentd-plugin-datadog-statsd)
+
+## Requirements
+- fluentd >= 0.14
+
+## Configuration
+```
+<match datadog.*>
+ @type datadog_statsd
+
+ # option: datadog statsd host, port
+ host 127.0.0.1   (default: see dogstatsd-ruby)
+ port 8125        (default: see dogstatsd-ruby)
+
+ # required: metric type of datadog.
+ # e.g. increment, decrement, count, gauge, histgram, timing, event
+ metric_type increment
+
+ # option: tag of datadog.
+ tags [ "tag1:tag", "tag2:tag" ]
+
+ # required when metric_type is not event
+ <metric>
+    # required: metric name of datadog
+    name test.datadog
+
+    # required when metric_type in (count, gauge, histgram, timing)
+    value 1
+ </metric>
+
+ # required when metric_type is event
+ # see: http://docs.datadoghq.com/guides/dogstatsd/#events
+ <evnet>
+    # required
+    title
+    text
+
+    # option
+    aggregation_key
+    alert_type
+    date_happened
+    priority
+    source_type_name
+ </event>
+
+</match>
+```
+
+### using template
+
+In this plugin you can use templates.
+Implemented by `Fluent::Plugin::Output#extract_placeholders`.
+
+#### Available Tags
+- `${tag}`, `${tag[0]}`, `${tag[1]}`, ...
+- `${record_key}`
+
+```
+<match datadog.*>
+ @type datadog_statsd
+
+ metric_type increment
+ tags [ "tag:${tag}"]
+ <metric>
+    name ${metric_name}
+ </metric>
+
+ # add placeholder key
+ <buffer ["tag", "metric_name"]>
+ </buffer>
+</match>
+```
+
+```
+# src
+fluentd_tag datadog.test
+fluentd_record {"metric_name": "count.error_log"}
+=>
+# dest
+metric_type increment
+tags ["tag:datadog.test"}
+<metric>
+  name count.error_log
+</metric>
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+  task.rspec_opts = '-c -fd --require spec_helper'
+end
+
+task :default => :spec
+
+RuboCop::RakeTask.new do |task|
+  task.options = ["--color"]
+end

data/fluent-plugin-datadog-statsd.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-datadog-statsd'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Kosuke Miyawaki']
+  spec.email         = ['kikusumk3@gmail.com']
+  spec.summary       = 'Fluentd output plugin for Dogstatsd.'
+  spec.description   = 'Fluentd output plugin for Dogstatsd.'
+  spec.homepage      = 'https://github.com/kikusu/fluent-plugin-datadog-statsd'
+  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'
+  spec.add_dependency 'dogstatsd-ruby', '~> 3.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'test-unit-rr'
+end

data/lib/fluent/plugin/out_datadog_statsd.rb

@@ -0,0 +1,151 @@
+require 'fluent/plugin/output'
+
+module Fluent
+  module Plugin
+    class DatadogStatsdOutput < Output
+      Fluent::Plugin.register_output('datadog_statsd', self)
+
+      config_param :host, :string, default: nil
+      config_param :port, :integer, default: nil
+
+      config_param :metric_type, :string
+      config_param :tags, :array, default: []
+
+      config_section :metric, param_name: :metric_config, required: false,
+                              multi: false, final: true do
+        config_param :name, :string
+        config_param :value, default: nil
+      end
+
+      config_section :event, param_name: :event_config, required: false,
+                             multi: false, final: true do
+        config_param :title, :string
+        config_param :text, :string
+        config_param :aggregation_key, :string, default: nil
+        config_param :alert_type, :string, default: nil
+        config_param :date_happened, default: nil
+        config_param :priority, :string, default: nil
+        config_param :source_type_name, :string, default: nil
+      end
+
+      config_section :buffer do
+        config_set_default :flush_mode, :immediate
+      end
+
+      attr_reader :statsd
+
+      def configure(conf)
+        super
+
+        placeholder_params = [
+          @metric_type,
+          @tags
+        ]
+
+        if @metric_config
+          placeholder_params += [
+            @metric_config.name,
+            @metric_config.value
+          ]
+        end
+        if @event_config
+          placeholder_params += [
+            @event_config.title,
+            @event_config.text,
+            @event_config.aggregation_key,
+            @event_config.alert_type,
+            @event_config.priority,
+            @event_config.source_type_name,
+            @event_config.date_happened
+          ]
+        end
+
+        placeholder_validate!(:placeholder_params, placeholder_params.join('/'))
+
+        require 'datadog/statsd'
+        @host ||= Datadog::Statsd::DEFAULT_HOST
+        @port ||= Datadog::Statsd::DEFAULT_PORT
+
+        @statsd = Datadog::Statsd.new(@host, @port)
+      end
+
+      def start
+        super
+      end
+
+      def shutdown
+        super
+        @statsd.close
+      end
+
+      def write(chunk)
+        metadata = chunk.metadata
+        metric_type = extract_placeholders(@metric_type, metadata).to_sym
+
+        @statsd.batch do |statsd|
+          statsd_param = case metric_type
+                         when :increment, :decrement
+                           if @metric_config.nil?
+                             log.error("metric section is required when metric_type=#{metric_type}")
+                             return nil
+                           end
+                           extract_placeholders_name_opt(metadata)
+
+                         when :count, :gauge, :histgram, :timing, :set
+                           if @metric_config.nil?
+                             log.error("metric section is required when metric_type=#{metric_type}")
+                             return nil
+                           end
+                           extract_placeholders_name_value_opt(metadata)
+                         when :event
+                           if @event_config.nil?
+                             log.error('event section is required when metric_type=event')
+                             return nil
+                           end
+                           extract_placeholders_event(metadata)
+                         else
+                           log.error("param 'metric_type=#{metric_type}' is illegal.")
+                           return nil
+                         end
+          statsd_func = statsd.method(metric_type)
+          chunk.each do |_time, _record|
+            statsd_func.call(*statsd_param)
+          end
+        end
+      end
+
+      private
+
+      def extract_placeholders_name_opt(metadata)
+        metric_name = extract_placeholders(@metric_config.name, metadata)
+        options = {}
+        options[:tag] = @tags.map { |tag| extract_placeholders(tag, metadata) } if @tags
+
+        [metric_name, options]
+      end
+
+      def extract_placeholders_name_value_opt(metadata)
+        metric_name, options = extract_placeholders_name_opt(metadata)
+        value = extract_placeholders(@metric_config.value, metadata)
+
+        [metric_name, value, options]
+      end
+
+      def extract_placeholders_event(metadata)
+        event_title = extract_placeholders(@event_config.title, metadata)
+        event_text = extract_placeholders(@event_config.text, metadata)
+
+        options = {}
+        options[:tag] = @tags.map { |tag| extract_placeholders(tag, metadata) } if @tags
+
+        %i[aggregation_key alert_type date_happened priority source_type_name].each do |key|
+          options[key] = extract_placeholders(@event_config[key], metadata) if @event_config[key]
+        end
+
+        options[:date_happened] = options[:date_happened].to_i if options[:date_happened]
+
+        [event_title, event_text, options]
+      end
+    end
+  end
+end

data/spec/fluent/pugin/out_datadog_statsd_spec.rb

@@ -0,0 +1,204 @@
+require 'datadog/statsd'
+require 'fluent/test'
+require 'fluent/test/driver/output'
+require 'rspec'
+
+require 'fluent/plugin/out_datadog_statsd'
+
+describe Fluent::Plugin::DatadogStatsdOutput do
+  let(:time) do
+    Time.parse('2017-06-01 00:11:22 UTC').to_i
+  end
+
+  CONFIG = %(
+  ).freeze
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::DatadogStatsdOutput).configure(conf)
+  end
+
+  before do
+    Fluent::Test.setup
+  end
+
+  %i[increment decrement].each do |metric_type|
+    describe "metric_type=#{metric_type}" do
+      it 'ok' do
+        conf = %(
+@type datadog_statsd
+metric_type #{metric_type}
+tags ["test_tag:test"]
+<metric>
+  name test.test
+</metric>
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to receive(metric_type).with('test.test', tag: ['test_tag:test'])
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, {})
+        end
+      end
+
+      it 'ok with placeholders' do
+        conf = %(
+@type datadog_statsd
+metric_type ${metric_type}
+tags ["test_tag:${tag}"]
+<metric>
+  name ${metric_name}
+</metric>
+<buffer ["tag", "metric_type", "metric_name"]>
+</buffer>
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to receive(metric_type).with('test.test', tag: ['test_tag:test'])
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, 'metric_name' => 'test.test', 'metric_type' => metric_type.to_s)
+        end
+      end
+
+      it 'not exist metric section' do
+        conf = %(
+@type datadog_statsd
+metric_type #{metric_type}
+tags ["test_tag:test"]
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to_not receive(metric_type)
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, {})
+        end
+      end
+    end
+  end
+
+  %i[count gauge histgram timing set].each do |metric_type|
+    describe "metric_type=#{metric_type}" do
+      it 'ok' do
+        conf = %(
+@type datadog_statsd
+metric_type #{metric_type}
+tags ["test_tag:test"]
+<metric>
+  name test.test
+  value 1
+</metric>
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to receive(metric_type).with('test.test', '1', tag: ['test_tag:test'])
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, {})
+        end
+      end
+
+      it 'ok with placeholders' do
+        conf = %(
+@type datadog_statsd
+metric_type ${metric_type}
+tags ["test_tag:${tag}"]
+<metric>
+  name ${metric_name}
+  value ${value}
+</metric>
+<buffer ["tag", "metric_type", "metric_name", "value"]>
+</buffer>
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to receive(metric_type).with('test.test', '1', tag: ['test_tag:test'])
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, 'metric_name' => 'test.test', 'metric_type' => metric_type.to_s, 'value' => 1)
+        end
+      end
+
+      it 'not exist metric section' do
+        conf = %(
+@type datadog_statsd
+metric_type #{metric_type}
+tags ["test_tag:test"]
+      )
+        driver = create_driver(conf)
+
+        expect(driver.instance.statsd).to_not receive(metric_type)
+
+        driver.run(default_tag: 'test') do
+          driver.feed(time, {})
+        end
+      end
+    end
+  end
+
+  describe 'metric_type=event' do
+    it 'ok' do
+      conf = %(
+@type datadog_statsd
+metric_type event
+tags ["test_tag:test"]
+<event>
+  title test_title
+  text test_text
+</event>
+      )
+      driver = create_driver(conf)
+
+      expect(driver.instance.statsd).to receive(:event).with('test_title', 'test_text', tag: ['test_tag:test'])
+
+      driver.run(default_tag: 'test') do
+        driver.feed(time, {})
+      end
+    end
+
+    it 'ok with placeholders' do
+      conf = %(
+@type datadog_statsd
+metric_type event
+tags ["test_tag:${tag}"]
+<event>
+  title ${title}
+  text ${text}
+  aggregation_key ${aggregation_key}
+  alert_type ${alert_type}
+  date_happened ${date_happened}
+  priority ${priority}
+  source_type_name ${source_type_name}
+</event>
+<buffer ["title", "text", "tag", "aggregation_key", "alert_type", "date_happened", "priority", "source_type_name"]>
+</buffer>
+      )
+      driver = create_driver(conf)
+
+      expect(driver.instance.statsd).to receive(:event).with(
+        'test_title', 'test_text', tag: ['test_tag:test'], aggregation_key: 'ak', alert_type: 'info', date_happened: time, priority: 'low', source_type_name: 'stn'
+      )
+
+      driver.run(default_tag: 'test') do
+        driver.feed(time, 'title' => 'test_title', 'text' => 'test_text', 'aggregation_key' => 'ak',
+                          'alert_type' => 'info', 'date_happened' => time, 'priority' => 'low', 'source_type_name' => 'stn')
+      end
+    end
+
+    it 'not exist event section' do
+      conf = %(
+@type datadog_statsd
+metric_type event
+tags ["test_tag:test"]
+      )
+      driver = create_driver(conf)
+
+      expect(driver.instance.statsd).to_not receive(:event)
+
+      driver.run(default_tag: 'test') do
+        driver.feed(time, {})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+
+Test::Unit::AutoRunner.need_auto_run = false

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-datadog-statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kosuke Miyawaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-14 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  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: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  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: Fluentd output plugin for Dogstatsd.
+email:
+- kikusumk3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-datadog-statsd.gemspec
+- lib/fluent/plugin/out_datadog_statsd.rb
+- spec/fluent/pugin/out_datadog_statsd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kikusu/fluent-plugin-datadog-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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Fluentd output plugin for Dogstatsd.
+test_files:
+- spec/fluent/pugin/out_datadog_statsd_spec.rb
+- spec/spec_helper.rb