logstash-output-librato 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 788eb8edeb263e20cf9493ae65b83cd44ad9ea1e
-  data.tar.gz: 8f0f26fca91eaa32d59e5d552f05af57eb00f3f2
+  metadata.gz: 3236c5a07fada333f897a6b67577551402ada99b
+  data.tar.gz: 0e8efd70439bcdc010c1e1192cc52879f79820d1
 SHA512:
-  metadata.gz: 35250a8b4641eb83549dd514434dae09f2ed08f4fae6d9ec03a44536c35e292318a42a66b01ff77756da14c67e8456df67615f33b30c682679574935130c880b
-  data.tar.gz: bc453abd46e37ee82ac925944907e280a9d4d5bdbd804221256221bd88c6fbe4bf41736d4dbe53c64baa28780ebb4fe14046f3e4f8803da6cfc8f6712c9896e1
+  metadata.gz: fc4887529affe6dadbb7b508fa11a90bf7794abf03695ae5cddd4619f5ad6fe35aca6502d3162cec42d2cbb0fce65f529fce98272fc6dca17babd2e2e0bea9e5
+  data.tar.gz: d209af1a79aab0194f21891498668ee91057397a28d3cbb63294e419a0f97191fc381e890b9dc8daed4fd24db4ad83709e78099afe2f3be3c14bc081d988ffda

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.0.1
+  - Docs: Update doc example to use new event API syntax 
+# 3.0.0
+  - Update plugin to the new event API
 # 2.0.4
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.0.3

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,162 @@
+:plugin: librato
+: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}"]
+
+=== Librato output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Librato 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}-account_id>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-annotation>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-api_token>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-batch_size>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-counter>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-gauge>> |<<hash,hash>>|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}-account_id"]
+===== `account_id` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+This output lets you send metrics, annotations and alerts to
+Librato based on Logstash events
+
+This is VERY experimental and inefficient right now.
+Your Librato account
+usually an email address
+
+[id="plugins-{type}s-{plugin}-annotation"]
+===== `annotation` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Annotations
+Registers an annotation with Librato
+The only required field is `title` and `name`.
+`start_time` and `end_time` will be set to `event.get("@timestamp").to_i`
+You can add any other optional annotation values as well.
+All values will be passed through `event.sprintf`
+
+Example:
+[source,ruby]
+  {
+      "title" => "Logstash event on %{host}"
+      "name" => "logstash_stream"
+  }
+or
+[source,ruby]
+   {
+      "title" => "Logstash event"
+      "description" => "%{message}"
+      "name" => "logstash_stream"
+   }
+
+[id="plugins-{type}s-{plugin}-api_token"]
+===== `api_token` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Your Librato API Token
+
+[id="plugins-{type}s-{plugin}-batch_size"]
+===== `batch_size` 
+
+  * Value type is <<string,string>>
+  * Default value is `"10"`
+
+Batch size
+Number of events to batch up before sending to Librato.
+
+
+[id="plugins-{type}s-{plugin}-counter"]
+===== `counter` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Counters
+Send data to Librato as a counter
+
+Example:
+[source,ruby]
+    {
+        "value" => "1"
+        "source" => "%{host}"
+        "name" => "messages_received"
+    }
+    
+Additionally, you can override the `measure_time` for the event. Must be a unix timestamp:
+[source,ruby]
+    {
+        "value" => "1"
+        "source" => "%{host}"
+        "name" => "messages_received"
+        "measure_time" => "%{my_unixtime_field}"
+    }
+Default is to use the event's timestamp
+
+[id="plugins-{type}s-{plugin}-gauge"]
+===== `gauge` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Gauges
+Send data to Librato as a gauge
+
+Example:
+[source,ruby]
+    {
+        "value" => "%{bytes_received}"
+        "source" => "%{host}"
+        "name" => "apache_bytes"
+    }
+Additionally, you can override the `measure_time` for the event. Must be a unix timestamp:
+[source,ruby]
+    {
+        "value" => "%{bytes_received}"
+        "source" => "%{host}"
+        "name" => "apache_bytes"
+        "measure_time" => "%{my_unixtime_field}
+    }
+Default is to use the event's timestamp
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/librato.rb

@@ -64,7 +64,7 @@ class LogStash::Outputs::Librato < LogStash::Outputs::Base
   # Annotations
   # Registers an annotation with Librato
   # The only required field is `title` and `name`.
-  # `start_time` and `end_time` will be set to `event["@timestamp"].to_i`
+  # `start_time` and `end_time` will be set to `event.get("@timestamp").to_i`
   # You can add any other optional annotation values as well.
   # All values will be passed through `event.sprintf`
   #

data/logstash-output-librato.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-librato'
-  s.version         = '3.0.0'
+  s.version         = '3.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output lets you send metrics, annotations and alerts to Librato based on Logstash events"
   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-librato
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 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/librato.rb
 - logstash-output-librato.gemspec
 - spec/outputs/librato_spec.rb