logstash-input-cloudwatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd905939912c0289d1f422f637b80f0bd4abc723
+  data.tar.gz: 7da492dea138521b8b92e2756ffd3d4be2cfe615
+SHA512:
+  metadata.gz: 09eadecfe87039ba40806927cd530e8a0c1f838e95b1d5ae3c69a784120173af75023c5f7436b5bceac6e91491dfe77018cd4c1d1f6706a609e473778c9ba350
+  data.tar.gz: 91f39d44ffb49e98a3ccfd855a5e01606728b9a0b4baa714ee23d6f0ce3e738853c1eaf51c10b8016329d4d355afd8bab2275c43e40f7741b42a0e2b9bc4cf12

data/.gitignore

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

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-example
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+ruby "1.9.3", :engine => "jruby", :engine_version => "1.7.19"
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# 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
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+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.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/inputs/cloudwatch.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/timestamp"
+require "logstash/util"
+require "logstash/plugin_mixins/aws_config"
+require "stud/interval"
+
+# Pull events from the Amazon Web Services CloudWatch API.
+#
+# CloudWatch provides various metrics on EC2, EBS and SNS.
+#
+# To use this plugin, you *must* have an AWS account
+
+class LogStash::Inputs::CloudWatch < LogStash::Inputs::Base
+  include LogStash::PluginMixins::AwsConfig
+
+  config_name "cloudwatch"
+
+  # If undefined, LogStash will complain, even if codec is unused.
+  default :codec, "json"
+
+  # Set how frequently CloudWatch should be queried
+  #
+  # The default, `900`, means check every 15 minutes
+  config :interval, :validate => :number, :default => (60 * 15)
+
+  # Set the granularity of the retruned datapoints.
+  #
+  # Must be at least 60 seconds and in multiples of 60.
+  config :period, :validate => :number, :default => 60
+
+  # The service namespace of the metrics to fetch.
+  #
+  # The default is for the EC2 service. Valid values are 'AWS/EC2', 'AWS/EBS' and
+  # 'AWS/SNS'.
+  config :namespace, :validate => :string, :default => 'AWS/EC2'
+
+  # The instances to check.
+  #
+  # Either specify specific instances using this setting, or use `tag_name` and
+  # `tag_values`. The `instances` setting takes precedence.
+  config :instances, :validate => :array
+
+  # Specify which tag to use when determining what instances to fetch metrics for
+  #
+  # You need to specify `tag_values` when using this setting. The `instances` setting
+  # takes precedence.
+  config :tag_name, :validate => :string
+
+  # Specify which tag value to check when determining what instances to fetch metrics for
+  #
+  # You need to specify `tag_name` when using this setting. The `instances` setting
+  # takes precedence.
+  config :tag_values, :validate => :array
+
+  # Specify the metrics to fetch for each instance
+  config :metrics, :validate => :array, :default => [ 'CPUUtilization', 'DiskReadOps', 'DiskWriteOps', 'NetworkIn', 'NetworkOut' ]
+
+  # Specify the statistics to fetch for each metric
+  config :statistics, :validate => :array, :default => [ 'SampleCount', 'Average', 'Minimum', 'Maximum', 'Sum' ]
+
+  public
+  def aws_service_endpoint(region)
+    { region: region }
+  end
+
+  public
+  def register
+    require "aws-sdk"
+    AWS.config(:logger => @logger)
+
+    @cloudwatch = AWS::CloudWatch::Client.new(aws_options_hash)
+    @ec2 = AWS::EC2::Client.new(aws_options_hash)
+
+  end # def register
+
+  def run(queue)
+    Stud.interval(@interval) do
+      @logger.debug('Polling CloudWatch API')
+      instance_ids.each do |instance|
+        metrics(instance).each do |metric|
+          opts = options(metric, instance)
+          @cloudwatch.get_metric_statistics(opts)[:datapoints].each do |dp|
+            event = LogStash::Event.new(LogStash::Util.stringify_symbols(dp))
+            event['@timestamp'] = LogStash::Timestamp.new(dp[:timestamp])
+            event['metric'] = metric
+            event['instance'] = instance
+            decorate(event)
+            queue << event
+          end
+        end
+      end
+    end # loop
+  end # def run
+
+  private
+  def options(metric, instance)
+    {
+      namespace: @namespace,
+      metric_name: metric,
+      dimensions: [ { name: 'InstanceId', value: instance } ],
+      start_time: (Time.now - @interval).iso8601,
+      end_time: Time.now.iso8601,
+      period: @period,
+      statistics: @statistics
+    }
+  end
+
+  private
+  def metrics(instance)
+    metrics_available(instance) & @metrics
+  end
+
+  private
+  def metrics_available(instance)
+    @metrics ||= Hash.new do |h, k|
+      opts = {
+        namespace: @namespace,
+        dimensions: [ { name: 'InstanceId', value: instance } ]
+      }
+
+      h[k] = []
+      @cloudwatch.list_metrics(opts)[:metrics].each do |metrics|
+        h[k].push metrics[:metric_name]
+      end
+      h[k]
+    end
+  end
+
+  private
+  def instance_ids
+    return @instances unless @instances.nil?
+
+    raise('Both the tag_name and tag_values needs to be set if no instances are specified') if @tag_name.nil? || @tag_values.nil?
+    @instances = []
+    @ec2.describe_instances(filters: [ { name: "tag:#{@tag_name}", values: @tag_values } ])[:reservation_set].each do |reservation|
+      @logger.debug reservation
+      reservation[:instances_set].each do |instance|
+        @instances.push instance[:instance_id]
+      end
+    end
+    @logger.debug 'Fetching metrics for the following instances', instances: @instances
+    @instances
+  end
+
+end # class LogStash::Inputs::CloudWatch

