logstash-output-boundary 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03369d36089f8c3f353ba9ae2b5a5e5ad5d00e24
-  data.tar.gz: 3e7193d24843d6ba5af0cc7b01a300cbfaa4cc91
+  metadata.gz: 0a0213b615a27a32854d5573e9f727ceece2dc49
+  data.tar.gz: 642be67b9b3e5d9e4419ed6e49d4a5fae296cf5f
 SHA512:
-  metadata.gz: 8c8831be08b2beec557e32e57df1c1e1d789ef6a2ccc9b11b60f09cdd5c0a2b30f9fe165b6f735cb92f2dfef80a139d452048ce41623f8a5bf4f797831432af8
-  data.tar.gz: 2a7b21fd95b2325d88caa157ec9718b2c04771815c7912054af613ec1d3f5712e280d94f40df6adc7a39f4e3e380ca2dce17426da1ec2b05e89764d45ddcf0a6
+  metadata.gz: b387440edbf900ab72f137b819eb00c9af3621a7d9e80b50e58f57fc2fcfd4dec31100677a93f51ba3190a466f62c7a29a7dca6c46844b6ea7e1749e97dc12c8
+  data.tar.gz: c3e08bf02f8289421d0993ed936056d60460a91d54fda5823df2af138143432d2a937bfa6991b7666090400efbfac92e43c19b57fb8d27e36b9604228e883736

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.1
+  - Docs: Update doc examples to use new event API syntax 
+  
 ## 3.0.0
   - Uses the new plugin api
   - relax contraints on the logstash-core-plugin-api

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,139 @@
+:plugin: boundary
+: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}"]
+
+=== Boundary output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This output lets you send annotations to
+Boundary based on Logstash events
+
+Note that since Logstash maintains no state
+these will be one-shot events
+
+By default the start and stop time will be
+the event timestamp
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Boundary 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}-api_key>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-auto>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-bsubtype>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-btags>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-btype>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-end_time>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-org_id>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-start_time>> |<<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}-api_key"]
+===== `api_key` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Your Boundary API key
+
+[id="plugins-{type}s-{plugin}-auto"]
+===== `auto` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Auto
+If set to true, logstash will try to pull boundary fields out
+of the event. Any field explicitly set by config options will
+override these.
+`['type', 'subtype', 'creation_time', 'end_time', 'links', 'tags', 'loc']`
+
+[id="plugins-{type}s-{plugin}-bsubtype"]
+===== `bsubtype` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Sub-Type
+
+[id="plugins-{type}s-{plugin}-btags"]
+===== `btags` 
+
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+Tags
+Set any custom tags for this event
+Default are the Logstash tags if any
+
+[id="plugins-{type}s-{plugin}-btype"]
+===== `btype` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Type
+
+[id="plugins-{type}s-{plugin}-end_time"]
+===== `end_time` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+End time
+Override the stop time
+Note that Boundary requires this to be seconds since epoch
+If overriding, it is your responsibility to type this correctly
+By default this is set to `event.get("@timestamp").to_i`
+
+[id="plugins-{type}s-{plugin}-org_id"]
+===== `org_id` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Your Boundary Org ID
+
+[id="plugins-{type}s-{plugin}-start_time"]
+===== `start_time` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Start time
+Override the start time
+Note that Boundary requires this to be seconds since epoch
+If overriding, it is your responsibility to type this correctly
+By default this is set to `event.get("@timestamp").to_i`
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/boundary.rb

@@ -25,14 +25,14 @@ class LogStash::Outputs::Boundary < LogStash::Outputs::Base
   # Override the start time
   # Note that Boundary requires this to be seconds since epoch
   # If overriding, it is your responsibility to type this correctly
-  # By default this is set to `event["@timestamp"].to_i`
+  # By default this is set to `event.get("@timestamp").to_i`
   config :start_time, :validate => :string
 
   # End time
   # Override the stop time
   # Note that Boundary requires this to be seconds since epoch
   # If overriding, it is your responsibility to type this correctly
-  # By default this is set to `event["@timestamp"].to_i`
+  # By default this is set to `event.get("@timestamp").to_i`
   config :end_time, :validate => :string
 
   # Type

data/logstash-output-boundary.gemspec

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