iron_trail 0.0.6 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fb140276f60147f1c5d4beb71a3ba39a8f2c552a76e3b3c7e749e94ec518a2
-  data.tar.gz: 4e7700b3f5c53090a623e1be9ed5b0e6a513869450176c58bdc8fdd1352decf1
+  metadata.gz: e0eaa9c2070ae46d7386af196b943c47c495fba0485bc1b1956691e182ad099e
+  data.tar.gz: 732e39b8d5edba42b54a0f6bc67f6389d89fe1d037930c10dc4dff72a1afeb18
 SHA512:
-  metadata.gz: 0faa78641a209ccc88bed839b8988e1cc250465e6621e08158e38f1c68c0a4be421ab7f5346cbed7b6a25a658eeca9a51d015a1b23572ee2e91eab6aa04e29ce
-  data.tar.gz: 563248c156fb4716cb0befa64cfcd7a81f8b98594db3008853ccc2625e5e4b2e9a2948de12dbced48d018c3e1a915536baeef65d606deb973bcc0c0afe7853e3
+  metadata.gz: 21577368bee6f5560d27488a4bfbc3cd064bdca3869a8538002838e10f64bcaf6c20f7ec2a0a1ce56d5690b9959adbe780e6b4d7b41e59af1a78f281f1ef413a
+  data.tar.gz: 7e6b3c94d40059c22aa929efb07f93fdcef8abc1ffc6ef63dfe10c7d862c31d39880cc1175ad953231675bb2dd644e23d7a0b2ba1e426544af330309c77e26bb

data/lib/iron_trail/db_functions.rb

@@ -56,11 +56,32 @@ module IronTrail
       connection.execute(query)
     end
 
+    # Counting rows in Postgres is known to be a slow operation for large tables.
+    # Because of this, avoid using this for monitoring new errors. Instead,
+    # use the trigger_errors_metrics method.
     def trigger_errors_count
       stmt = 'SELECT COUNT(*) AS c FROM "irontrail_trigger_errors"'
       connection.execute(stmt).first['c']
     end
 
+    # This returns metrics intended to be used for monitoring. One can send
+    # these values to something like a Prometheus deployment and add monitoring
+    # on top of it.
+    # It should be much faster to run than trigger_errors_count.
+    #
+    # If the irontrail_trigger_errors table is empty, the resulting values
+    # will all be zero and never nil. This is so that data in a monitoring setup
+    # can tell apart a failure from a no-data scenario.
+    def trigger_errors_metrics
+      stmt = 'SELECT MAX(created_at) maxdate, MAX(id) AS maxid FROM "irontrail_trigger_errors"'
+      res = connection.execute(stmt).first
+
+      {
+        max_created_at: (res && res['maxdate'] && res['maxdate'].to_i) || 0,
+        max_id: (res && res['maxid']) || 0,
+      }
+    end
+
     def collect_all_tables(schema: 'public')
       # query pg_class rather than information schema because this way
       # we can get only regular tables and ignore partitions.

data/lib/iron_trail/irontrail_log_row_function.sql

@@ -11,10 +11,12 @@ DECLARE
   new_obj JSONB;
   actor_type TEXT;
   actor_id TEXT;
+  created_at TIMESTAMP;
 
   err_text TEXT; err_detail TEXT; err_hint TEXT; err_ctx TEXT;
 BEGIN
     SELECT split_part(split_part(current_query(), '/*IronTrail ', 2), ' IronTrail*/', 1) INTO it_meta;
+
     IF (it_meta <> '') THEN
       it_meta_obj = it_meta::JSONB;
 
@@ -28,17 +30,30 @@ BEGIN
       END IF;
     END IF;
 
