noop-backup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba6625ab079fd41615d6ff304e7517743a67d2cb394a6644e058f3d93a8dd0e
-  data.tar.gz: 194c11d8d1e0cdb069f05a20b06342a1d421ae4178d3d918090a9f6fc182722a
+  metadata.gz: 6c6bdd09dd1ea2dc4826aa9e8e64f9d84f6c400baa5b000911de51d90c678167
+  data.tar.gz: 25722912661bd899bd56414d65cc68f9a33fc135225b74c0a4cc8c10f0cc091b
 SHA512:
-  metadata.gz: 201fdd9c78813f8f20d1e042d842dc76f2bfff07f94e71ce0ef926e6e606f549b7889075cae371602f33e6d095a1c854ce762daf21de7cbd7bee1a7bd32a730a
-  data.tar.gz: 313b0980120d3330cd6a37959813cd3fbd44f037369eab05fdff7c3a18dd8d06cd1207aaeeaac1c83eea9adb76ee1ed46303f5a1425392e7a7de3f34cfc65a82
+  metadata.gz: 645e48fe012407117c84a0293d4eea26f9c5f5103ee4b3ed266bb7a5fa2ebcb5c48e967921d1490f6d701361fa6bd92aaddd46e16e077738863918050ddb6d47
+  data.tar.gz: 2bc43c9e34ed129bc3c87f54d9b29ad7e38d5aea564824f30c490bb818a4e1719fb17f07a53bfb021d244755f511208d837caeec5f269155228b78a3b9f0e0e3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.3.0] - 2026-07-13
+
+- Make s3 upload stream part size and thread count configurable
+- Sentinel integration
+- Option to ignore tables
+
 ## [0.2.0] - 2026-07-04
 
 - Support multiple destination stores in a single backup run

data/README.md

