adp-fluent-plugin-graphite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66ea8fa9a5c94707aeb094d4615bc5868d30b3a84a2a1df2918fe7f38b7d687e
+  data.tar.gz: 7c11a161f98d059a57834ecd300d611b1381417278062b46eb90f39a35a1c246
+SHA512:
+  metadata.gz: 9edc6e64ad578294e63eb4d32a2e2a2ff428346acb9cc8dfb64bf2c365093a50bca13019dc5f01ffa1b1b01f552c61b9d383453d70e9b3300abac7b9ed218e37
+  data.tar.gz: 6614451a63fd144a78c1794a0ca5a2a51ad68b5c206e0f7ac9d492725be89aa5af4405f4009edabfd531b65e1ab53885f2f964cf8eaf19503b57ab012e683090

data/.gitignore

@@ -0,0 +1,32 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/
+.ruby-version
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+
+before_install:
+  - gem update bundler
+
+script:
+  - bundle exec rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 studio3104
+
+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,145 @@
+# fluent-plugin-graphite [![Build Status](https://travis-ci.org/studio3104/fluent-plugin-graphite.png)](https://travis-ci.org/studio3104/fluent-plugin-graphite) [![Code Climate](https://codeclimate.com/github/studio3104/fluent-plugin-graphite.png)](https://codeclimate.com/github/studio3104/fluent-plugin-graphite)
+
+fluentd output plugin to send metrics to graphite
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-graphite'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-graphite
+
+## Configuration
+
+#### Example
+
+message: `metrics { "f1":"100", "f2":"200", "f3":"300" }`
+
+###### Specify name_keys
+
+- configuration
+
+  ```
+  <match metrics>
+    type graphite
+    host localhost
+    port 2003
+    tag_for prefix
+    name_keys f1,f3
+  </match>
+  ```
+
+- output graph_name
+
+  ```
+  metrics.f1
+  metrics.f3
+  ```
+
+###### Specify name_key_pattern
+
+- configuration
+
+  ```
+  <match metrics>
+    type graphite
+    host localhost
+    port 2003
+    tag_for prefix
+    name_key_pattern f\d
+  </match>
+  ```
+
+- output graph_name
+
+  ```
+  metrics.f1
+  metrics.f2
+  metrics.f3
+  ```
+
+###### tag_for suffix
+
+- configuration
+
+  ```
+  <match metrics>
+    type graphite
+    host localhost
+    port 2003
+    tag_for suffix
+    name_keys f1,f2
+  </match>
+  ```
+
+- output graph_name
+
+  ```
+  f1.metrics
+  f2.metrics
+  ```
+
+###### tag_for ignore
+
+- configuration
+
+  ```
+  <match metrics>
+    type graphite
+    host localhost
+    port 2003
+    tag_for ignore
+    name_keys f1,f2
+  </match>
+  ```
+
+- output graph_name
+
+  ```
+  f1
+  f2
+  ```
+
+#### Parameter
+
+###### host
+- required.
+- ip address or hostname of graphite server.
+
+###### port
+- Default is `2003`.
+- listening port of carbon-cache.
+
+###### tag_for
+- Default is `prefix`.
+- Either of `prefix`, `suffix` or `ignore`.
+  - `prefix` uses the tag name as graph_name prefix.
+  - `suffix` uses the tag name as graph_name suffix.
+  - `ignore` uses the tag name for nothing.
+
+###### name_keys
+- Either of `name_keys` or `name_key_pattern` is required.
+- Specify field names of the input record. Separate by , (comma). The values of these fields are posted as numbers, and names of thease fields are used as parts of grame_names.
+
+###### name_key_pattern
+- Either of `name_keys` or `name_key_pattern` is required.
+- Specify the field names of the input record by a regular expression. The values of these fields are posted as numbers, and names of thease fields are used as parts of grame_names.
+
+###### remove_tag_prefix, remove_tag_suffix, add_tag_prefix, add_tag_suffix
+- Setting for rewriting the tag.
+- For more information: https://github.com/y-ken/fluent-mixin-rewrite-tag-name
+
+## Contributing
+
+1. Fork it ( http://github.com/studio3104/fluent-plugin-graphite/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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/adp-fluent-plugin-graphite.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'adp-fluent-plugin-graphite'
+  gem.version     = '0.0.1'
+  gem.authors     = ['Satoshi SUZUKI']
+  gem.email       = 'studio3104.com@gmail.com'
+  gem.homepage    = 'https://github.com/studio3104/fluent-plugin-graphite'
+  gem.description = 'fluentd output plugin to send metrics to graphite'
+  gem.summary     = gem.description
+  gem.licenses    = ['MIT']
+  gem.has_rdoc    = false
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'fluentd', '>= 0.10.17'
+  gem.add_runtime_dependency 'fluent-mixin-rewrite-tag-name'
+  gem.add_runtime_dependency 'graphite-api'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'test-unit', '~> 3.2.0'
+end

data/lib/fluent/plugin/out_graphite.rb

@@ -0,0 +1,116 @@
+require 'fluent/mixin/rewrite_tag_name'
+
+class Fluent::GraphiteOutput < Fluent::Output
+  Fluent::Plugin.register_output('graphite', self)
+
+  include Fluent::HandleTagNameMixin
+  include Fluent::Mixin::RewriteTagName
+
+  config_param :host, :string
+  config_param :port, :integer, default: 2003
+  config_param :tag_for, :string, default: 'prefix'
+  config_param :name_keys, :string, default: nil
+  config_param :name_key_pattern, :string, default: nil
+
+  # Define `log` method for v0.10.42 or earlier
+  unless method_defined?(:log)
+    define_method(:log) { $log }
+  end
+
+  def initialize
+    super
+    require 'graphite-api'
+  end
+
+  def start
+    super
+    connect_client!
+  end
+
+  def configure(conf)
+    super
+
+    if !['prefix', 'suffix', 'ignore'].include?(@tag_for)
+      raise Fluent::ConfigError, 'out_graphite: can specify to tag_for only prefix, suffix or ignore'
+    end
+
+    if !@name_keys && !@name_key_pattern
+      raise Fluent::ConfigError, 'out_graphite: missing both of name_keys and name_key_pattern'
+    end
+    if @name_keys && @name_key_pattern
+      raise Fluent::ConfigError, 'out_graphite: cannot specify both of name_keys and name_key_pattern'
+    end
+
+    if @name_keys
+      @name_keys = @name_keys.split(',')
+    end
+    if @name_key_pattern
+      @name_key_pattern = Regexp.new(@name_key_pattern)
+    end
+    # How many times to retry the call if timeout raised
+    @max_retries ||= 3
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time, record|
+      emit_tag = tag.dup
+      filter_record(emit_tag, time, record)
+      next unless metrics = format_metrics(emit_tag, record)
+
+      # implemented to immediate call post method in this loop, because graphite-api.gem has the buffers.
+      post(metrics, time)
+    end
+
+    chain.next
+  end
+
+  def format_metrics(tag, record)
+    filtered_record = if @name_keys
+                        record.select { |k,v| @name_keys.include?(k.to_s) }
+                      else # defined @name_key_pattern
+                        record.select { |k,v| @name_key_pattern.match(k.to_s) }
+                      end
+
+    return nil if filtered_record.empty?
+
+    metrics = {}
+    tag = tag.sub(/\.$/, '') # may include a dot at the end of the emit_tag fluent-mixin-rewrite-tag-name returns. remove it.
+    filtered_record.each do |k, v|
+      key = case @tag_for
+            when 'ignore' then k.to_s
+            when 'prefix' then "#{tag}.#{k}"
+            when 'suffix' then "#{k}.#{tag}"
+            end
+
+      key = key.gsub(/(\s|\/)+/, '_') # cope with in the case of containing symbols or spaces in the key of the record like in_dstat.
+      metrics[key] = v.to_f
+    end
+    metrics
+  end
+
+  def post(metrics, time)
+    trial ||= 1
+    @client.metrics(metrics, time)
+    log.debug "Sending metrics: #{metrics}"
+  rescue Errno::ETIMEDOUT
+    # after long periods with nothing emitted, the connection will be closed and result in timeout
+    if trial <= @max_retries
+      log.warn "out_graphite: connection timeout to #{@host}:#{@port}. Reconnecting... "
+      trial += 1
+      connect_client!
+      retry
+    else
+      log.error "out_graphite: ERROR: connection timeout to #{@host}:#{@port}. Exceeded max_retries #{@max_retries}"
+    end
+  rescue Errno::ECONNREFUSED
+    log.warn "out_graphite: connection refused by #{@host}:#{@port}"
+  rescue SocketError => se
+    log.warn "out_graphite: socket error by #{@host}:#{@port} :#{se}"
+  rescue StandardError => e
+    log.error "out_graphite: ERROR: #{e}"
+  end
+
+  def connect_client!
+    @client = GraphiteAPI.new(graphite: "#{@host}:#{@port}")
+  end
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_graphite'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_graphite.rb

@@ -0,0 +1,131 @@
+require 'helper'
+
+class GraphiteOutputTest < Test::Unit::TestCase
+  TCP_PORT = 42003
+  CONFIG_NAME_KEY_PATTERN = %[
+    host localhost
+    port #{TCP_PORT}
+    name_key_pattern ^((?!hostname).)*$
+  ]
+  CONFIG_NAME_KEYS = %[
+    host localhost
+    port #{TCP_PORT}
+    name_keys dstat.total cpu usage.usr,dstat.total cpu usage.sys,dstat.total cpu usage.idl
+  ]
+  CONFIG_TAG_FOR_IGNORE = %[
+    host localhost
+    port #{TCP_PORT}
+    name_keys dstat.total cpu usage.usr,dstat.total cpu usage.sys,dstat.total cpu usage.idl
+    tag_for ignore
+  ]
+  CONFIG_TAG_FOR_SUFFIX = %[
+    host localhost
+    port #{TCP_PORT}
+    name_keys dstat.total cpu usage.usr,dstat.total cpu usage.sys,dstat.total cpu usage.idl
+    tag_for suffix
+  ]
+  CONFIG_INVALID_TAG_FOR = %[
+    host localhost
+    port #{TCP_PORT}
+    name_key_pattern ^((?!hostname).)*$
+    tag_for invalid
+  ]
+  CONFIG_SPECIFY_BOTH_NAME_KEYS_AND_NAME_KEY_PATTERN = %[
+    host localhost
+    port #{TCP_PORT}
+    name_keys dstat.total cpu usage.usr,dstat.total cpu usage.sys,dstat.total cpu usage.idl
+    name_key_pattern ^((?!hostname).)*$
+  ]
+
+  def setup
+    Fluent::Test.setup
+    @server = TCPServer.new(TCP_PORT)
+  end
+
+  def teardown
+    @server.close
+  end
+
+  def create_driver(conf = CONFIG_NAME_KEY_PATTERN, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::GraphiteOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal d.instance.host, 'localhost'
+    assert_equal d.instance.port, TCP_PORT
+    assert_equal d.instance.tag_for, 'prefix'
+    assert_equal d.instance.name_keys, nil
+    assert_equal d.instance.name_key_pattern, /^((?!hostname).)*$/
+
+    d = create_driver(CONFIG_NAME_KEYS)
+    assert_equal d.instance.host, 'localhost'
+    assert_equal d.instance.port, TCP_PORT
+    assert_equal d.instance.tag_for, 'prefix'
+    assert_equal d.instance.name_keys, ['dstat.total cpu usage.usr', 'dstat.total cpu usage.sys', 'dstat.total cpu usage.idl']
+    assert_equal d.instance.name_key_pattern, nil
+
+    d = create_driver(CONFIG_TAG_FOR_IGNORE)
+    assert_equal d.instance.host, 'localhost'
+    assert_equal d.instance.port, TCP_PORT
+    assert_equal d.instance.tag_for, 'ignore'
+    assert_equal d.instance.name_keys, ['dstat.total cpu usage.usr', 'dstat.total cpu usage.sys', 'dstat.total cpu usage.idl']
+    assert_equal d.instance.name_key_pattern, nil
+
+    d = create_driver(CONFIG_TAG_FOR_SUFFIX)
+    assert_equal d.instance.host, 'localhost'
+    assert_equal d.instance.port, TCP_PORT
+    assert_equal d.instance.tag_for, 'suffix'
+    assert_equal d.instance.name_keys, ['dstat.total cpu usage.usr', 'dstat.total cpu usage.sys', 'dstat.total cpu usage.idl']
+    assert_equal d.instance.name_key_pattern, nil
+
+    assert_raise(Fluent::ConfigError) { d = create_driver(CONFIG_INVALID_TAG_FOR) }
+    assert_raise(Fluent::ConfigError) { d = create_driver(CONFIG_SPECIFY_BOTH_NAME_KEYS_AND_NAME_KEY_PATTERN) }
+  end
+
+  def test_format_metrics_strings
+    record = {
+      'hostname' => 'localhost.localdomain',
+      'dstat.total cpu usage.usr' => '0.0',
+      'dstat.total cpu usage.sys' => '0.0',
+      'dstat.total cpu usage.idl' => '100.0',
+      'dstat.total cpu usage.wai' => '0.0',
+      'dstat.total cpu usage.hiq' => '0.0',
+      'dstat.total cpu usage.siq' => '0.0'
+    }
+
+    run_format_metrics_assertions(record)
+  end
+  
+  def test_format_metrics_symbols
+    record = {
+      :'hostname'                  => 'localhost.localdomain',
+      :'dstat.total cpu usage.usr' => '0.0',
+      :'dstat.total cpu usage.sys' => '0.0',
+      :'dstat.total cpu usage.idl' => '100.0',
+      :'dstat.total cpu usage.wai' => '0.0',
+      :'dstat.total cpu usage.hiq' => '0.0',
+      :'dstat.total cpu usage.siq' => '0.0'
+    }
+
+    run_format_metrics_assertions(record)
+  end
+  
+  def run_format_metrics_assertions(record)
+    d = create_driver
+    m1 = d.instance.format_metrics('test.', record)
+    assert_equal m1, { 'test.dstat.total_cpu_usage.usr' => 0.0, 'test.dstat.total_cpu_usage.sys' => 0.0, 'test.dstat.total_cpu_usage.idl' => 100.0, 'test.dstat.total_cpu_usage.wai' => 0.0, 'test.dstat.total_cpu_usage.hiq' => 0.0, 'test.dstat.total_cpu_usage.siq' => 0.0 }
+
+    d = create_driver(CONFIG_NAME_KEYS)
+    m1 = d.instance.format_metrics('test.', record)
+    assert_equal m1, { 'test.dstat.total_cpu_usage.usr' => 0.0, 'test.dstat.total_cpu_usage.sys' => 0.0, 'test.dstat.total_cpu_usage.idl' => 100.0 }
+
+    d = create_driver(CONFIG_TAG_FOR_IGNORE)
+    m1 = d.instance.format_metrics('test.', record)
+    assert_equal m1, { 'dstat.total_cpu_usage.usr' => 0.0, 'dstat.total_cpu_usage.sys' => 0.0, 'dstat.total_cpu_usage.idl' => 100.0 }
+
+    d = create_driver(CONFIG_TAG_FOR_SUFFIX)
+    m1 = d.instance.format_metrics('test.', record)
+    assert_equal m1, { 'dstat.total_cpu_usage.usr.test' => 0.0, 'dstat.total_cpu_usage.sys.test' => 0.0, 'dstat.total_cpu_usage.idl.test' => 100.0 }
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: adp-fluent-plugin-graphite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Satoshi SUZUKI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-rewrite-tag-name
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: graphite-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: fluentd output plugin to send metrics to graphite
+email: studio3104.com@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- adp-fluent-plugin-graphite.gemspec
+- lib/fluent/plugin/out_graphite.rb
+- test/helper.rb
+- test/plugin/test_out_graphite.rb
+homepage: https://github.com/studio3104/fluent-plugin-graphite
+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: fluentd output plugin to send metrics to graphite
+test_files:
+- test/helper.rb
+- test/plugin/test_out_graphite.rb