+    old_obj = row_to_json(OLD);
+    new_obj = row_to_json(NEW);
+
+    IF (TG_OP = 'INSERT' AND new_obj ? 'created_at') THEN
+      created_at = NEW.created_at;
+    ELSIF (TG_OP = 'UPDATE' AND new_obj ? 'updated_at') THEN
+      created_at = NEW.updated_at;
+    END IF;
+
+    IF (created_at IS NULL) THEN
+      created_at = STATEMENT_TIMESTAMP();
+    ELSE
+      it_meta_obj = jsonb_set(COALESCE(it_meta_obj, '{}'::jsonb), array['_db_created_at'], TO_JSONB(STATEMENT_TIMESTAMP()));
+    END IF;
+
     IF (TG_OP = 'INSERT') THEN
         INSERT INTO "irontrail_changes" ("actor_id", "actor_type",
           "rec_table", "operation", "rec_id", "rec_new", "metadata", "created_at")
         VALUES (actor_id, actor_type,
-          TG_TABLE_NAME, 'i', NEW.id, row_to_json(NEW), it_meta_obj, NOW());
+          TG_TABLE_NAME, 'i', NEW.id, new_obj, it_meta_obj, created_at);
 
     ELSIF (TG_OP = 'UPDATE') THEN
         IF (OLD <> NEW) THEN
           u_changes = jsonb_build_object();
-          old_obj = row_to_json(OLD);
-          new_obj = row_to_json(NEW);
 
           FOR key IN (SELECT jsonb_object_keys(old_obj) UNION SELECT jsonb_object_keys(new_obj))
           LOOP
@@ -51,14 +66,13 @@ BEGIN
 
           INSERT INTO "irontrail_changes" ("actor_id", "actor_type", "rec_table", "operation",
             "rec_id", "rec_old", "rec_new", "rec_delta", "metadata", "created_at")
-          VALUES (actor_id, actor_type, TG_TABLE_NAME, 'u', NEW.id, row_to_json(OLD), row_to_json(NEW),
-          u_changes, it_meta_obj, NOW());
+          VALUES (actor_id, actor_type, TG_TABLE_NAME, 'u', NEW.id, old_obj, new_obj, u_changes, it_meta_obj, created_at);
 
         END IF;
     ELSIF (TG_OP = 'DELETE') THEN
         INSERT INTO "irontrail_changes" ("actor_id", "actor_type", "rec_table", "operation",
           "rec_id", "rec_old", "metadata", "created_at")
-        VALUES (actor_id, actor_type, TG_TABLE_NAME, 'd', OLD.id, row_to_json(OLD), it_meta_obj, NOW());
+        VALUES (actor_id, actor_type, TG_TABLE_NAME, 'd', OLD.id, old_obj, it_meta_obj, created_at);
 
     END IF;
     RETURN NULL;
@@ -74,7 +88,7 @@ EXCEPTION
         "err_text", "ex_detail", "ex_hint", "ex_ctx", "op", "table_name",
         "old_data", "new_data", "query", "created_at")
       VALUES (SQLSTATE, SQLERRM, err_text, err_detail, err_hint, err_ctx,
-        TG_OP, TG_TABLE_NAME, row_to_json(OLD), row_to_json(NEW), current_query(), NOW());
+        TG_OP, TG_TABLE_NAME, row_to_json(OLD), row_to_json(NEW), current_query(), STATEMENT_TIMESTAMP());
     RETURN NULL;
 END;
 $$ LANGUAGE plpgsql;

data/lib/iron_trail/version.rb

@@ -1,5 +1,5 @@
 # frozen_literal_string: true
 
 module IronTrail
-  VERSION = '0.0.6'
+  VERSION = '0.1.1'
 end

data/lib/iron_trail.rb

@@ -52,17 +52,6 @@ module IronTrail
       config.enable
     end
 
-    # def test_mode!
-    #   if [ENV['RAILS_ENV'], ENV['RACK_ENV']].include?('production')
-    #     raise "IronTrail test mode cannot be enabled in production!"
-    #   end
-    #   @test_mode = true
-    # end
-    #
-    # def test_mode?
-    #   @test_mode
-    # end
-
     def ignore_table?(name)
       (OWN_TABLES + (config.ignored_tables || [])).include?(name)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: iron_trail
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.1
 platform: ruby
 authors:
 - André Diego Piske
 bindir: bin
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,7 +153,13 @@ files:
 homepage: https://github.com/trusted/iron_trail
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/trusted/iron_trail/issues
+  changelog_uri: https://github.com/trusted/iron_trail/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/trusted/iron_trail/blob/main/README.md
+  homepage_uri: https://github.com/trusted/iron_trail
+  source_code_uri: https://github.com/trusted/iron_trail
+  wiki_uri: https://github.com/trusted/iron_trail/wiki
 rdoc_options: []
 require_paths:
 - lib