logstash-output-loggly 0.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa7dec5eae9b97c811cad614e5077858b62db8fa
-  data.tar.gz: f7dc0c10c7758d5e0f17e3f0f603cd447a48d6ef
+  metadata.gz: 70c1e136a9f7ea7a6739d2c93d08d1874fda32d4
+  data.tar.gz: ce562168124bf4137dd0e3a90c7e3c0bb7facbcf
 SHA512:
-  metadata.gz: b1a9e7a8ec2fc9a8807488234c79eb8dd5960a9a3dfc2badc1b5eaf227d1548aa2ce67e9759273a99e86b31779837299afa52b9f3aa20955f5e2724c7f04e21b
-  data.tar.gz: fef1b99e42ebb35fe8fab94f6ac8e82a4ba559772dfe09d5c1041678d6091af287a1179fdf6e22947a77ac23b56649dd7737d0f8dcc1759a518907e163ca63a4
+  metadata.gz: 7b238ed543f8d34c700b4b84d3d20e359957bd00f7a99b6e6a7207411ccf1c0e28b61edaa9082d46e4a679da52ea3b9b8f7002027158bca38d505456fae52767
+  data.tar.gz: 1064d4d6922999d88c48f98c161bfe2cd7fba0f4b56d242536541fa4c749efefcc6c19821372589db24760569dca640ee35520086fd66dc77e2708d95076e469

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -1,19 +1,19 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
-Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/loggly.rb

@@ -29,8 +29,10 @@ class LogStash::Outputs::Loggly < LogStash::Outputs::Base
   config_name "loggly"
 
   # The hostname to send logs to. This should target the loggly http input
-  # server which is usually "logs.loggly.com"
-  config :host, :validate => :string, :default => "logs.loggly.com"
+  # server which is usually "logs-01.loggly.com" (Gen2 account).
+  # See Loggly HTTP endpoint documentation at
+  # https://www.loggly.com/docs/http-endpoint/
+  config :host, :validate => :string, :default => "logs-01.loggly.com"
 
   # The loggly http input key to send to.
   # This is usually visible in the Loggly 'Inputs' page as something like this:
@@ -47,6 +49,16 @@ class LogStash::Outputs::Loggly < LogStash::Outputs::Base
   # Should the log action be sent over https instead of plain http
   config :proto, :validate => :string, :default => "http"
 
+  # Loggly Tag
+  # Tag helps you to find your logs in the Loggly dashboard easily
+  # You can make a search in Loggly using tag as "tag:logstash-contrib"
+  # or the tag set by you in the config file.
+  #
+  # You can use %{somefield} to allow for custom tag values.
+  # Helpful for leveraging Loggly source groups.
+  # https://www.loggly.com/docs/source-groups/
+  config :tag, :validate => :string, :default => "logstash"
+
   # Proxy Host
   config :proxy_host, :validate => :string
 
@@ -74,21 +86,48 @@ class LogStash::Outputs::Loggly < LogStash::Outputs::Base
       return
     end
 
-    # Send the event over http.
-    url = URI.parse("#{@proto}://#{@host}/inputs/#{event.sprintf(@key)}")
+    key = event.sprintf(@key)
+    tag = event.sprintf(@tag)
+
+    # For those cases where %{somefield} doesn't exist
+    # we should ship logs with the default tag value.
+    tag = 'logstash' if /^%{\w+}/.match(tag)
+ 
+    # Send event
+    send_event("#{@proto}://#{@host}/inputs/#{key}/tag/#{tag}", format_message(event))
+  end # def receive
+
+  public
+  def format_message(event)
+    event.to_json
+  end
+
+  private
+  def send_event(url, message)
+    url = URI.parse(url)
     @logger.info("Loggly URL", :url => url)
-    http = Net::HTTP::Proxy(@proxy_host, @proxy_port, @proxy_user, @proxy_password.value).new(url.host, url.port)
+
+    http = Net::HTTP::Proxy(@proxy_host,
+                            @proxy_port,
+                            @proxy_user,
+                            @proxy_password.value).new(url.host, url.port)
+
     if url.scheme == 'https'
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
+
+    # post message
     request = Net::HTTP::Post.new(url.path)
-    request.body = event.to_json
+    request.body = message
     response = http.request(request)
+
     if response.is_a?(Net::HTTPSuccess)
       @logger.info("Event send to Loggly OK!")
     else
       @logger.warn("HTTP error", :error => response.error!)
     end
-  end # def receive
+  end # def send_event
+ 
 end # class LogStash::Outputs::Loggly
+

data/logstash-output-loggly.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-loggly'
-  s.version         = '0.1.4'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Got a loggly account? Use logstash to ship logs to Loggly!"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-codec-plain'
 end
 

data/spec/outputs/loggly_spec.rb

@@ -1 +1,65 @@
-require "logstash/devutils/rspec/spec_helper"
+# encoding: utf-8
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/loggly'
+
+describe 'outputs/loggly' do
+  let(:config) { { 'key' => 'abcdef123456' } }
+
+  let(:event) do
+    LogStash::Event.new(
+      'message' => 'fanastic log entry',
+      'source' => 'someapp',
+      'type' => 'nginx',
+      '@timestamp' => LogStash::Timestamp.now)
+  end
+
+  context 'when initializing' do
+    subject { LogStash::Outputs::Loggly.new(config) }
+
+    it 'should register' do
+      expect { subject.register }.to_not raise_error
+    end
+
+    it 'should have default config values' do
+      insist { subject.proto } == 'http'
+      insist { subject.host } == 'logs-01.loggly.com'
+      insist { subject.tag } == 'logstash'
+    end
+  end
+
+  context 'when outputting messages' do
+    it 'should support field interpolation on key' do
+      # add a custom key value for Loggly config
+      event['token'] = 'xxxxxxx1234567'
+      config['key'] = '%{token}'
+
+      output = LogStash::Outputs::Loggly.new(config)
+      allow(output).to receive(:send_event).with('http://logs-01.loggly.com/inputs/xxxxxxx1234567/tag/logstash',
+                                                 event.to_json)
+      output.receive(event)
+    end
+
+    it 'should set the default tag to logstash' do
+      output = LogStash::Outputs::Loggly.new(config)
+      allow(output).to receive(:send_event).with('http://logs-01.loggly.com/inputs/abcdef123456/tag/logstash',
+                                                 event.to_json)
+      output.receive(event)
+    end
+
+    it 'should support field interpolation for tag' do
+      config['tag'] = '%{source}'
+      output = LogStash::Outputs::Loggly.new(config)
+      allow(output).to receive(:send_event).with('http://logs-01.loggly.com/inputs/abcdef123456/tag/someapp',
+                                                 event.to_json)
+      output.receive(event)
+    end
+
+    it 'should default tag to logstash if interpolated field does not exist' do
+      config['tag'] = '%{foobar}'
+      output = LogStash::Outputs::Loggly.new(config)
+      allow(output).to receive(:send_event).with('http://logs-01.loggly.com/inputs/abcdef123456/tag/logstash',
+                                                 event.to_json)
+      output.receive(event)
+    end
+  end
+end

metadata

@@ -1,64 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-loggly
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+        version: 2.0.0.snapshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  name: logstash-core
+        version: 2.0.0.snapshot
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- lib/logstash/outputs/loggly.rb
+- spec/outputs/loggly_spec.rb
+- logstash-output-loggly.gemspec
+- CHANGELOG.md
+- README.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
-- README.md
-- Rakefile
-- lib/logstash/outputs/loggly.rb
-- logstash-output-loggly.gemspec
-- spec/outputs/loggly_spec.rb
+- NOTICE.TXT
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"