logstash-output-CiscoZeus 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81ab38b656873f986e665b219a08401048f7c972
-  data.tar.gz: 1b519c9b95e089476c3820b98fadf32b89e799d5
+  metadata.gz: 68bf5c8119361241419583ed926cebae9f0b8228
+  data.tar.gz: 9792bbe84a4e2ee5875f011a76c20188dd1036a8
 SHA512:
-  metadata.gz: e2986ab1d7f36a4afb63a720cf8153c938c71b033f17d2302794107085eda211126045ee54ac93504cb23ceaad428a677b6243611b34cbd5a3e947d9244e10c5
-  data.tar.gz: 0076f27596900e74513f0c4305896294578261f26e8d22eb2c58245b7d2dc6ce26241ada7e7f063a47a1055bb645296d4153fb8fe7474a78c6890ab8265055a9
+  metadata.gz: 4bca736aa33f43dde362bc330222edd958259f921dad5044b38d9001e617da470404cca692e334c737939af04b93f8b749ee04907c6402c7787b99dfa4b5aa90
+  data.tar.gz: 273d1de66c68882847320a28e8aab0abf3c76edea5b814223d0349d58cfa6191bd7013c89a0e63b99e20c392199430c8bf0b5ed2baf259bb4ba073d4145c3e1a

data/README.md

@@ -20,11 +20,13 @@ jruby -S gem build logstash-output-CiscoZeus.gemspec
 ### Installation
 
 ```sh
-logstash-plugin install logstash-output-CiscoZeus-0.1.0.gem
+logstash-plugin install logstash-output-CiscoZeus
 ```
 
 ### Configuration
 
+#### Logs
+
 Add this configuration to the output section of your logstash configuration file.
 
 ```
@@ -37,6 +39,37 @@ output {
 }
 ```
 
+#### Metrics
+
+The basic configuration is analogous to the Logs plugin
+
+```
+output {
+  CiscoZeusMetrics {
+    token => "my_token"
+    metric_name => "my_desired_log_name"
+    endpoint => "myendpoint.ciscozeus.io"
+  }
+}
+```
+
+With this configuration, the plugin will forward all the numeric fields to Zeus as metrics.
+
+Optionally, you can use `fields` to select a specific set of fields instead. The plugin will try to do a type cast in case you select a non integer field.
+
+```
+output {
+  CiscoZeusMetrics {
+    token => "my_token"
+    metric_name => "my_desired_log_name"
+    endpoint => "myendpoint.ciscozeus.io"
+    fields => ["foo","bar"]
+  }
+}
+```
+
+
+
 ## License and copyright
 
 Copyright(C) 2017 - Cisco Systems, Inc.

data/lib/logstash/outputs/CiscoZeus.rb

@@ -7,11 +7,11 @@ require 'zeus/api_client'
 # Outputs events to CiscoZeus 
 class LogStash::Outputs::Ciscozeus < LogStash::Outputs::Base
   config_name "CiscoZeus"
-  
-  config :token, :validate => :string
-  config :endpoint, :validate => :string, :default => "data04.ciscozeus.io"
+
+  config :token, :validate => :string, :required => true
+  config :endpoint, :validate => :string, :default => "api.ciscozeus.io"
   config :log_name, :validate => :string, :default => "logstash_data"
-  
+
   concurrency :single
 
   def register
@@ -23,7 +23,7 @@ class LogStash::Outputs::Ciscozeus < LogStash::Outputs::Base
 
   def multi_receive(events)
     result = @zeus_client.send_logs(@log_name, events)
-    if not result.success? 
+    if not result.success?
       STDERR.puts "Failed to send data to zeus: " + result.data.to_s
     end
   end # def receive