data/lib/logstash/inputs/test.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/plugin_mixins/aws_config"
+require 'pp'
+require 'logger'
+
+class LogStash::Inputs::Test < LogStash::Inputs::Base
+  include LogStash::PluginMixins::AwsConfig
+
+  config_name "cloudwatch"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  public
+  def aws_service_endpoint(region)
+    {
+      region: region
+    }
+  end
+
+  public
+  def register
+    require "aws-sdk"
+    AWS.config(:logger => Logger.new($stdout))
+    AWS.config(:log_level => :debug)
+
+    @interval  = 60 * 15
+    @region    = 'eu-west-1'
+    @namespace = 'AWS/EC2'
+    @metrics   = [ 'CPUUtilization' ]
+    @period    = 60
+    @statistics = ["SampleCount", "Average", "Minimum", "Maximum", "Sum"]
+    @tag_name = 'Managed'
+    @tag_values = [ 'Yes' ]
+
+    @cloudwatch = ::AWS::CloudWatch::Client.new(aws_options_hash)
+    @ec2 = ::AWS::EC2::Client.new(aws_options_hash)
+  end
+
+  def tryit
+    instance_ids.each do |instance|
+      metrics(instance).each do |metric|
+        opts = {
+          namespace: @namespace,
+          metric_name: metric,
+          dimensions: [ { name: 'InstanceId', value: instance } ],
+          start_time: (Time.now - @interval).iso8601,
+          end_time: Time.now.iso8601,
+          period: @period,
+          statistics: @statistics
+        }
+        puts "#{instance} #{metric}"
+        @cloudwatch.get_metric_statistics(opts)[:datapoints].each do |dp|
+          puts dp.inspect
+          # event = Logstash::Event.new(dp)
+          # puts event.inspect
+          # decorate(event)
+          # queue << event
+        end
+      end
+    end
+  end
+
+  def metrics(instance)
+    metrics_available(instance) & @metrics
+  end
+
+  def instance_ids
+    @instances = []
+    @ec2.describe_instances(filters: [ { name: "tag:#{@tag_name}", values: @tag_values } ])[:reservation_set].each do |reservation|
+      reservation[:instances_set].each do |instance|
+        @instances.push instance[:instance_id]
+      end
+    end
+    @instances
+  end
+
+  def metrics_available(instance)
+    opts = { namespace: @namespace, dimensions: [ { name: 'InstanceId', value: instance } ] }
+    results = []
+    @cloudwatch.list_metrics(opts)[:metrics].each do |metrics|
+      results.push metrics[:metric_name]
+    end
+    results
+  end
+end
+
+puts "Starting up"
+test = LogStash::Inputs::Test.new
+puts "Registering"
+test.register
+puts "Get the instances"
+test.tryit

data/logstash-input-cloudwatch.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-cloudwatch'
+  s.version         = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "Retrieve stats from AWS CloudWatch."
+  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"
+  s.authors = ["Jurgens du Toit"]
+  s.email = 'jrgns@jadeit.co.za'
+  s.homepage = "http://jadeit.co.za"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # 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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud'
+  s.add_runtime_dependency 'logstash-mixin-aws'
+  s.add_runtime_dependency 'aws-sdk'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/cloudwatch_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-cloudwatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jurgens du Toit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !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: :runtime
+- !ruby/object:Gem::Dependency
+  name: stud
+  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: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-mixin-aws
+  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: :runtime
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  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: jrgns@jadeit.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/inputs/cloudwatch.rb
+- lib/logstash/inputs/test.rb
+- logstash-input-cloudwatch.gemspec
+- spec/inputs/cloudwatch_spec.rb
+homepage: http://jadeit.co.za
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Retrieve stats from AWS CloudWatch.
+test_files:
+- spec/inputs/cloudwatch_spec.rb