logstash-output-graphite 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c18c98a8cac288b2239f9914c92c44b33c59dceb
-  data.tar.gz: 7525262db58187a70b9842326952349ef32373d0
+  metadata.gz: 58deb053b05213957d02afc35d0bda1a2755e7f7
+  data.tar.gz: 650206e9c334878250685fb7391bf8ebe69dc719
 SHA512:
-  metadata.gz: 7b31f638cf19bc0e93b204921ed76c94ec0091ecb78ac2e63e07e9006e50f4427a4ae905044820e47e5ddf38df75bc2c417c58804b7938db90c6abcb75866cb6
-  data.tar.gz: 0194522c5a0bbe93023d87e1b31da97f2cb43d4d169c0e185a14cab29086cecf4ff153aaade609bb25f6de290781fa998e60150472ea7b47d805ad1a61b4544a
+  metadata.gz: 783604b1b26d519802f5f079a73fa35ccf7834ad90cb67742c2d0dd2419a6b7d4d1fb1d0bf9b6135cb679d732b60a7415d85efa583588d1fbf9530a2d4900f64
+  data.tar.gz: 949169f1a3e2a995fa1ee31a50859967d1d7158042b4f13a5126a2c1506036cfac7fdd4cd612fbd8c0896fed280970d7c765e56a0ce32a86f5d12af92e1c4949

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,173 @@
+:plugin: graphite
+:type: output
+
+///////////////////////////////////////////
+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 output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This output allows you to pull metrics from your logs and ship them to
+Graphite. Graphite is an open source tool for storing and graphing metrics.
+
+An example use case: Some applications emit aggregated stats in the logs
+every 10 seconds. Using the grok filter and this output, it is possible to
+capture the metric values from the logs and emit them to Graphite.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Graphite Output Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[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}-host>> |<<string,string>>|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
+| <<plugins-{type}s-{plugin}-nested_object_separator>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-reconnect_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-resend_on_failure>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-timestamp_field>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&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`
+
+An array indicating that these event fields should be treated as metrics
+and will be sent verbatim to Graphite. You may use either `fields_are_metrics`
+or `metrics`, but not both.
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+The hostname or IP address of the Graphite server.
+
+[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
+being the metric name, value being the metric value. Example:
+[source,ruby]
+    metrics => { "%{host}/uptime" => "%{uptime_1m}" }
+
+The value will be coerced to a floating point value. Values which cannot be
+coerced will be set to zero (0). You may use either `metrics` or `fields_are_metrics`,
+but not both.
+
+[id="plugins-{type}s-{plugin}-metrics_format"]
+===== `metrics_format` 
+
+  * Value type is <<string,string>>
+  * Default value is `"*"`
+
+Defines the format of the metric string. The placeholder '*' will be
+replaced with the name of the actual metric.
+[source,ruby]
+    metrics_format => "foo.bar.*.sum"
+
+NOTE: If no metrics_format is defined, the name of the metric will be used as fallback.
+
+[id="plugins-{type}s-{plugin}-nested_object_separator"]
+===== `nested_object_separator` 
+
+  * Value type is <<string,string>>
+  * Default value is `"."`
+
+When hashes are passed in as values they are broken out into a dotted notation
+For instance if you configure this plugin with
+# [source,ruby]
+    metrics => "mymetrics"
+
+and "mymetrics" is a nested hash of '{a => 1, b => { c => 2 }}'
+this plugin will generate two metrics: a => 1, and b.c => 2 .
+If you've specified a 'metrics_format' it will respect that,
+but you still may want control over the separator within these nested key names.
+This config setting changes the separator from the '.' default.
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `2003`
+
+The port to connect to on the Graphite server.
+
+[id="plugins-{type}s-{plugin}-reconnect_interval"]
+===== `reconnect_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `2`
+
+Interval between reconnect attempts to Carbon.
+
+[id="plugins-{type}s-{plugin}-resend_on_failure"]
+===== `resend_on_failure` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Should metrics be resent on failure?
+
+[id="plugins-{type}s-{plugin}-timestamp_field"]
+===== `timestamp_field` 
+
+  * Value type is <<string,string>>
+  * Default value is `"@timestamp"`
+
+Use this field for the timestamp instead of '@timestamp' which is the
+default. Useful when backfilling or just getting more accurate data into
+graphite since you probably have a cache layer infront of Logstash.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-graphite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-graphite'
-  s.version         = '3.1.1'
+  s.version         = '3.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output allows you to pull metrics from your logs and ship them to Graphite"
   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)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-graphite
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 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
@@ -98,6 +98,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/graphite.rb
 - logstash-output-graphite.gemspec
 - spec/outputs/graphite_spec.rb
@@ -125,7 +126,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 output allows you to pull metrics from your logs and ship them to Graphite