@@ -75,6 +75,20 @@ NoopBackup.configure do |config|
 end
 ```
 
+### Ignoring tables
+
+To skip the rows of tables you don't need backed up, such as audit trails or job history:
+
+```rb
+NoopBackup.configure do |config|
+  config.ignore_tables = %w[versions logs]
+end
+```
+
+Or set `NBU_IGNORE_TABLES=versions,logs`.
+
+A restore still creates these tables empty.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/noop_backup/commands/backup.rb

@@ -14,14 +14,14 @@ module NoopBackup::Commands
       :partial_success
     end
 
+    def messages
+      return ["❌ Fatal error: #{error.message}"] if error
+
+      store_results.map(&:message)
+    end
+
     def report
-      if error
-        NoopBackup.notify "❌ Fatal error: #{error.message}"
-      else
-        store_results.each do |result|
-          NoopBackup.notify result.message
-        end
-      end
+      NoopBackup.notify(self)
     end
   end
 
@@ -108,7 +108,7 @@ module NoopBackup::Commands
       @sinks.each do |sink|
         sink.store.cleanup!(@key) if sink.collect&.success
       rescue => e
-        NoopBackup.notify "⚠️ Cleanup failed for #{sink.store.class}: #{e.message}"
+        warn "⚠️ Cleanup failed for #{sink.store.class}: #{e.message}"
       end
     end
 

data/lib/noop_backup/configuration.rb

@@ -1,15 +1,18 @@
 module NoopBackup
   class Configuration
+    DEFAULT_SENTINEL_HOST = "https://boringbackup.com"
+
     attr_accessor :prefix,
       :min_size,
       :pg_host,
       :pg_port,
       :pg_user,
       :pg_password,
-      :pg_database
+      :pg_database,
+      :sentinel_key
 
-    attr_reader :stores, :notifiers
-    attr_writer :report, :dump_command
+    attr_reader :stores
+    attr_writer :report, :dump_command, :ignore_tables, :sentinel_host
 
     def initialize
       @prefix = ENV.fetch("NBU_PREFIX", "database")
@@ -17,14 +20,45 @@ module NoopBackup
       @min_size = ENV.fetch("NBU_MIN_SIZE", 2048).to_i
       @notifiers = [NoopBackup::Notifiers::Stdout.new]
       @report = true
+      @ignore_tables = ENV.fetch("NBU_IGNORE_TABLES", "").split(",")
+      @sentinel_key = ENV["NBU_SENTINEL_KEY"]
+      @sentinel_host = ENV.fetch("NBU_SENTINEL_HOST", DEFAULT_SENTINEL_HOST)
     end
 
     def report?
       @report
     end
 
+    def sentinel_host
+      @sentinel_host || DEFAULT_SENTINEL_HOST
+    end
+
+    def sentinel?
+      !sentinel_key.to_s.empty?
+    end
+
+    def sentinel
+      return unless sentinel?
+
+      @sentinel ||= NoopBackup::Notifiers::Sentinel.new(key: sentinel_key, host: sentinel_host)
+    end
+
+    def notifiers
+      [*@notifiers, sentinel].compact
+    end
+
+    def ignore_tables
+      Array(@ignore_tables).map { |table| table.to_s.strip }.reject(&:empty?).uniq
+    end
+
     def dump_command
-      @dump_command || [pg_env, "pg_dump", "--format=custom", "--no-owner"]
+      @dump_command || [
+        pg_env,
+        "pg_dump",
+        "--format=custom",
+        "--no-owner",
+        *ignore_tables.map { |table| "--exclude-table-data=#{table}" }
+      ]
     end
 
     def register(store_type)

data/lib/noop_backup/notifiers/sentinel.rb

@@ -0,0 +1,103 @@
+require "net/http"
+require "uri"
+require "json"
+
+module NoopBackup::Notifiers
+  class Sentinel
+    PAYLOAD_VERSION = 1
+
+    OPEN_TIMEOUT = 5
+    READ_TIMEOUT = 10
+    MAX_ATTEMPTS = 3
+
+    LOCAL_HOSTS = %w[localhost 127.0.0.1 0.0.0.0]
+
+    attr_accessor :key, :host
+
+    def initialize(key:, host:)
+      @key = key
+      @host = host
+    end
+
+    def ping_url
+      URI.join(normalized_host, "/ping/#{key}")
+    end
+
+    def notify(result)
+      body = payload(result).to_json
+      attempt = 0
+
+      begin
+        attempt += 1
+        response = post(body)
+
+        return true if response.is_a?(Net::HTTPSuccess)
+        raise NoopBackup::Error, "#{response.code} #{response.body}" if retryable?(response)
+
+        warn "Sentinel ping failed: #{response.code} #{response.body}"
+
+        false
+      rescue => e
+        if attempt < MAX_ATTEMPTS
+          sleep(2**(attempt - 1))
+          retry
+        end
+
+        warn "Sentinel ping error after #{attempt} attempts: #{e.message}"
+
+        false
+      end
+    end
+
+    private
+
+    def normalized_host
+      uri = URI.parse(host)
+
+      return host if uri.is_a?(URI::HTTP)
+
+      "#{LOCAL_HOSTS.include?(uri.scheme) ? "http" : "https"}://#{host}"
+    end
+
+    def post(body)
+      uri = ping_url
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = OPEN_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
+
+      request = Net::HTTP::Post.new(uri.request_uri, "Content-Type" => "application/json")
+      request.body = body
+
+      http.request(request)
+    end
+
+    def retryable?(response)
+      response.is_a?(Net::HTTPServerError) || response.is_a?(Net::HTTPTooManyRequests)
+    end
+
+    def payload(result)
+      store_results = result.store_results
+
+      {
+        version: PAYLOAD_VERSION,
+        status: result.status,
+        error: result.error&.message,
+        database: NoopBackup.config.pg_env["PGDATABASE"],
+        bytes: store_results.filter_map(&:bytes).max,
+        duration: store_results.filter_map(&:duration).max&.round(3),
+        stores: store_results.map do |store_result|
+          {
+            store: store_result.store,
+            success: store_result.success,
+            key: store_result.key,
+            bytes: store_result.bytes,
+            duration: store_result.duration&.round(3),
+            error: store_result.error&.message
+          }
+        end
+      }
+    end
+  end
+end

data/lib/noop_backup/notifiers/slack.rb

@@ -4,15 +4,20 @@ require "json"
 
 module NoopBackup::Notifiers
   class Slack
+    OPEN_TIMEOUT = 5
+    READ_TIMEOUT = 10
+
     attr_accessor :webhook_url
 
-    def notify(text)
+    def notify(result)
       uri = URI(webhook_url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
+      http.open_timeout = OPEN_TIMEOUT
+      http.read_timeout = READ_TIMEOUT
 
-      request = Net::HTTP::Post.new(uri.path, "Content-Type" => "application/json")
-      request.body = {text: text}.to_json
+      request = Net::HTTP::Post.new(uri.request_uri, "Content-Type" => "application/json")
+      request.body = {text: result.messages.join("\n")}.to_json
 
       response = http.request(request)
 

data/lib/noop_backup/notifiers/stdout.rb

@@ -1,7 +1,7 @@
 module NoopBackup::Notifiers
   class Stdout
-    def notify(text)
-      puts text
+    def notify(result)
+      result.messages.each { |message| puts message }
     end
   end
 end

data/lib/noop_backup/stores/s3.rb

@@ -2,13 +2,15 @@ require "aws-sdk-s3"
 
 module NoopBackup::Stores
   class S3 < Store
-    attr_accessor :bucket, :region, :access_key_id, :secret_access_key
+    attr_accessor :bucket, :region, :access_key_id, :secret_access_key, :part_size, :thread_count
 
     def initialize
       @bucket = ENV["AWS_S3_BUCKET"]
       @region = ENV["AWS_REGION"]
       @access_key_id = ENV["AWS_ACCESS_KEY_ID"]
       @secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+      @part_size = ENV.fetch("NBU_S3_PART_SIZE", 8 * 1024 * 1024).to_i
+      @thread_count = ENV.fetch("NBU_S3_THREAD_COUNT", 2).to_i
     end
 
     # Prefer Aws::S3::TransferManager for streaming uploads if available.
@@ -24,13 +26,13 @@ module NoopBackup::Stores
       if defined?(Aws::S3::TransferManager)
         manager = Aws::S3::TransferManager.new(client: s3_client)
 
-        manager.upload_stream(bucket:, key: key, part_size: 8 * 1024 * 1024, thread_count: 2) do |s3_stream|
+        manager.upload_stream(bucket:, key: key, part_size:, thread_count:) do |s3_stream|
           bytes = IO.copy_stream(stream, s3_stream)
         end
       else
         object = Aws::S3::Resource.new(client: s3_client).bucket(bucket).object(key)
 
-        object.upload_stream(part_size: 8 * 1024 * 1024, thread_count: 2) do |s3_stream|
+        object.upload_stream(part_size:, thread_count:) do |s3_stream|
           bytes = IO.copy_stream(stream, s3_stream)
         end
       end
@@ -60,7 +62,7 @@ module NoopBackup::Stores
     end
 
     def cleanup!(key)
-      s3_client.delete_object(bucket:, key: key)
+      s3_client.delete_object(bucket:, key:)
     rescue => e
       warn "Failed to clean up partial upload #{key}: #{e.message}"
     end

data/lib/noop_backup/version.rb

@@ -1,3 +1,3 @@
 module NoopBackup
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/noop_backup.rb

@@ -6,6 +6,7 @@ require_relative "noop_backup/stores"
 require_relative "noop_backup/commands/backup"
 require_relative "noop_backup/notifiers/slack"
 require_relative "noop_backup/notifiers/stdout"
+require_relative "noop_backup/notifiers/sentinel"
 
 module NoopBackup
   class Error < StandardError; end
@@ -52,9 +53,9 @@ module NoopBackup
       require env_file if File.exist?(env_file)
     end
 
-    def notify(message)
+    def notify(result)
       config.notifiers.each do |notifier|
-        notifier.notify(message)
+        notifier.notify(result)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noop-backup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Georgi Mitrev
@@ -57,6 +57,7 @@ files:
 - lib/noop_backup/commands/backup.rb
 - lib/noop_backup/configuration.rb
 - lib/noop_backup/jobs/backup_job.rb
+- lib/noop_backup/notifiers/sentinel.rb
 - lib/noop_backup/notifiers/slack.rb
 - lib/noop_backup/notifiers/stdout.rb
 - lib/noop_backup/plugins/rails.rb