bricolage-streamingload 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c74f043409945f4dc970472a1a7735c67a7ba930
-  data.tar.gz: 9ce73867f02aff49a7391d168c791ce4be4d3727
+SHA256:
+  metadata.gz: 8f3e8cfb62766f9de7ef2ff91a8b9a7defce6403560338973734af68422d2fcb
+  data.tar.gz: 359732332455a7db82c20cb3ebc2ccfcdc830d35595dfdae7b515e57cafd77ac
 SHA512:
-  metadata.gz: 4a6a1a3c6fbb28d1048481072596fc944e0732218bcddfd09dd9555a4d0a43b900f7806627c2f4ec4685b36cbf3a93ded8b173bd7a75917d652bef7d7a6a0739
-  data.tar.gz: ffa357b2233b11b9820ffeda35480c74a328904d531a1f67b716fc115d584979e4eff2332239c557179687121527d3e38c90afcc02d102b4e9a3f1e3fe12de70
+  metadata.gz: 80365541531153a42be70362e04e8d6ee89eb639df4d9fcfb899c95e6516b92be8ac81e9b1da27acb14f919e5d2abdc408ebe2e75460c65063e01b1e7b718418
+  data.tar.gz: c90d2c27285681a950bb1d95c076a83bbd95cbb0863651e1b26ab0f12690ee58da8b5759187f65a8cc883fc4ea680c76706fa337a93d5011a58ea9bec7a60e83

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+
+/config/development/
+/config/test/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    bricolage-streamingload (0.16.1)
+      aws-sdk-s3 (~> 1.8)
+      aws-sdk-sqs (~> 1.3)
+      bricolage (~> 5.30)
+      pg (~> 0.18.0)
+      sentry-raven (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.1.0)
+    aws-partitions (1.351.0)
+    aws-sdk-core (3.104.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.75.0)
+      aws-sdk-core (~> 3, >= 3.104.1)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sns (1.28.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sqs (1.30.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    bricolage (5.30.0)
+      aws-sdk-s3 (~> 1)
+      aws-sdk-sns (~> 1)
+      pg (~> 0.18.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    jmespath (1.4.0)
+    multipart-post (2.1.1)
+    pg (0.18.4)
+    power_assert (1.1.3)
+    rake (12.3.3)
+    sentry-raven (3.0.0)
+      faraday (>= 1.0)
+    test-unit (3.2.8)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bricolage-streamingload!
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.17.2

data/LICENSES

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 Minero Aoki, Shimpei Kodama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/RELEASE.md

@@ -0,0 +1,135 @@
+# Bricolage Streaming Load Release Note
+
+## version 0.17.0
+
+- [new] Introduces Sentry error reporting.  Define SENTRY_DSN environment variable to enable it.
+
+## version 0.16.1
+
+- [fix] Stop retrying after 2 times retried (total 3 trial).
+
+## version 0.16.0
+
+- [new] Retry for also error tasks, not only failure tasks.
+  Error tasks are assumed as "non-retriable" e.g. DB login error, but some of them are really able to be resolved
+  by retrying on ECS environment. Retrying is not expensive (and human operation is relatively expensive),
+  we'll retry on all failures and errors.
+
+## version 0.15.2
+
+- [fix] send-data-event: Send objectSize=0 to indicate this message is fake.
+
+## version 0.15.1
+
+- [new] Use the schema name in the parameters table by default (no more "no such variable: XXXX_schema" error).
+
+## version 0.15.0
+
+- [CHANGE] Upgrade AWS-SDK to v3.  This version requires at least Bricolage 5.25.
+
+## version 0.14.2
+
+- Reduces loading retry count
+
+## version 0.14.1
+
+- [fix] task logging did not work
+
+## version 0.14.0
+
+- [new] Logs (task - object) relashonships to S3 on dispatch, as a DB backup.
+
+## version 0.13.0
+
+- grand refactoring
+
+## version 0.12.0
+
+- [CHANGE] Adds task_id column to the log table (strload_load_logs).
+
+## version 0.11.0
+
+- Loosen dependent Bricolage version
+
+## version 0.10.2
+
+- [new] New parameter dispatch-interval.
+
+## version 0.10.1
+
+- [fix] Fixes simple variable ref bug.
+
+## version 0.10.0
+
+- [new] Automatically complement strload_jobs status with Redshift-side log table.
+
+## version 0.9.0
+
+- [new] Introduces Redshift-side load log table (strload_load_logs) for load duplication checking.
+
+## version 0.8.1
+
+- [fix] tmp: Do not retry on data connection failure.
+
+## version 0.8.0
+
+- [CHANGE] Loader retries failed load tasks automatically.  Streaming loader does NOT delete a task from the queue on job failures.
+- [enhancement] Rewrites loader to get better error handling (ensure to write log record in the wider range of errornous situations).
+
+## version 0.7.1
+
+- fix utilities
+
+## version 0.7.0
+
+- [CHANGE] SQS data source requires "region" attribute.
+
+## version 0.6.2
+
+- [new] AWS access key id and secret key are now optional for SQS data sources (to allow using EC2 instance or ECS task attached IAM roles).
+- [new] New utility commands send-data-event, send-shutdown, send-checkpoint, send-load-task.
+- Adds sample config files.
+
+## version 0.6.1
+
+- [fix] dispatcher: Default ctl data source was wrong.
+- [fix] dispatcher: Detects S3 events by "s3" attribute instead of "eventSource" attribute, to allow fake S3 events (from non-S3 system).
+- [fix] dispatcher: SNS alert is now optional.
+- [fix] dispatcher: Correctly deletes unknown format messages.
+- [enhancement] Adds more logging messages.
+
+## version 0.6.0
+
+- [CHANGE] Adds loaded column to strload_objects table to record if the object is really loaded or not.
+- [CHANGE] Now strload_objects' object_url is unique.  Duplicated objects are stored in another table, strload_dup_objects.
+- [CHANGE] Now strload_table has table_id column, which is the primary key.
+- [new] Loader daemon supports new command line option --working-dir, to support symbolic linked path, such as Capistrano deploy target (current/).
+- [new] Keeps Redshift manifest file for later inspection.
+- [enhancement] Reduces the number of Redshift writer transactions (1 transaction for 1 loading).
+- [enhancement] Delay dispatching tasks until current event batch is processed, to avoid unexpected visibility timeout.
+- [enhancement] Adds more logging messages.
+
+## version 0.5.1
+
+- [fix] Fixes slow query
+
+## version 0.5.0
+
+- [new] Introduces FLUSHTABLE dispatcher event
+
+## version 0.4.0
+
+- [new] Introduces CHECKPOINT dispatcher event
+
+## version 0.3.0
+
+- [new] Supoprts SNS notification
+
+## version 0.2.0
+
+- not released
+- [fix] Fixes async delete timing
+
+## version 0.1.0
+
+- 2016-07-13 works 1 month

data/Rakefile

@@ -0,0 +1,3 @@
+task :test do
+  load "#{__dir__}/test/all.rb"
+end

data/bin/send-data-event

@@ -28,7 +28,7 @@ ARGF.each do |line|
       },
       object: {
         key: key,
-        size: 1
+        size: 0
       }
     },
     noDispatch: no_dispatch

data/bricolage-streamingload.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/bricolage/streamingload/version'
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = 'bricolage-streamingload'
+  s.version = Bricolage::StreamingLoad::VERSION
+  s.summary = 'Bricolage Streaming Load Daemon'
+  s.description = 'Bricolage Streaming Load Daemon loads S3 data files to Redshift continuously.'
+  s.license = 'MIT'
+
+  s.author = ['Minero Aoki', 'Shimpei Kodama']
+  s.email = ['aamine@loveruby.net']
+  s.homepage = 'https://github.com/aamine/bricolage-streamingload'
+
+  s.files = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  s.executables = s.files.grep(%r{bin/}).map {|path| File.basename(path) }
+  s.require_path = 'lib'
+
+  s.required_ruby_version = '>= 2.3.0'
+  s.add_dependency 'bricolage', '~> 5.30'
+  s.add_dependency 'pg', '~> 0.18.0'
+  s.add_dependency 'aws-sdk-s3', '~> 1.8'
+  s.add_dependency 'aws-sdk-sqs', '~> 1.3'
+  s.add_dependency 'sentry-raven', '~> 3.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'test-unit'
+end

data/config/production/database.yml

@@ -0,0 +1,66 @@
+### Databases
+
+db_ctl:
+  type: psql
+  host: localhost
+  port: 5432
+  database: bricolage
+  username: bricolage
+  # Get password from password.yml
+  password: <%= password 'postgres_bricolage_password' %>
+  encoding: utf8
+
+db_data: &db_data
+  type: psql
+  host: redshift.host
+  port: 5439
+  database: production
+  username: bricolage
+  # Get password from password.yml
+  password: <%= password 'redshift_bricolage_password' %>
+  encoding: utf8
+
+sql:
+  <<: *db_data
+
+### SQS
+
+sqs_event:
+  type: sqs
+  region: ap-northeast-1
+  url: https://sqs.ap-northeast-1.amazonaws.com/111111111111/bricolage-events
+  max_number_of_messages: 10
+  visibility_timeout: 600
+  wait_time_seconds: 10
+  # Enable following lines if you use access key explicitly.
+  # Otherwise Bricolage uses EC2 instance or ECS task attached IAM role.
+  #access_key_id: "<%%= password 'aws_access_key_id' %>"
+  #secret_access_key: "<%%= password 'aws_secret_access_key' %>"
+
+sqs_task:
+  type: sqs
+  region: ap-northeast-1
+  url: https://sqs.ap-northeast-1.amazonaws.com/111111111111/bricolage-tasks
+  max_number_of_messages: 1
+  visibility_timeout: 1800
+  wait_time_seconds: 10
+  # Enable following lines if you use access key explicitly.
+  # Otherwise Bricolage uses EC2 instance or ECS task attached IAM role.
+  #access_key_id: "<%%= password 'aws_access_key_id' %>"
+  #secret_access_key: "<%%= password 'aws_secret_access_key' %>"
+
+### S3
+
+s3_ctl: &s3_ctl
+  type: s3
+  region: ap-northeast-1
+  endpoint: s3-ap-northeast-1.amazonaws.com
+  bucket: bricolagectl.ap-northeast-1
+  prefix: development/strload
+  # Enable following lines if you use access key explicitly.
+  # Otherwise Bricolage uses EC2 instance or ECS task attached IAM role.
+  #access_key_id: "<%%= password 'aws_access_key_id' %>"
+  #secret_access_key: "<%%= password 'aws_secret_access_key' %>"
+
+s3:
+  <<: *s3_ctl

data/config/production/password.yml

@@ -0,0 +1,5 @@
+# Never commit this file
+redshift_bricolage_password: xxxxxxxxxxx
+postgres_bricolage_password: xxxxxxxxxxx
+aws_access_key_id: "AKIAAAAAAAAAAAAAAAAA"
+aws_secret_access_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

data/config/production/streamingload.yml

@@ -0,0 +1,20 @@
+#event-queue-ds: sqs_event
+#task-queue-ds: sqs_task
+
+#ctl-postgres-ds: db_ctl
+#ctl-s3-ds: s3_ctl
+
+#redshift-ds: db_data
+#log-table: strload_load_logs
+
+#dispatch-interval: 60
+
+# To Enable SNS notification
+#sns-ds: sns
+#alert-level: warn
+
+url_patterns:
+  -
+    url: "s3://some-log-bucket/\\w{4}\\.\\w+?\\.\\w+?\\.(?<schema>\\w+)\\.(?<table>\\w+)/\\d{4}/\\d{2}/\\d{2}/.*\\.gz"
+    schema: "%schema"
+    table: "%table"

data/config/production/variable.yml

@@ -0,0 +1,5 @@
+defaults:
+    redshift-ds: db_data
+    ctl-ds: s3_ctl
+
+dwh_schema: dwh

data/lib/bricolage/streamingload/dispatcher.rb

@@ -10,8 +10,9 @@ require 'bricolage/streamingload/chunkbuffer'
 require 'bricolage/streamingload/loadtasklogger'
 require 'bricolage/streamingload/alertinglogger'
 require 'yaml'
-require 'optparse'
 require 'fileutils'
+require 'raven'
+require 'optparse'
 
 module Bricolage
 
@@ -20,6 +21,12 @@ module Bricolage
     class Dispatcher < SQSDataSource::MessageHandler
 
       def Dispatcher.main
+        Raven.capture {
+          _main
+        }
+      end
+
+      def Dispatcher._main
         opts = DispatcherOptions.new(ARGV)
         opts.parse
         unless opts.rest_arguments.size == 1

data/lib/bricolage/streamingload/job.rb

@@ -3,6 +3,7 @@ require 'bricolage/streamingload/manifest'
 require 'bricolage/sqlutils'
 require 'socket'
 require 'json'
+require 'raven'
 
 module Bricolage
 
@@ -44,7 +45,8 @@ module Bricolage
       def execute(fail_fast: false)
         execute_task
         return true
-      rescue JobCancelled
+      rescue JobCancelled => ex
+        Raven.capture_exception(ex)
         return true
       rescue JobDuplicated
         return true
@@ -52,20 +54,25 @@ module Bricolage
         return false
       rescue ControlConnectionFailed => ex
         @logger.error ex.message
+        Raven.capture_exception(ex)
         wait_for_connection('ctl', @ctl_ds) unless fail_fast
         return false
       rescue DataConnectionFailed => ex
         @logger.error ex.message
+        Raven.capture_exception(ex)
         wait_for_connection('data', @data_ds) unless fail_fast
         return false
       rescue JobFailure => ex
         @logger.error ex.message
+        Raven.capture_exception(ex)
         return false
       rescue JobError => ex
         @logger.error ex.message
-        return true
+        Raven.capture_exception(ex)
+        return false
       rescue Exception => ex
         @logger.exception ex
+        Raven.capture_exception(ex)
         return true
       end
 
@@ -126,7 +133,11 @@ module Bricolage
           raise
         rescue JobError => ex
           ctl.open {
-            ctl.abort_job job_id, 'error', ex.message.lines.first.strip
+            fail_count = @task.failure_count
+            final_retry = (fail_count >= MAX_RETRY)
+            retry_msg = (fail_count > 0) ? "(retry\##{fail_count}#{final_retry ? ' FINAL' : ''}) " : ''
+            ctl.abort_job job_id, 'error', retry_msg + ex.message.lines.first.strip
+            raise JobCancelled, "retry count exceeds limit: task_id=#{@task_id}" if final_retry
           }
           raise
         rescue Exception => ex