logstash-codec-graphite 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5e875b6c61301bd447a593556cb635e7cabb3a7
-  data.tar.gz: 17c108254a40fd8c2937eb0665f247b984657e41
+  metadata.gz: 859dc15d43e063bcbedd5b0a2a2b9296d33f5562
+  data.tar.gz: bafc39cd683fcb28c29d04218a0cff3021015ca0
 SHA512:
-  metadata.gz: 7c2eca2d8908111154aa589b3d520daac5ae093ef0433e13063478f1cb50b9587f8f14a6899fcdf050845c51103479a7270a0b658043c07066b8a1811f2d3238
-  data.tar.gz: edbc70a9e0f7daef34a96ffe0819779a2f92018bcf05835605389e113f4c8f8e3fa940493267df6ef19fcbc5c46602970cedc8f809a7fa72d8b5b3956120e68e
+  metadata.gz: 6363a8e6244389d9a106ef5f7a929117521260414532baa394c046dabf2ea529dddbcbfbf40f2e7ae109bca5785e2e9569704e2af1bc684cc49720ad9b5afe92
+  data.tar.gz: 39d3adbe589138e5864f5c44d8f390334017be37dcb3502d711aea33978cbed0f9264cecebbea48e544e8188f5e020ac5a47f857c21dd61ddd903aab87f054f2

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,93 @@
+:plugin: graphite
+:type: codec
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Graphite codec plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This codec will encode and decode Graphite formated lines.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Graphite Codec Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-exclude_metrics>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-fields_are_metrics>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-include_metrics>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-metrics>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-metrics_format>> |<<string,string>>|No
+|=======================================================================
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-exclude_metrics"]
+===== `exclude_metrics` 
+
+  * Value type is <<array,array>>
+  * Default value is `["%{[^}]+}"]`
+
+Exclude regex matched metric names, by default exclude unresolved %{field} strings
+
+[id="plugins-{type}s-{plugin}-fields_are_metrics"]
+===== `fields_are_metrics` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Indicate that the event @fields should be treated as metrics and will be sent as is to graphite
+
+[id="plugins-{type}s-{plugin}-include_metrics"]
+===== `include_metrics` 
+
+  * Value type is <<array,array>>
+  * Default value is `[".*"]`
+
+Include only regex matched metric names
+
+[id="plugins-{type}s-{plugin}-metrics"]
+===== `metrics` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+The metric(s) to use. This supports dynamic strings like `%{host}`
+for metric names and also for values. This is a hash field with key
+of the metric name, value of the metric value. Example:
+[source,ruby]
+    [ "%{host}/uptime", "%{uptime_1m}" ]
+
+The value will be coerced to a floating point value. Values which cannot be
+coerced will zero (0)
+
+[id="plugins-{type}s-{plugin}-metrics_format"]
+===== `metrics_format` 
+
+  * Value type is <<string,string>>
+  * Default value is `"*"`
+
+Defines format of the metric string. The placeholder `*` will be
+replaced with the name of the actual metric. This supports dynamic
+strings like `%{host}`.
+[source,ruby]
+    metrics_format => "%{host}.foo.bar.*.sum"
+
+NOTE: If no metrics_format is defined the name of the metric will be used as fallback.
+
+

data/lib/logstash/codecs/graphite.rb

@@ -33,9 +33,10 @@ class LogStash::Codecs::Graphite < LogStash::Codecs::Base
   config :exclude_metrics, :validate => :array, :default => [ "%\{[^}]+\}" ]
 
   # Defines format of the metric string. The placeholder `*` will be
-  # replaced with the name of the actual metric.
+  # replaced with the name of the actual metric. This supports dynamic
+  # strings like `%{host}`.
   # [source,ruby]
-  #     metrics_format => "foo.bar.*.sum"
+  #     metrics_format => "%{host}.foo.bar.*.sum"
   #
   # NOTE: If no metrics_format is defined the name of the metric will be used as fallback.
   config :metrics_format, :validate => :string, :default => DEFAULT_METRICS_FORMAT
@@ -70,6 +71,7 @@ class LogStash::Codecs::Graphite < LogStash::Codecs::Base
 
     messages = []
     timestamp = event.sprintf("%{+%s}")
+    @metrics_format = event.sprintf(@metrics_format)
 
     if @fields_are_metrics
       @logger.debug("got metrics event", :metrics => event.to_hash)

data/logstash-codec-graphite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-graphite'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This codec will encode and decode Graphite formated lines."
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

data/spec/codecs/graphite_spec.rb

@@ -1,3 +1,4 @@
+require "logstash/devutils/rspec/spec_helper"
 require "logstash/codecs/graphite"
 require "logstash/event"
 require "insist"
@@ -92,5 +93,19 @@ describe LogStash::Codecs::Graphite do
       end
       subject.encode(LogStash::Event.new("@timestamp" => timestamp))
     end
+
+    it "should support dynamic strings in metrics_format" do
+      name = Random.srand.to_s(36)
+      value = Random.rand*1000
+      timestamp = Time.now.gmtime
+      host = "localhost"
+      subject.metrics = {name => value}
+      subject.metrics_format = "%{host}.foo.bar.*.baz"
+      subject.on_event do |event, data|
+        insist { data.is_a? String }
+        insist { data } == "#{host}.foo.bar.#{name}.baz #{value} #{timestamp.to_i}\n"
+      end
+      subject.encode(LogStash::Event.new({'host' => host, "@timestamp" => timestamp}))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-graphite
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/codecs/graphite.rb
 - logstash-codec-graphite.gemspec
 - spec/codecs/graphite_spec.rb
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: This codec will encode and decode Graphite formated lines.