logstash-output-azure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 643c02ca977f51e3c3d19164538a677b91d958b1
+  data.tar.gz: fd88a6019475e526e997079941a71c7a48ec92a5
+SHA512:
+  metadata.gz: a175aafce0fe31532934d4c390a9fbfd58aafaaa635b9c59f5a4cbf2c9dabac1db6ca2145627b9c81537d6953914b6861c7c5974f5621aa9df5e0361c7260703
+  data.tar.gz: 96c2795dcb66d16f11676461d8a0f63604cf75b326c3c702f4e5575b49c967ed61d0a7462a68913bc48e476bb3ac0db30b40f9e53be6303cdc0e8e0a998de5ce

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:
+* Tuffk - tuffkmulhall@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-output-Logstash_Azure_Blob_Output
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'pry'

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,87 @@
+# Logstash Plugin
+[![Build Status](https://travis-ci.org/tuffk/Logstash-output-to-Azure-Blob.svg?branch=master)](https://travis-ci.org/tuffk/Logstash-output-to-Azure-Blob)
+
+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-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-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/logstash-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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/Logstash_Azure_Blob_Output.rb

@@ -0,0 +1,244 @@
+# encoding: utf-8
+
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'azure'
+require 'tmpdir'
+require 'pry'
+
+# An Logstash_Azure_Blob_Output output that does nothing.
+class LogStash::Outputs::LogstashAzureBlobOutput < LogStash::Outputs::Base
+  require 'logstash/outputs/blob/writable_directory_validator'
+  require 'logstash/outputs/blob/path_validator'
+  require 'logstash/outputs/blob/size_rotation_policy'
+  require 'logstash/outputs/blob/time_rotation_policy'
+  require 'logstash/outputs/blob/size_and_time_rotation_policy'
+  require 'logstash/outputs/blob/temporary_file'
+  require 'logstash/outputs/blob/temporary_file_factory'
+  require 'logstash/outputs/blob/uploader'
+  require 'logstash/outputs/blob/file_repository'
+
+  PREFIX_KEY_NORMALIZE_CHARACTER = "_"
+  PERIODIC_CHECK_INTERVAL_IN_SECONDS = 15
+  CRASH_RECOVERY_THREADPOOL = Concurrent::ThreadPoolExecutor.new({
+                                                                   :min_threads => 1,
+                                                                   :max_threads => 2,
+                                                                   :fallback_policy => :caller_runs
+                                                                 })
+
+  config_name 'azure'
+
+  # azure contianer
+  config :storage_account_name, valdiate: :string, required: false
+
+  # azure key
+  config :storage_access_key, valdiate: :string, required: false
+
+  # mamadas
+  config :size_file, validate: :number, default: 1024 * 1024 * 5
+  config :time_file, validate: :number, default: 15
+  config :restore, validate: :boolean, default: true
+  config :temporary_directory, validate: :string, default: File.join(Dir.tmpdir, 'logstash')
+  config :prefix, validate: :string, default: ''
+  config :upload_queue_size, validate: :number, default: 2 * (Concurrent.processor_count * 0.25).ceil
+  config :upload_workers_count, validate: :number, default: (Concurrent.processor_count * 0.5).ceil
+  config :rotation_strategy, validate: %w[size_and_time size time], default: 'size_and_time'
+  config :tags, :validate => :array, :default => []
+  config :encoding, :validate => ["none", "gzip"], :default => "none"
+
+  # elimindadas
+  # canned acl
+  # server side encryption
+  # server encryptopn algorithm
+  # ssekms
+  # storage class
+  # signature version
+  # tags
+  # encoding
+  # valdiate credentails on root
+
+  public
+
+  def register
+    unless @prefix.empty?
+      unless PathValidator.valid?(prefix)
+        raise LogStash::ConfigurationError, "Prefix must not contains: #{PathValidator::INVALID_CHARACTERS}"
+      end
+    end
+
+    unless WritableDirectoryValidator.valid?(@temporary_directory)
+      raise LogStash::ConfigurationError, "Logstash must have the permissions to write to the temporary directory: #{@temporary_directory}"
+    end
+
+    if @time_file.nil? && @size_file.nil? || @size_file == 0 && @time_file == 0
+      raise LogStash::ConfigurationError, 'at least one of time_file or size_file set to a value greater than 0'
+    end
+
+    @file_repository = FileRepository.new(@tags, @encoding, @temporary_directory)
+
+    @rotation = rotation_strategy
+
+    executor = Concurrent::ThreadPoolExecutor.new(min_threads: 1,
+                                                  max_threads: @upload_workers_count,
+                                                  max_queue: @upload_queue_size,
+                                                  fallback_policy: :caller_runs)
+
+    @uploader = Uploader.new(blob_contianer_resource, @logger, executor)
+
+    restore_from_crash if @restore
+    start_periodic_check if @rotation.needs_periodic?
+  end # def register
+
+  def multi_receive_encoded(events_and_encoded)
+    prefix_written_to = Set.new
+
+    events_and_encoded.each do |event, encoded|
+      prefix_key = normalize_key(event.sprintf(@prefix))
+      prefix_written_to << prefix_key
+
+      begin
+        @file_repository.get_file(prefix_key) { |file| file.write(encoded) }
+        # The output should stop accepting new events coming in, since it cannot do anything with them anymore.
+        # Log the error and rethrow it.
+      rescue Errno::ENOSPC => e
+        @logger.error('S3: No space left in temporary directory', temporary_directory: @temporary_directory)
+        raise e
+      end
+    end
+
+    # Groups IO calls to optimize fstat checks
+    rotate_if_needed(prefix_written_to)
+  end
+
+  def close
+    stop_periodic_check if @rotation.needs_periodic?
+
+    @logger.debug('Uploading current workspace')
+
+    # The plugin has stopped receiving new events, but we still have
+    # data on disk, lets make sure it get to S3.
+    # If Logstash get interrupted, the `restore_from_crash` (when set to true) method will pickup
+    # the content in the temporary directly and upload it.
+    # This will block the shutdown until all upload are done or the use force quit.
+    @file_repository.each_files do |file|
+      upload_file(file)
+    end
+
+    @file_repository.shutdown
+
+    @uploader.stop # wait until all the current upload are complete
+    @crash_uploader.stop if @restore # we might have still work to do for recovery so wait until we are done
+  end
+
+  def normalize_key(prefix_key)
+    prefix_key.gsub(PathValidator.matches_re, PREFIX_KEY_NORMALIZE_CHARACTER)
+  end
+
+  def upload_options
+    {
+    }
+  end
+
+  def start_periodic_check
+    @logger.debug("Start periodic rotation check")
+
+    @periodic_check = Concurrent::TimerTask.new(:execution_interval => PERIODIC_CHECK_INTERVAL_IN_SECONDS) do
+      @logger.debug("Periodic check for stale files")
+
+      rotate_if_needed(@file_repository.keys)
+    end
+
+    @periodic_check.execute
+  end
+
+  def stop_periodic_check
+    @periodic_check.shutdown
+  end
+
+  def blob_contianer_resource
+    azure_blob_service = Azure::Blob::BlobService.new
+    list = azure_blob_service.list_containers()
+    list.each do |item|
+      @container = item if item.name == "jaime-test-1"
+    end
+    azure_blob_service.create_container("jaime-test-1") unless @container
+  end
+
+  def rotate_if_needed(prefixes)
+    prefixes.each do |prefix|
+      # Each file access is thread safe,
+      # until the rotation is done then only
+      # one thread has access to the resource.
+      @file_repository.get_factory(prefix) do |factory|
+        temp_file = factory.current
+
+        if @rotation.rotate?(temp_file)
+          @logger.debug("Rotate file",
+                        :strategy => @rotation.class.name,
+                        :key => temp_file.key,
+                        :path => temp_file.path)
+
+          upload_file(temp_file)
+          factory.rotate!
+        end
+      end
+    end
+  end
+
+  def upload_file(temp_file)
+    @logger.debug("Queue for upload", :path => temp_file.path)
+
+    # if the queue is full the calling thread will be used to upload
+    temp_file.close # make sure the content is on disk
+    if temp_file.size > 0
+      @uploader.upload_async(temp_file,
+                             :on_complete => method(:clean_temporary_file),
+                             :upload_options => upload_options )
+    end
+  end
+
+
+  def rotation_strategy
+    case @rotation_strategy
+    when "size"
+      SizeRotationPolicy.new(size_file)
+    when "time"
+      TimeRotationPolicy.new(time_file)
+    when "size_and_time"
+      SizeAndTimeRotationPolicy.new(size_file, time_file)
+    end
+  end
+
+  def clean_temporary_file(file)
+    @logger.debug("Removing temporary file", :file => file.path)
+    file.delete!
+  end
+
+  def restore_from_crash
+    @crash_uploader = Uploader.new(blob_contianer_resource, @logger, CRASH_RECOVERY_THREADPOOL)
+
+    temp_folder_path = Pathname.new(@temporary_directory)
+    Dir.glob(::File.join(@temporary_directory, "**/*"))
+      .select { |file| ::File.file?(file) }
+      .each do |file|
+      temp_file = TemporaryFile.create_from_existing_file(file, temp_folder_path)
+      @logger.debug("Recovering from crash and uploading", :file => temp_file.path)
+      @crash_uploader.upload_async(temp_file, :on_complete => method(:clean_temporary_file), :upload_options => upload_options)
+    end
+  end
+
+
+  public
+
+  def receive(event)
+    azure_login
+    azure_blob_service = Azure::Blob::BlobService.new
+    containers = azure_blob_service.list_containers
+    blob = azure_blob_service.create_block_blob(containers[0].name, event.timestamp.to_s, event.to_json)
+  end # def event
+
+  def azure_login
+    Azure.config.storage_account_name ||= ENV['AZURE_STORAGE_ACCOUNT']
+    Azure.config.storage_access_key ||= ENV['AZURE_STORAGE_ACCESS_KEY']
+  end # def azure_login
+end # class LogStash::Outputs::LogstashAzureBlobOutput

data/lib/logstash/outputs/blob/file_repository.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+require "java"
+require "concurrent"
+require "concurrent/timer_task"
+require "logstash/util"
+
+ConcurrentHashMap = java.util.concurrent.ConcurrentHashMap
+
+module LogStash
+  module Outputs
+    class LogstashAzureBlobOutput
+      class FileRepository
+        DEFAULT_STATE_SWEEPER_INTERVAL_SECS = 60
+        DEFAULT_STALE_TIME_SECS = 15 * 60
+        # Ensure that all access or work done
+        # on a factory is threadsafe
+        class PrefixedValue
+          def initialize(file_factory, stale_time)
+            @file_factory = file_factory
+            @lock = Mutex.new
+            @stale_time = stale_time
+          end
+
+          def with_lock
+            @lock.synchronize {
+              yield @file_factory
+            }
+          end
+
+          def stale?
+            with_lock { |factory| factory.current.size == 0 && (Time.now - factory.current.ctime > @stale_time) }
+          end
+
+          def apply(prefix)
+            return self
+          end
+
+          def delete!
+            with_lock{ |factory| factory.current.delete! }
+          end
+        end
+
+        class FactoryInitializer
+          def initialize(tags, encoding, temporary_directory, stale_time)
+            @tags = tags
+            @encoding = encoding
+            @temporary_directory = temporary_directory
+            @stale_time = stale_time
+          end
+
+          def apply(prefix_key)
+            PrefixedValue.new(TemporaryFileFactory.new(prefix_key, @tags, @encoding, @temporary_directory), @stale_time)
+          end
+        end
+
+        def initialize(tags, encoding, temporary_directory,
+                       stale_time = DEFAULT_STALE_TIME_SECS,
+                       sweeper_interval = DEFAULT_STATE_SWEEPER_INTERVAL_SECS)
+          # The path need to contains the prefix so when we start
+          # logtash after a crash we keep the remote structure
+          @prefixed_factories =  ConcurrentHashMap.new
+
+          @sweeper_interval = sweeper_interval
+
+          @factory_initializer = FactoryInitializer.new(tags, encoding, temporary_directory, stale_time)
+
+          start_stale_sweeper
+        end
+
+        def keys
+          @prefixed_factories.keySet
+        end
+
+        def each_files
+          @prefixed_factories.elements.each do |prefixed_file|
+            prefixed_file.with_lock { |factory| yield factory.current }
+          end
+        end
+
+        # Return the file factory
+        def get_factory(prefix_key)
+          @prefixed_factories.computeIfAbsent(prefix_key, @factory_initializer).with_lock { |factory| yield factory }
+        end
+
+        def get_file(prefix_key)
+          get_factory(prefix_key) { |factory| yield factory.current }
+        end
+
+        def shutdown
+          stop_stale_sweeper
+        end
+
+        def size
+          @prefixed_factories.size
+        end
+
+        def remove_stale(k, v)
+          if v.stale?
+            @prefixed_factories.remove(k, v)
+            v.delete!
+          end
+        end
+
+        def start_stale_sweeper
+          @stale_sweeper = Concurrent::TimerTask.new(:execution_interval => @sweeper_interval) do
+            LogStash::Util.set_thread_name("LogstashAzureBlobOutput, Stale factory sweeper")
+
+            @prefixed_factories.forEach{|k,v| remove_stale(k,v)}
+          end
+
+          @stale_sweeper.execute
+        end
+
+        def stop_stale_sweeper
+          @stale_sweeper.shutdown
+        end
+      end
+    end
+  end
+end