logstash-output-circonus 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 285324780e1273263ae171914b39b96f3fb15058
-  data.tar.gz: 8e75c32e0dc4ee9bea03d0e0358d3d54c36e79fc
+  metadata.gz: 2cc114ba81c3dcbcef33fe78833a4e581e7289c6
+  data.tar.gz: 85a6ebceb0efaaaa3f5dcfb0a8fa1fcca05d503c
 SHA512:
-  metadata.gz: 62e42b8cfb51b26466984a3e6fa058f642e9360a865fae6b2b9140bc2518f36be740f5cd61e79845891f86c976a829fc9c3c9b2d40fb45cfe9767ca121298733
-  data.tar.gz: b438319e4494f8a4a841072f74edfde8df51c748ee6d537ee879b306892b893fde608c596b72f87128659c9336b68070fb2342f5a2f58a0f74de76160d57aed5
+  metadata.gz: 24d1bb0cb05064f05cf3811143d3376e5af38525b40c8ebe986d19b3d4874553b691042d61f94520a51051233f2298bc141940c050a15b51c6a2d2e73b4231b6
+  data.tar.gz: 7d9e0b6f99d6b50e72b6f907b77ee752a2bb2b8a02c270db6379d817ba82f8f8cb470551b860c99e65362a836bd1eb46737264348571592aad1850681878050b

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,93 @@
+:plugin: circonus
+: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}"]
+
+=== Circonus output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Circonus 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}-annotation>> |<<hash,hash>>|Yes
+| <<plugins-{type}s-{plugin}-api_token>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-app_name>> |<<string,string>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-annotation"]
+===== `annotation` 
+
+  * This is a required setting.
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Annotations
+Registers an annotation with Circonus
+The only required field is `title` and `description`.
+`start` and `stop` will be set to the event timestamp.
+You can add any other optional annotation values as well.
+All values will be passed through `event.sprintf`
+
+Example:
+[source,ruby]
+  ["title":"Logstash event", "description":"Logstash event for %{host}"]
+or
+[source,ruby]
+  ["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"]
+
+[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.
+
+This output lets you send annotations to
+Circonus based on Logstash events
+
+Your Circonus API Token
+
+[id="plugins-{type}s-{plugin}-app_name"]
+===== `app_name` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Your Circonus App name
+This will be passed through `event.sprintf`
+so variables are allowed here:
+
+Example:
+ `app_name => "%{myappname}"`
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-circonus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-circonus'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output lets you send annotations to Circonus 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-circonus
 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/circonus.rb
 - logstash-output-circonus.gemspec
 - spec/outputs/circonus_spec.rb