logstash-input-cloudwatch_logs 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287e3dab84b5740b9e2f5c6601a6760d31b4680e
-  data.tar.gz: d6bb287f6ef7a479c3c31bb55523d2621baaafce
+  metadata.gz: d2a3f1c5f9e7ebf174d2b3bb7a3a1927008b63e4
+  data.tar.gz: a50af1d3b2ee8cb7638dbfc9bcc61551d5f30520
 SHA512:
-  metadata.gz: cc31d24604f8043fcda1f1c718aa9057a3e1e601eb01b0d8ae38618a8550e091357139dab1331bb639b69f92d69be406988b6879c6c9e1bf5d4a7b5569b928a8
-  data.tar.gz: f5524805783b34d692d6f126943edb6f344e266cb6e4dcb19fa9080be85fc06f93ba01056708e2797600dd7ad8577334e2af8476f7704278a749e1d7505f0d0b
+  metadata.gz: 7333fddf4c94aee0a1065bc4474d1918dc8aee47ae8a97a6eb197f1907b7db01b8ff2eab269e4fdaecc924f51b28a896c2073db2b13609d1daa6ed208b64dd87
+  data.tar.gz: 33a18253a79751a4ad3422042841667226d26a33738d4df687128e1c246f269a826c36c4bf5c9552b822475b0345bb7a85d638af776ef56e75f90a5500d51ef3

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Release Notes for `logstash-input-cloudwatch_logs`
 
