tn_s3_file_uploader 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGRmOTk0YjUyZjhhMTE5MjU5MjNhZjBiNmFmYTAwYWI2YThmMTVjYw==
+  data.tar.gz: !binary |-
+    NmM5MWNhYzIyZDlhNGIzZjRjOWM0ZmM1MjViZGE4Zjg1N2Q5ODc5Zg==
+SHA512:
+  metadata.gz: !binary |-
+    MDhlMTJmNDFkZDU2YWNjZGI4M2JhZmYwZWRmOWMwZjc2ZmM4MjQ5M2U2M2I0
+    ZDczMDFiMGFhYzAzYTdmN2M2MTMyODRmNGJmZTRkYmNlZjNiNGFiZWRlMTQ1
+    NTdmNTZlYzE1NTc3MjJhMmE5MjFiZTQ3MDBmMjNjM2FmODQyMDg=
+  data.tar.gz: !binary |-
+    MzhmN2EzMWE3ZGZjOTM3Mzc2YTliNWZlYjZjMmVlN2MxZTNmMDJhYTEzZTdl
+    MTkwYjZhYTBmOWZjMTMwYzQ5NjlmZDc4Y2ExM2FiNmM2ODI5N2JkYzliZWYw
+    NmU4Yjg3YzI3ZTllNzRkZTFlMmM0YWJmNTZmYTBmNTUzYWQ4OGE=

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 Telenav, Inc.
+
+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,23 @@
+tn_s3_file_uploader
+===================
+
+Introduction
+------------
+tn_s3_file_uploader is an Amazon S3 file uploader that can build destination folder structures based on the timestamp and
+a number of other accepted substitutions.
+
+Getting started
+---------------
+Visit the [Getting started wiki page](https://github.com/ThinkNear/tn_s3_file_uploader/wiki/Getting-started)
+
+License
+-------
+See the `LICENSE.txt` file for license information.
+
+Contribute
+----------
+Visit the [Contribute wiki page](https://github.com/ThinkNear/tn_s3_file_uploader/wiki/Contribute)
+
+Questions? Problems? New Requests?
+----------------------------------
+Visit the [Troubleshooting wiki page](https://github.com/ThinkNear/tn_s3_file_uploader/wiki/Troubleshooting)

data/bin/tn_s3_file_uploader

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'tn_s3_file_uploader'
+
+# Executable - usage tn_s3_file_uploader --input-file-pattern='<<pattern matching file to be uploaded>>'
+# --s3-output-pattern=<<S3 destination folder>>
+#
+# e.g. tn_s3_file_uploader --input-file-pattern='/etc/sonarqube/logs/*.log'
+# --s3-output-pattern=bucket/sonarqube/%{file-extension}/y=%Y/m=%m/d=%d/h=%H/%{file-name}.%{file-extension}
+options = TnS3FileUploader::CliParser.new.parse_cmd_line(ARGV)
+TnS3FileUploader::Runner.new(options).run
+

data/lib/tn_s3_file_uploader/cli_parser.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+
+module TnS3FileUploader
+
+  class CliParser
+
+    # Parses the CLI parameters and returns them in a hash
+    # Parameters 'host-unique-id', 'log-file-pattern', 's3-dest-folder' and 'partition-pattern' are mandatory and
+    # a missing argument exception will be raised if any of them is not provided
+    def parse_cmd_line(args)
+      options = {}
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: tn_s3_file_uploader.rb [options]"
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        opts.on("-s", "--input-file-pattern INPUT_FILE_PATTERN", "The file pattern to match the source log file") do |file_pattern|
+          options[:input_file_pattern] = file_pattern
+        end
+
+        opts.on("-o", "--s3-output-pattern S3_OUTPUT_PATTERN", "The S3 destination pattern name."\
+            "It accepts macros for building the resulting filename and folder structure. See documentation for details") do |s3_output_pattern|
+          options[:s3_output_pattern] = s3_output_pattern
+        end
+
+        options[:file_timestamp_resolution] = 300
+        opts.on("--file-timestamp-resolution RES", Integer, "The resolution of the destination filename in seconds (positive non-zero integer)") do |file_timestamp_resolution|
+          if valid_seconds?(file_timestamp_resolution)
+            options[:file_timestamp_resolution] = file_timestamp_resolution
+          else
+            puts "Warning: negative seconds value given: #{file_timestamp_resolution}, defaulting to 300 (5 minutes)"
+          end
+        end
+
+        opts.on("--honeybadger-api-key API-KEY", "API key for optional honeybadger error reporting support") do |honeybadger_api_key|
+          options[:honeybadger_api_key] = honeybadger_api_key
+        end
+
+        opts.on("--aws-access-key-id AWS-ACCESS-KEY-ID", "Provide the AWS access key id.") do |aws_access_key_id|
+          options[:aws_access_key_id] = aws_access_key_id
+        end
+
+        opts.on("--aws-secret-access-key AWS-SECRET-ACCESS-KEY", "Provide the AWS secret access key") do |aws_secret_access_key|
+          options[:aws_secret_access_key] = aws_secret_access_key
+        end
+
+        opts.on("-v", "--verbose", "Display verbose output") do |v|
+          options[:verbose] = !v.nil?
+        end
+
+        opts.separator ""
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit!
+        end
+      end
+
+      opts.parse! args
+
+      check_mandatory options
+
+      options
+    end
+
+    private
+
+    def check_mandatory(options)
+      mandatory_arguments = [:input_file_pattern, :s3_output_pattern]
+
+      missing_arguments = []
+      mandatory_arguments.each do |arg|
+        missing_arguments << arg.to_s.gsub!('_', '-') if options[arg].nil?
+      end
+
+      unless missing_arguments.empty?
+        raise OptionParser::MissingArgument,
+              "The following mandatory options are missing: #{ missing_arguments.join(', ') }"
+      end
+    end
+
+    def valid_seconds?(seconds)
+      seconds > 0
+    end
+
+  end
+
+end

data/lib/tn_s3_file_uploader/error_reporting/error_report_manager.rb

@@ -0,0 +1,35 @@
+require 'singleton'
+require 'tn_s3_file_uploader/error_reporting/log_error_reporter'
+
+module TnS3FileUploader
+
+  # Singleton that instruments all error reporters.
+  # Register your error reporter by calling `ErrorReportManager.instance.register_error_reporter`
+  # error reporters provided have to specify a method with name `report_error`
+  class ErrorReportManager
+    include Singleton
+
+    def initialize
+      @error_reporters = []
+    end
+
+    def register_error_reporter(error_reporter)
+      unless error_reporter.respond_to?(:report_error)
+        raise ArgumentError, 'Provided error_reporter instance does not support the report_error method'
+      end
+
+      @error_reporters << error_reporter
+    end
+
+    def count_error_reporters
+      @error_reporters.count
+    end
+
+    def report_error(exception, options = {})
+      @error_reporters.each do |error_reporter|
+        error_reporter.report_error(exception, options)
+      end
+    end
+  end
+
+end

data/lib/tn_s3_file_uploader/error_reporting/honeybadger_error_reporter.rb

@@ -0,0 +1,20 @@
+require 'honeybadger'
+
+module TnS3FileUploader
+
+  # Error reporter that uses Honeybadger service to report errors
+  class HoneybadgerErrorReporter
+
+    # Configure honeybadger with provided api-key. Assumes api-key is not null
+    def initialize(api_key)
+      Honeybadger.configure do |config|
+        config.api_key = api_key
+      end
+    end
+
+    def report_error(exception, options = {})
+      Honeybadger.notify(exception, options)
+    end
+  end
+
+end

data/lib/tn_s3_file_uploader/error_reporting/log_error_reporter.rb

@@ -0,0 +1,17 @@
+module TnS3FileUploader
+
+  # Simple error reporter that logs exception message and backtrace to stdout
+  class LogErrorReporter
+
+    def initialize(output)
+      @output = output
+    end
+
+    def report_error(exception, options ={} )
+      @output.puts options
+      @output.puts exception.message
+      @output.puts exception.backtrace.join("\n")
+    end
+  end
+
+end

data/lib/tn_s3_file_uploader/file_path_generator.rb

@@ -0,0 +1,96 @@
+require 'rubygems'
+
+module TnS3FileUploader
+
+  # Examples
+  # partition = y=2014/m=06/d=18/h=18
+  # minute_partition = 45
+  # file_timestamp = 20140618184502
+  # date = Wed Jun 18 18:50:02 UTC 2014
+
+  # [ec2-user@ip-10-185-180-243 tmp]$ ./time.sh
+  # partition = y=2014/m=06/d=18/h=18
+  # minute_partition = 55
+  # file_timestamp = 20140618185540
+  # date = Wed Jun 18 19:03:40 UTC 2014
+  class FilePathGenerator
+
+    def initialize(time, options)
+      #Find the last rotation window
+      @options = options
+      @time = previous_rotation_window(time)
+    end
+
+
+    # Makes datetime and macro substitutions for input file 'file', based on the s3_output_pattern option
+    # Assumes input file 'file' and s3_output_pattern option are both valid.
+    # This method removes the bucket (everything until the first '/', including the '/') from the s3_output_pattern
+    # while applying the datetime/macro/substitutions
+    def dest_full_path_for(file)
+
+      output_file_pattern = remove_bucket(@options[:s3_output_pattern])
+
+      # Time#strftime is removing '%' characters on our macros. Our macro substitution must run first
+      subs = build_substitutions(file)
+      replace_macros!(output_file_pattern, subs)
+
+      substitute_datetime_macros(output_file_pattern)
+    end
+
+    private
+
+    def remove_bucket(output_file_pattern)
+      output_file_pattern.split('/')[1..-1].join('/')
+    end
+
+    # Makes the datetime substitutions on the give s3_output_pattern option
+    # For example:
+    #  Given s3_output_pattern y=%Y/m=%m/d=%d/h=%H
+    #  and time: Thu Jun 12 23:57:49 UTC 2014
+    #  it will produce the following folder structure: y=2014/m=06/d=12/h=23
+    def substitute_datetime_macros(output_pattern)
+      @time.strftime(output_pattern)
+    end
+
+    # Generates rounded off timestamp based on rotation_seconds
+    def generate_file_timestamp
+      @time.strftime('%Y%m%d%H%M%S')
+    end
+
+    def replace_macros!(output_file_pattern, subs)
+      subs.each do |macro, sub|
+        output_file_pattern.gsub!(macro, sub)
+      end
+    end
+
+    def build_substitutions(file)
+      file_components = file.split('/').last.split('.')
+
+      if file_components.size == 1
+        file_name = file_components[0]
+        file_extension = ''
+      else
+        file_name = file_components[0..-2].join('.')
+        file_extension = file_components.last
+      end
+
+      ip_address = IPSocket.getaddress(Socket.gethostname).gsub('.', '-')
+      file_timestamp = generate_file_timestamp
+
+      {
+          '%{file-name}' => file_name,
+          '%{file-timestamp}' => file_timestamp,
+          '%{file-extension}' => file_extension,
+          '%{ip-address}' => ip_address
+      }
+    end
+
+    def previous_rotation_window(time)
+      rotation_seconds = @options[:file_timestamp_resolution]
+      t = time - rotation_seconds
+      floored_seconds = (t.to_f / rotation_seconds).floor * rotation_seconds
+      Time.at(floored_seconds).utc
+    end
+  end
+
+end

data/lib/tn_s3_file_uploader/log_uploader.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'tn_s3_file_uploader/s3'
+require 'tn_s3_file_uploader/file_path_generator'
+
+module TnS3FileUploader
+
+  class LogUploader
+
+    # Initialisation block
+    # Params:
+    # ::s3:: - S3 wrapper
+    def initialize(s3)
+      raise ArgumentError, "s3 client cannot be nil" if s3 == nil
+      @s3 = s3
+    end
+
+    # Uploads all (log) files that options[:input_file_pattern] matches to an S3 location
+    # based on the value of options[:s3_output_pattern]
+    # options[:input_file_pattern] should match at least one local file
+    # options[:s3_output_pattern] should contain the bucket, folder and destination filename
+    def upload_log_files(options)
+      raise ArgumentError, 's3_output_pattern cannot be empty' if blank?(options[:s3_output_pattern])
+      bucket = check_bucket_dest_path(options[:s3_output_pattern])
+      log_files = check_log_file(options[:input_file_pattern])
+
+      now = Time.now.utc
+      file_path_generator = FilePathGenerator.new(now, options)
+
+      log_files.each do |log_file|
+        destination_full_path = file_path_generator.dest_full_path_for(log_file)
+
+        puts "Found log file #{ log_file }, formatting file name for upload to S3 bucket #{ bucket } into folder #{ destination_full_path }"
+
+        # Note no leading or trailing slashes - this will break the upload to S3 (see our s3.rb)
+        @s3.upload_file(log_file, bucket, destination_full_path)
+      end
+
+    end
+
+    private
+    def check_log_file(log_file_pattern)
+      raise ArgumentError, 'log file pattern cannot be nil' if log_file_pattern == nil
+
+      last_folder_separator = log_file_pattern.rindex('.')
+      raise ArgumentError, "#{ log_file_pattern } is not a valid path. It lacks a file extension." if last_folder_separator == nil
+
+      files = Dir[log_file_pattern].entries
+      raise ArgumentError, "#{ log_file_pattern } did not match any files." if files.empty?
+
+      files
+    end
+
+    def check_bucket_dest_path(bucket_dest_path)
+      path_components = bucket_dest_path.split('/')
+      raise ArgumentError, "Bucket destination folder #{ bucket_dest_path } must have at least two path components, e.g. my/path." unless path_components.size > 1
+      path_components.first
+    end
+
+    def blank?(str)
+      str.nil? || str == ""
+    end
+  end
+
+end

data/lib/tn_s3_file_uploader/runner.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'aws-sdk'
+require 'honeybadger'
+require 'tn_s3_file_uploader/log_uploader'
+
+module TnS3FileUploader
+  class Runner
+
+    def initialize(options)
+      @options = options
+      @error_report_manager = ErrorReportManager.instance
+    end
+
+    def run
+      add_log_error_reporter
+      add_honeybadger
+      puts "Running TnS3FileUploader..." if @options[:verbose]
+
+      upload
+    rescue Exception => e
+      @error_report_manager.report_error(e, { :options => @options } )
+    end
+
+    private
+
+    def upload
+      if @options[:verbose]
+        puts "Using:"
+        puts "log file pattern = #{ @options[:input_file_pattern] }"
+        puts "s3 dest folder = #{ @options[:s3_output_pattern] }"
+        puts "file timestamp resolution = #{ options[:file_timestamp_resolution] }"
+      end
+
+      s3_client = create_s3_client
+      s3 = S3.new(s3_client)
+
+      log_uploader = LogUploader.new(s3)
+      log_uploader.upload_log_files(@options)
+    end
+
+    def create_s3_client
+      if @options[:aws_access_key_id].nil? && @options[:aws_secret_access_key].nil?
+        AWS::S3.new
+      else
+        AWS::S3.new(
+            :access_key_id => @options[:aws_access_key_id],
+            :secret_access_key => @options[:aws_secret_access_key]
+        )
+      end
+    end
+
+    def add_log_error_reporter
+      @error_report_manager.register_error_reporter(LogErrorReporter.new(STDOUT))
+    end
+
+    def add_honeybadger
+      unless @options[:honeybadger_api_key].nil?
+        honeybadger_error_reporter = HoneybadgerErrorReporter.new(@options[:honeybadger_api_key])
+        @error_report_manager.register_error_reporter(honeybadger_error_reporter)
+      end
+    end
+
+  end
+end

data/lib/tn_s3_file_uploader/s3.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+gem 'aws-sdk'
+require 'aws-sdk'
+require 'honeybadger'
+require 'tn_s3_file_uploader/file_path_generator'
+module TnS3FileUploader
+
+  class S3
+
+    MAX_RETRIES = 2
+
+    def initialize(s3_client)
+      @s3_client = s3_client
+    end
+
+    # File must be fully qualified
+    # bucket is just string name, no slashes
+    # dest_path is fully qualified path to file on S3 including folders - NO leading or trailing slashes or
+    # it won't work!
+    def upload_file(file, bucket, dest_path)
+      raise ArgumentError, "file cannot be nil" if file == nil
+      raise ArgumentError, "bucket cannot be nil" if bucket == nil
+      raise ArgumentError, "dest_path cannot be nil" if dest_path == nil
+
+      file_path = Pathname.new(file)
+      raise ArgumentError, "#{file} is not a valid file" unless file_path.exist? && file_path.file?
+
+      upload(bucket, dest_path, file)
+    end
+
+    private
+    def upload(bucket, dest_full_path, file, retry_count = 0)
+      begin
+        s3_bucket = @s3_client.buckets[bucket]
+        s3_file_path = s3_bucket.objects[dest_full_path]
+
+        puts "Uploading file #{file} to S3 bucket #{bucket} and path #{dest_full_path}"
+
+        s3_file_path.write(File.open(file, 'rb'))
+      rescue StandardError, Timeout::Error => e
+        if retry_count < MAX_RETRIES
+          #This fixes a bug where the credentials may have rotated on the EC2 instance but the old values
+          #are still cached
+          sleep 1
+          @s3_client.config.credential_provider.refresh
+          upload(bucket, dest_full_path, file, retry_count + 1)
+        else
+          raise e
+        end
+      end
+    end
+
+  end
+
+end

data/lib/tn_s3_file_uploader/version.rb

@@ -0,0 +1,3 @@
+module TnS3FileUploader
+  VERSION = '0.1.0'
+end

data/lib/tn_s3_file_uploader.rb

@@ -0,0 +1,9 @@
+require 'tn_s3_file_uploader/runner'
+require 'tn_s3_file_uploader/cli_parser'
+require 'tn_s3_file_uploader/file_path_generator'
+require 'tn_s3_file_uploader/log_uploader'
+require 'tn_s3_file_uploader/s3'
+
+require 'tn_s3_file_uploader/error_reporting/error_report_manager'
+require 'tn_s3_file_uploader/error_reporting/honeybadger_error_reporter'
+require 'tn_s3_file_uploader/error_reporting/log_error_reporter'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: tn_s3_file_uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thinknear.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.35'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.35'
+description: S3 file uploader that can build folder structures based on timestamp.
+  Typically used in conjunction with Unix's logrotate.
+email: opensource@thinknear.com
+executables:
+- tn_s3_file_uploader
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/tn_s3_file_uploader
+- lib/tn_s3_file_uploader.rb
+- lib/tn_s3_file_uploader/cli_parser.rb
+- lib/tn_s3_file_uploader/error_reporting/error_report_manager.rb
+- lib/tn_s3_file_uploader/error_reporting/honeybadger_error_reporter.rb
+- lib/tn_s3_file_uploader/error_reporting/log_error_reporter.rb
+- lib/tn_s3_file_uploader/file_path_generator.rb
+- lib/tn_s3_file_uploader/log_uploader.rb
+- lib/tn_s3_file_uploader/runner.rb
+- lib/tn_s3_file_uploader/s3.rb
+- lib/tn_s3_file_uploader/version.rb
+homepage: http://www.thinknear.com
+licenses:
+- Copyright (c) ThinkNear 2014, Licensed under APLv2.0
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: S3 file uploader
+test_files: []