logstash-output-graphtastic 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f59d3a9fe6181c72efa1dab095a3143dbe8f0f21
-  data.tar.gz: bd90a2c65e30b853085b491b34962ed640aa406b
+  metadata.gz: ce04a141e46f0a53172b616487aae4895e84f735
+  data.tar.gz: c07567d72fa83f4aee32cef818539152c3129e6c
 SHA512:
-  metadata.gz: a0edb3b0034c1f85540bcf9d084b0b719b0897f40b6351dd7ecb9c376c0d302b265c3a789f4a9f8e7032c34288916a067593378b5c44e9a600c938f9301edd51
-  data.tar.gz: 1e05bb42eaee71ccb6eb29927953cffa138bf948dc7faa78c1492b3e8907ef63808dd1b9196214020688eda1ed7dc543e103a06bb19a449cf543fd0f1b2f66e1
+  metadata.gz: 4249632a2c5110d8ecd659c60ac9254cbf248b6cb86cff4f0f75a71b3d3cee0b00e61ec8a96bdf8e9b6688f55033fa620b4264fc5fb646c9b8df7587e4f30b14
+  data.tar.gz: 0ca2f518c1fcbbfa390cdcd12ed78fbecc20eac95322bb5d2c241ad0324a7c35f75148835f7ae6719e9961d381d60dc20e2b57b88f71ecf108cc9f7a3642ff73

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-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,148 @@
+:plugin: graphtastic
+: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}"]
+
+=== Graphtastic output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+A plugin for a newly developed Java/Spring Metrics application
+I didn't really want to code this project but I couldn't find
+a respectable alternative that would also run on any Windows
+machine - which is the problem and why I am not going with Graphite
+and statsd.  This application provides multiple integration options
+so as to make its use under your network requirements possible.
+This includes a REST option that is always enabled for your use
+in case you want to write a small script to send the occasional
+metric data.
+
+Find GraphTastic here : https://github.com/NickPadilla/GraphTastic
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Graphtastic 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}-batch_number>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-context>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-error_file>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-integration>> |<<string,string>>, one of `["udp", "tcp", "rmi", "rest"]`|No
+| <<plugins-{type}s-{plugin}-metrics>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-retries>> |<<number,number>>|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}-batch_number"]
+===== `batch_number` 
+
+  * Value type is <<number,number>>
+  * Default value is `60`
+
+the number of metrics to send to GraphTastic at one time. 60 seems to be the perfect
+amount for UDP, with default packet size.
+
+[id="plugins-{type}s-{plugin}-context"]
+===== `context` 
+
+  * Value type is <<string,string>>
+  * Default value is `"graphtastic"`
+
+if using rest as your end point you need to also provide the application url
+it defaults to localhost/graphtastic.  You can customize the application url
+by changing the name of the .war file.  There are other ways to change the
+application context, but they vary depending on the Application Server in use.
+Please consult your application server documentation for more on application
+contexts.
+
+[id="plugins-{type}s-{plugin}-error_file"]
+===== `error_file` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+setting allows you to specify where we save errored transactions
+this makes the most sense at this point - will need to decide
+on how we reintegrate these error metrics
+NOT IMPLEMENTED!
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"127.0.0.1"`
+
+host for the graphtastic server - defaults to 127.0.0.1
+
+[id="plugins-{type}s-{plugin}-integration"]
+===== `integration` 
+
+  * Value can be any of: `udp`, `tcp`, `rmi`, `rest`
+  * Default value is `"udp"`
+
+options are udp(fastest - default) - rmi(faster) - rest(fast) - tcp(don't use TCP yet - some problems - errors out on linux)
+
+[id="plugins-{type}s-{plugin}-metrics"]
+===== `metrics` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+metrics hash - you will provide a name for your metric and the metric
+data as key value pairs.  so for example:
+
+[source,ruby]
+metrics => { "Response" => "%{response}" }
+
+example for the logstash config
+
+[source,ruby]
+metrics => [ "Response", "%{response}" ]
+
+NOTE: you can also use the dynamic fields for the key value as well as the actual value
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+port for the graphtastic instance - defaults to 1199 for RMI, 1299 for TCP, 1399 for UDP, and 8080 for REST
+
+[id="plugins-{type}s-{plugin}-retries"]
+===== `retries` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+number of attempted retry after send error - currently only way to integrate
+errored transactions - should try and save to a file or later consumption
+either by graphtastic utility or by this program after connectivity is
+ensured to be established.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-graphtastic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-graphtastic'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send metrics to GraphTastic"
   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"
@@ -10,7 +10,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-graphtastic
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/graphtastic.rb
 - logstash-output-graphtastic.gemspec
 - spec/outputs/graphtastic_spec.rb