-## v0.10.1 (2017-04--19)
+## v0.10.2 (2017-04-20)
+
+### Fixed
+* Fixed bad merge on [#eb38dfd](https://github.com/lukewaite/logstash-input-cloudwatch-logs/commit/eb38dfdc072b4fd21e9c1d83ea306e2b6c5df37b) and restore compatibility with the Logstash 5.x events API ([#21](https://github.com/lukewaite/logstash-input-cloudwatch-logs/pull/21))
+
+## v0.10.1 (2017-04-19)
 
 ### Fixed
 * Fixed issue [#16](https://github.com/lukewaite/logstash-input-cloudwatch-logs/issues/16) which prevented loading the plugin ([#17](https://github.com/lukewaite/logstash-input-cloudwatch-logs/pull/17)) 
@@ -36,4 +41,4 @@
 ## v0.9.0 (2015-07-06)
 
 ### Initial Release
-* This is the initial release of the input
+* This is the initial release of the input

data/README.md

@@ -1,79 +1,54 @@
-# Logstash Plugin
-
-This is a plugin for [Logstash](https://github.com/elasticsearch/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/).
-
-- 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
-
-## Need Help?
-
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
-
-## Developing
-
-### 1. Plugin Developement and Testing
-
-#### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
-
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
-
-- Install dependencies
-```sh
-bundle install
-```
-
-#### Test
-
-- Update your dependencies
-
-```sh
-bundle install
-```
-
-- Run tests
-
-```sh
-bundle exec rspec
-```
-
-### 2. Running your unpublished Plugin in Logstash
-
-#### 2.1 Run in a local Logstash clone
-
-- Edit Logstash `Gemfile` and add the local plugin path, for example:
-```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
-```
-- Install plugin
-```sh
-bin/plugin install --no-verify
-```
-- Run Logstash with your plugin
-```sh
-bin/logstash -e 'filter {awesome {}}'
-```
-At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
-
-#### 2.2 Run in an installed Logstash
-
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
-
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
-```
-- Install the plugin from the Logstash home
-```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
-```
-- Start Logstash and proceed to test the plugin
+# Logstash Input for CloudWatch Logs
+
+[![Gem][ico-version]][link-rubygems]
+[![Downloads][ico-downloads]][link-rubygems]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+
+> Stream events from CloudWatch Logs streams.
+
+### Purpose
+Specify an individual log group, and this plugin will scan
+all log streams in that group, and pull in any new log events.
+
+Optionally, you may set the `log_group_prefix` parameter to true
+which will scan for all log groups matching the specified prefix
+and ingest all logs available in all of the matching groups.
+
+## Usage
+
+### Parameters
+| Parameter | Input Type | Required | Default |
+|-----------|------------|----------|---------|
+| log_group | string | Yes | |
+| log_group_prefix | boolean | No | `false` |
+| sincedb_path | string | No | `$HOME/.sincedb*` |
+| interval | number | No | 60 |
+| aws_credentials_file | string | No | |
+| access_key_id | string | No | |
+| secret_access_key | string | No | |
+| session_token | string | No | |
+| region | string | No | `us-east-1` |
+| codec | string | No | `plain` |
+
+Other standard logstash parameters are available such as:
+* `add_field`
+* `type`
+* `tags`
+
+### Example
+
+    input {
+        cloudwatch_logs {
+            log_group => "/aws/lambda/my-lambda"
+            access_key_id => "AKIAXXXXXX" 
+            secret_access_key => "SECRET"
+        }
+    }
+
+## Development
+The [default logstash README](docs/Logstash%20Plugin%20Development.md) which contains development directions and other information has been moved to the [`docs`](docs/)
+directory.
 
 ## Contributing
 
@@ -83,4 +58,12 @@ 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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+
+[ico-version]: https://img.shields.io/gem/v/logstash-input-cloudwatch_logs.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/gem/dt/logstash-input-cloudwatch_logs.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/lukewaite/logstash-input-cloudwatch-logs.svg?style=flat-square
+
+[link-rubygems]: https://rubygems.org/gems/logstash-input-cloudwatch_logs
+[link-travis]: https://travis-ci.org/lukewaite/logstash-input-cloudwatch_logs

data/lib/logstash/inputs/cloudwatch_logs.rb

@@ -12,12 +12,15 @@ require "logstash/inputs/cloudwatch/patch"
 
 Aws.eager_autoload!
 
-# Stream events from ClougWatch Logs streams.
+# Stream events from CloudWatch Logs streams.
 #
-# Primarily designed to pull logs from Lambda's which are logging to
-# CloudWatch Logs. Specify a log group, and this plugin will scan
+# Specify an individual log group, and this plugin will scan
 # all log streams in that group, and pull in any new log events.
 #
+# Optionally, you may set the `log_group_prefix` parameter to true
+# which will scan for all log groups matching the specified prefix
+# and ingest all logs available in all of the matching groups.
+#
 class LogStash::Inputs::CloudWatch_Logs < LogStash::Inputs::Base
   include LogStash::PluginMixins::AwsConfig::V2
 
@@ -30,7 +33,7 @@ class LogStash::Inputs::CloudWatch_Logs < LogStash::Inputs::Base
   config :log_group, :validate => :string, :required => true
 
   # Where to write the since database (keeps track of the date
-  # the last handled file was added to S3). The default will write
+  # the last handled log stream was updated). The default will write
   # sincedb files to some path matching "$HOME/.sincedb*"
   # Should be a path with filename not just a directory.
   config :sincedb_path, :validate => :string, :default => nil
@@ -121,9 +124,9 @@ class LogStash::Inputs::CloudWatch_Logs < LogStash::Inputs::Base
 
     @codec.decode(log.message.to_str) do |event|
       event.set("@timestamp", parse_time(log.timestamp))
-      event["[cloudwatch][ingestion_time]"] = parse_time(log.ingestion_time)
-      event["[cloudwatch][log_group]"] = stream.arn.split(/:/)[6]
-      event["[cloudwatch][log_stream]"] = stream.log_stream_name
+      event.set("[cloudwatch][ingestion_time]", parse_time(log.ingestion_time))
+      event.set("[cloudwatch][log_group]", stream.arn.split(/:/)[6])
+      event.set("[cloudwatch][log_stream]", stream.log_stream_name)
       decorate(event)
 
       queue << event

data/logstash-input-cloudwatch_logs.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-cloudwatch_logs'
-  s.version         = '0.10.1'
+  s.version         = '0.10.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = 'Stream events from CloudWatch Logs.'
   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'

data/spec/inputs/cloudwatch_logs_spec.rb

@@ -1,37 +1,26 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/inputs/cloudwatch_logs"
-require "logstash/errors"
-require "aws-sdk-resources"
-require_relative "./support/helpers"
 
 describe LogStash::Inputs::CloudWatch_Logs do
-  let(:sincedb_path) { Stud::Temporary.pathname }
-  let(:day) { 3600 * 24 }
-  let(:creds) { Aws::Credentials.new('1234', 'secret') }
-  let(:config) {
-    {
-        "access_key_id" => "1234",
-        "secret_access_key" => "secret",
-        "log_group" => "logstash-test-group",
-        "sincedb_path" => File.join(sincedb_path, ".sincedb")
-    }
-  }
-
   before do
-    FileUtils.mkdir_p(sincedb_path)
     Aws.config[:stub_responses] = true
     Thread.abort_on_exception = true
   end
 
-  context "when interrupting the plugin" do
-    let(:config) { super.merge({ "interval" => 5 }) }
+  describe '#register' do
+    let(:config) {
+      {
+          'access_key_id' => '1234',
+          'secret_access_key' => 'secret',
+          'log_group' => 'sample-log-group',
+          'region' => 'us-east-1'
+      }
+    }
+    subject {LogStash::Inputs::CloudWatch_Logs.new(config)}
 
-    before do
-      # expect_any_instance_of(LogStash::Inputs::CloudWatch_Logs).to receive(:list_new_streams_for_log_group).and_return(TestInfinteCloudWatchObject.new)
+    it "registers succesfully" do
+      expect {subject.register}.to_not raise_error
     end
-
-    it_behaves_like "an interruptible input plugin"
   end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-cloudwatch_logs
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Luke Waite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +88,6 @@ files:
 - lib/logstash/inputs/cloudwatch_logs.rb
 - logstash-input-cloudwatch_logs.gemspec
 - spec/inputs/cloudwatch_logs_spec.rb
-- spec/inputs/support/helpers.rb
 homepage: ''
 licenses:
 - Apache License (2.0)
@@ -117,4 +116,3 @@ specification_version: 4
 summary: Stream events from CloudWatch Logs.
 test_files:
 - spec/inputs/cloudwatch_logs_spec.rb
-- spec/inputs/support/helpers.rb

data/spec/inputs/support/helpers.rb

@@ -1,14 +0,0 @@
-
-class TestInfinteCloudWatchObject
-  def each
-    counter = 1
-
-    loop do
-      object = []
-      object.concat()
-
-      yield "awesome-#{counter}"
-      counter +=1
-    end
-  end
-end