data/lib/logstash/outputs/CiscoZeusMetrics.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/json"
+require 'zeus/api_client'
+
+# Outputs metrics to CiscoZeus
+class LogStash::Outputs::Ciscozeusmetrics < LogStash::Outputs::Base
+  config_name "CiscoZeusMetrics"
+
+  config :token, :validate => :string, :required => true
+  config :endpoint, :validate => :string, :default => "api.ciscozeus.io"
+  config :metric_name, :validate => :string, :default => "logstash_metric"
+
+  # The plugin forwards all the numeric fields in the event by default.
+  # Use this variable to select a specific set of fields instead,
+  #   in such a case, only the selected fields will be forwarded to Zeus.
+  #   Besides, even if some field is of a non-numeric type,
+  #   the plugin will try to convert it using ruby type casting.
+  config :fields, :validate => :string, :list => true, :default => nil
+
+  concurrency :single
+
+  def register
+    @zeus_client = Zeus::APIClient.new({
+      access_token: @token,
+      endpoint: @endpoint
+    })
+  end # def register
+
+  def multi_receive(events)
+    metrics = events.map{|event| reform(event)}
+    result = @zeus_client.send_metrics(@metric_name, metrics)
+    if not result.success?
+      STDERR.puts "Failed to send data to zeus: " + result.data.to_s
+    end
+  end # def receive
+
+  #Matches Zeus metrics API format
+  def reform(event)
+    datapoint = {}
+    if @fields == nil
+      datapoint = event.to_hash.select{ |k,v| k != "@timestamp" and v.is_a? Numeric }
+    else
+      datapoint = event.to_hash.select{ |k,v| @fields.include? k }
+      datapoint = Hash[datapoint.map{ |k,v|  [k,if v.is_a? Numeric then v else v.to_f end]}]
+    end
+    return {timestamp: event.get("@timestamp").to_f, point: datapoint}
+  end # def reform
+
+end # class LogStash::Outputs::Ciscozeusmetrics

data/logstash-output-CiscoZeus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-CiscoZeus'
-  s.version       = '0.1.1'
+  s.version       = '0.2.0'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Logstash plugin to talk with the CiscoZeus HTTP API'
   s.homepage      = 'http://ciscozeus.io'
@@ -9,13 +9,15 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # Files
-  s.files = Dir['lib/**/*', 'vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
-  
+  s.files = Dir['lib/**/*', 'spec/**/*', 'vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
   # Special flag to let us know this is actually a logstash plugin
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0"
   s.add_runtime_dependency "logstash-codec-plain"
   s.add_runtime_dependency "zeusclient", "~> 0"
 end

data/spec/outputs/CiscoZeusMetrics_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/Ciscozeusmetrics"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Ciscozeusmetrics do
+
+  def performTest(input, expected_output, configuration)
+    event = LogStash::Event.new(input)
+
+    configuration["token"] = "tk"
+    metrics_plugin = LogStash::Outputs::Ciscozeusmetrics.new(configuration)
+
+    expected_output[:timestamp] = event.get("@timestamp").to_f
+
+    output = metrics_plugin.reform(event)
+
+    #Workaround to convert string keys into symbols
+    output[:point] = output[:point].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+    expect(output).to eq(expected_output)
+  end
+
+  describe "Simple message with one metric" do
+    input = {"metric1": 6}
+    output = {"point": {"metric1": 6}}
+    it "works as expected" do
+      performTest(input,output,{})
+    end
+  end
+
+  describe "Simple message with several metric" do
+    input = {"metric1": 6, "metric2":7}
+    output = {"point":{"metric1":6, "metric2":7}}
+    it "works as expected" do
+      performTest(input,output,{})
+    end
+  end
+
+  describe "Message with non numerical fields" do
+    input = {"message": "hello", "world": "earth", "metric1": 6.5, "metric2":7}
+    output = {"point":{"metric1":6.5, "metric2":7}}
+    it "works as expected" do
+      performTest(input,output,{})
+    end
+  end
+
+  describe "Field selection" do
+    input = {"message": "hello", "world": "earth", "metric1": 6.5, "metric2":7}
+    output = {"point":{"metric1":6.5}}
+    conf = {"fields" => "metric1"}
+    it "works as expected" do
+      performTest(input,output,conf)
+    end
+  end
+
+  describe "Field selection with type cast needed" do
+    input = {"metric1": 6.5, "metric2":7, "metric3":"24"}
+    output = {"point":{"metric1":6.5, "metric3": 24}}
+    conf = {"fields" => ["metric1", "metric3"]}
+    it "works as expected" do
+      performTest(input,output,conf)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-CiscoZeus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yoel Cabo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -16,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
   name: logstash-core
   prerelease: false
   type: :runtime
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -68,7 +62,9 @@ files:
 - LICENSE
 - README.md
 - lib/logstash/outputs/CiscoZeus.rb
+- lib/logstash/outputs/CiscoZeusMetrics.rb
 - logstash-output-CiscoZeus.gemspec
+- spec/outputs/CiscoZeusMetrics_spec.rb
 homepage: http://ciscozeus.io
 licenses:
 - Apache-2.0
@@ -95,4 +91,5 @@ rubygems_version: 2.6.8
 signing_key:
 specification_version: 4
 summary: Logstash plugin to talk with the CiscoZeus HTTP API
-test_files: []
+test_files:
+- spec/outputs/CiscoZeusMetrics_spec.rb