logstash-input-gcp_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9ad9a52f0a8f869cd976ce24a2f69f914d3e0e5179b605d9adce037563e01a1
+  data.tar.gz: 6cd20be8e3b29575d80e09bd7e6e5eb71d31188a8de11952a3fb30d6699d392c
+SHA512:
+  metadata.gz: adf4a10f98616f47b563de4c5e9c07438dc35310ac4a6edeb516c53e626e0e90d28515fbb5fcfa7b250da4c3e2659dbce43dcc126dca87304dba4cb9d62171f1
+  data.tar.gz: b63e572f9d38f8c1b31972f664938d222300ffcda1dc9a8d6d5bcf5ad59ce1a743122e37ba4ebf08526d6780a8f812162d2c2206ae43e437c7a75f6fdc7e4dce

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+*jashchahal - jashchahal@gmail.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-google_cloud_storage
+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'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+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/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.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/elastic/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-input-awesome", :path => "/your/local/logstash-input-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'input {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-input-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-input-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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/google_cloud_storage.rb

@@ -0,0 +1,432 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+
+# Generate a repeating message.
+#
+# This plugin is intented only as an example.
+
+class LogStash::Inputs::GoogleCloudStorage < LogStash::Inputs::Base
+  config_name "google_cloud_storage"
+  default :codec, "plain"
+
+  config :project
+
+  # Path to JSON file containing the Service Account credentials (not needed when running inside GCE)
+  config :keyfile
+
+  # GCS private key password.
+  config :key_password, :validate => :string, :default => "notasecret"
+  #GCS service account
+  config :service_account, :validate => :string, :required => true
+
+  # The name of the GCS bucket.
+  config :bucket, :validate => :string, :required => true
+
+  # If specified, the prefix of filenames in the bucket must match (not a regexp)
+  config :prefix, :validate => :string, :default => nil
+
+  # Where to write the since database (keeps track of the date
+  # the last handled file was added to S3). 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
+
+  # Name of a GCS bucket to backup processed files to.
+  config :backup_to_bucket, :validate => :string, :default => nil
+
+  # Append a prefix to the key (full path including file name in gcs) after processing.
+  # If backing up to another (or the same) bucket, this effectively lets you
+  # choose a new 'folder' to place the files in
+  config :backup_add_prefix, :validate => :string, :default => nil
+
+  # Path of a local directory to backup processed files to.
+  config :backup_to_dir, :validate => :string, :default => nil
+
+  # Whether to delete processed files from the original bucket.
+  config :delete, :validate => :boolean, :default => false
+
+  # Interval to wait between to check the file list again after a run is finished.
+  # Value is in seconds.
+  config :interval, :validate => :number, :default => 60
+
+  # Ruby style regexp of keys to exclude from the bucket
+  config :exclude_pattern, :validate => :string, :default => nil
+
+  # Set the directory where logstash will store the tmp files before processing them.
+  # default to the current OS temporary directory in linux /tmp/logstash
+  config :temporary_directory, :validate => :string, :default => File.join(Dir.tmpdir, "logstash")
+
+
+  public
+  def register
+    @host = Socket.gethostname
+
+    require "fileutils"
+    require "digest/md5"
+    require "google/api_client"
+    require "openssl"
+
+    @logger.debug("Registering GCS input", :bucket => @bucket, :project => @project, :keyfile => @keyfile)
+    # initialize_google_client
+    @logger.info ("\n===========================GCS INPUT PLUG-IN===========================")
+    @client = Google::APIClient.new(:application_name =>
+                                        'Logstash Google Cloud Storage input plugin',
+                                    :application_version => '0.1')
+
+    key = Google::APIClient::PKCS12.load_key(@keyfile, @key_password)
+    service_account = Google::APIClient::JWTAsserter.new(@service_account,
+                                                         'https://www.googleapis.com/auth/devstorage.read_write',
+                                                         key)
+    @client.authorization = service_account.authorize
+    @gcs = @client.discovered_api('storage', 'v1')
+
+
+    unless @backup_to_dir.nil?
+      Dir.mkdir(@backup_to_dir, 0700) unless File.exists?(@backup_to_dir)
+    end
+
+    FileUtils.mkdir_p(@temporary_directory) unless Dir.exist?(@temporary_directory)
+  end # def register
+
+  def run(queue)
+    @current_thread = Thread.current
+    Stud.interval(@interval) do
+      process_files(queue)
+    end
+  end # def run
+
+
+
+  public
+  def list_new_files
+
+
+    @logger.debug("GCS input: Polling new objects from bucket "+ @bucket)
+
+    objects = @client.execute(
+        api_method: @gcs.objects.list,
+        parameters: {bucket: @bucket}
+    )
+
+    logFiles = {}
+
+    objects.data.items.each do |file|
+
+      unless ignore_filename?(file.name)
+        if sincedb.newer?(file.updated)
+          logFiles[file.name] = file.updated
+          @logger.info("GCS input: Adding to objects[]", :name => file.name)
+          @logger.debug("GCS input: objects[] length is: ", :length => logFiles.length)
+        end
+      end
+
+    end
+
+
+    return logFiles.keys.sort {|a,b| logFiles[a] <=> logFiles[b]}
+  end # def fetch_new_files
+
+
+
+
+  public
+  def backup_to_bucket(filename)
+    unless @backup_to_bucket.nil?
+      backup_key = "#{@backup_add_prefix}#{filename}"
+
+      @logger.debug ("GCS input: bck_up object " + backup_key)
+
+      result = @client.execute(
+          api_method: @gcs.objects.copy,
+          parameters: {destinationBucket: @backup_to_bucket, destinationObject:backup_key, sourceBucket: @bucket, sourceObject: filename }
+      )
+
+      if @delete
+        result = @client.execute(
+            api_method: @gcs.objects.delete,
+            parameters: { bucket: @bucket, object: filename }
+        )
+      end
+    end
+  end
+
+  public
+  def backup_to_dir(filename)
+    unless @backup_to_dir.nil?
+      FileUtils.cp(filename, @backup_to_dir)
+    end
+  end
+
+
+  public
+  def process_files(queue)
+    objects = list_new_files
+
+    objects.each do |filename|
+      if stop?
+        break
+      else
+        @logger.debug("GCS input: processing ", :bucket => @bucket, :filename => filename)
+        process_log(queue, filename)
+      end
+    end
+  end # def process_files
+
+
+
+  public
+  def stop
+    # @current_thread is initialized in the `#run` method,
+    # this variable is needed because the `#stop` is a called in another thread
+    # than the `#run` method and requiring us to call stop! with a explicit thread.
+    Stud.stop!(@current_thread)
+  end
+
+
+  private
+
+  # Read the content of the local file
+  #
+  # @param [Queue] Where to push the event
+  # @param [String] Which file to read from
+  # @return [Boolean] True if the file was completely read, false otherwise.
+  def process_local_log(queue, filename, key)
+    @logger.debug('GCS input: processing file ', :filename => filename)
+    metadata = {}
+    # Currently codecs operates on bytes instead of stream.
+    # So all IO stuff: decompression, reading need to be done in the actual
+    # input and send as bytes to the codecs.
+    read_file(filename) do |line|
+      if stop?
+        @logger.warn("Logstash GCS input, stop reading in the middle of the file, we will read it again when logstash is started")
+        return false
+      end
+
+      @codec.decode(line) do |event|
+        # We are making an assumption concerning cloudfront
+        # log format, the user will use the plain or the line codec
+        # and the message key will represent the actual line content.
+        # If the event is only metadata the event will be drop.
+        # This was the behavior of the pre 1.5 plugin.
+        #
+        # The line need to go through the codecs to replace
+        # unknown bytes in the log stream before doing a regexp match or
+        # you will get a `Error: invalid byte sequence in UTF-8'
+        #if event_is_metadata?(event)
+        #  @logger.debug('Event is metadata, updating the current cloudfront metadata', :event => event)
+        #  update_metadata(metadata, event)
+        #else
+
+          event.set("[@metadata][gcs]", { "key" => key })
+          event.set("[@metadata][host]", @host)
+          decorate(event)
+          queue << event
+        ##end
+      end
+    end
+
+    return true
+  end # def process_local_log
+
+
+  private
+  def event_is_metadata?(event)
+    return false unless event.get("message").class == String
+    line = event.get("message")
+    version_metadata?(line) || fields_metadata?(line)
+  end
+
+  private
+  def version_metadata?(line)
+    line.start_with?('#Version: ')
+  end
+
+  private
+  def fields_metadata?(line)
+    line.start_with?('#Fields: ')
+  end
+
+  private
+  def update_metadata(metadata, event)
+    line = event.get('message').strip
+
+    if version_metadata?(line)
+      metadata[:cloudfront_version] = line.split(/#Version: (.+)/).last
+    end
+
+    if fields_metadata?(line)
+      metadata[:cloudfront_fields] = line.split(/#Fields: (.+)/).last
+    end
+  end
+
+  private
+  def read_file(filename, &block)
+    if gzip?(filename)
+      read_gzip_file(filename, block)
+    else
+      read_plain_file(filename, block)
+    end
+  end
+
+  def read_plain_file(filename, block)
+    File.open(filename, 'rb') do |file|
+      file.each(&block)
+    end
+  end
+
+  private
+  def read_gzip_file(filename, block)
+    # Details about multiple streams and the usage of unused from: http://code.activestate.com/lists/ruby-talk/11168/
+    File.open(filename) do |zio|
+      while true do
+        io = Zlib::GzipReader.new(zio)
+        io.each_line { |line| block.call(line) }
+        unused = io.unused
+        io.finish
+        break if unused.nil?
+        zio.pos -= unused.length # reset the position to the other block in the stream
+      end
+    end
+  rescue Zlib::Error, Zlib::GzipFile::Error => e
+    @logger.error("Gzip codec: We cannot uncompress the gzip file", :filename => filename)
+    raise e
+  end
+
+  private
+  def gzip?(filename)
+    filename.end_with?('.gz')
+  end
+
+  private
+  def sincedb
+    @sincedb ||= if @sincedb_path.nil?
+                   @logger.debug("Using default generated file for the sincedb", :filename => sincedb_file)
+                   SinceDB::File.new(sincedb_file)
+                 else
+                   @logger.debug("Using the provided sincedb_path",
+                                :sincedb_path => @sincedb_path)
+                   SinceDB::File.new(@sincedb_path)
+                 end
+  end
+
+  private
+  def sincedb_file
+    File.join(ENV["HOME"], ".sincedb_" + Digest::MD5.hexdigest("#{@bucket}+#{@prefix}"))
+  end
+
+  private
+  def ignore_filename?(filename)
+    if @prefix == filename
+      return true
+    elsif filename.end_with?("/")
+      return true
+    elsif (@backup_add_prefix && @backup_to_bucket == @bucket && filename =~ /^#{backup_add_prefix}/)
+      return true
+    elsif @exclude_pattern.nil?
+      return false
+    elsif filename =~ Regexp.new(@exclude_pattern)
+      return true
+    else
+      return false
+    end
+  end
+
+  private
+  def process_log(queue, key)
+
+    object = @client.execute(
+        api_method: @gcs.objects.get,
+        parameters: {bucket: @bucket, object: key}
+    )
+
+    objectdata = @client.execute(
+        api_method: @gcs.objects.get,
+        parameters: {bucket: @bucket, object: key, alt: 'media'}
+    )
+
+
+    filename = File.join(temporary_directory, File.basename(key))
+
+    if download_remote_file(objectdata.body, filename)
+
+      if process_local_log(queue, filename, key)
+        lastmod = object.data['updated']
+        backup_to_bucket(key)
+        backup_to_dir(filename)
+        delete_file_from_bucket(key)
+        FileUtils.remove_entry_secure(filename, true)
+        sincedb.write(lastmod)
+
+      end
+    else
+      FileUtils.remove_entry_secure(filename, true)
+    end
+  end
+
+  private
+  # Stream the remove file to the local disk
+  #
+  # @param [GCS_OBJECT] Data from GCS object to download
+  # @param [String] The Temporary filename to stream to.
+  # @return [Boolean] True if the file was completely downloaded
+  def download_remote_file(remote_object, local_filename)
+    completed = false
+
+    ##TODO NEED CHANGE IN WRITE LOGIC TO AVOID MEMORY ISSUES
+
+    File.open(local_filename, 'wb') { |file| file.write(remote_object) }
+    completed = true
+
+    return completed
+  end
+
+  private
+  def delete_file_from_bucket(object)
+    if @delete and @backup_to_bucket.nil?
+      object.delete()
+    end
+  end
+
+
+
+  private
+  module SinceDB
+    class File
+      def initialize(file)
+        @sincedb_path = file
+      end
+
+      def newer?(date)
+         date.to_i > read.to_i
+      end
+
+      def read
+        if ::File.exists?(@sincedb_path)
+          content = ::File.read(@sincedb_path).chomp.strip
+          # If the file was created but we didn't have the time to write to it
+          return content.empty? ? Time.new(0) : Time.parse(content)
+        else
+          return Time.new(0)
+        end
+      end
+
+      def write(since = nil)
+        since = Time.now() if since.nil?
+        ::File.open(@sincedb_path, 'w') { |file| file.write(since.to_s) }
+      end
+    end
+  end
+end # class LogStash::Inputs::GoogleCloudStorage
+
+
+###  my other snippets :: jaspaul ::
+# # List all buckets in the project
+# bucket_list_result = @client.execute(
+#     api_method: @gcs.buckets.list,
+#     parameters: {project: @project}
+# )
+#
+# @logger.info(" buckets body: " + bucket_list_result.body)

data/logstash-input-google_cloud_storage.gemspec

@@ -0,0 +1,28 @@
+
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-gcp_storage'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary         = "plugin to read log events from Google Cloud Storage (GCS)"
+  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"
+  s.authors       = ['Jaspaul Chahal','daniel']
+  s.email         = 'jashchahal@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  # 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-plugin-api", "~> 1.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'mime-types', '~> 2' # last version compatible with ruby 2.x
+
+  s.add_runtime_dependency 'stud'
+  # s.add_runtime_dependency 'google-cloud-storage'
+  s.add_runtime_dependency 'google-api-client', '~> 0.8.7' # version 0.9.x works only with ruby 2.x
+end

data/spec/inputs/google_cloud_storage_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/google_cloud_storage"
+
+describe LogStash::Inputs::GoogleCloudStorage do
+
+let(:client) { double("google-client") }
+  let(:service_account) { double("service-account") }
+  let(:key)    { "key" }
+
+  before(:each) do
+    allow(Google::APIClient).to receive(:new).and_return(client)
+    allow(client).to receive(:discovered_api).with("storage", "v1")
+    allow(Google::APIClient::PKCS12).to receive(:load_key).with("", "notasecret").and_return(key)
+    allow(Google::APIClient::JWTAsserter).to receive(:new).and_return(service_account)
+    allow(client).to receive(:authorization=)
+    allow(service_account).to receive(:authorize)
+  end
+
+
+  it "should register without errors" do
+    plugin = LogStash::Plugin.lookup("input", "google_cloud_storage").new({"bucket" => "", "key_path" => "", "service_account" => ""})
+    expect { plugin.register }.to_not raise_error
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-gcp_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaspaul Chahal
+- daniel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  name: mime-types
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  name: google-api-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+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
+email: jashchahal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/google_cloud_storage.rb
+- logstash-input-google_cloud_storage.gemspec
+- spec/inputs/google_cloud_storage_spec.rb
+homepage:
+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.6.13
+signing_key:
+specification_version: 4
+summary: plugin to read log events from Google Cloud Storage (GCS)
+test_files:
+- spec/inputs/google_cloud_storage_spec.rb