nobrainer 0.44.0 → 0.44.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '035182f731c727beff4562127d0ec36aaa7ad56871f11121940f05b0b72819c2'
-  data.tar.gz: aa14e68a3ff7fded92a16171842dff3a7329cb78c93946af9475255d25bba1ae
+  metadata.gz: 4ba987cddbf9e6eb6864dbd6dc244f4b6dac2a5303e8c858a5f4f8f17cb82ee0
+  data.tar.gz: 127c6a0c7f1f3e5b25ad455adb7bf3a7f846481eec34cf1f420c8f52b199627b
 SHA512:
-  metadata.gz: b9ab73b56b9df5df5098d7a769581fe367284fa7200b19b7cfd637982f8bf3afd36e071e3f12370504e87e1799bc0d7f1f5ee03ca62617f9f3bfbbb62c6e51df
-  data.tar.gz: 42a7831651d35f55bd39c68c6baaec3b20e845c82e6d5ce562d9e5c2b4184cfcd3daf754ab097bcc3bffe91c05ab873e2d083d37d21c5e44bbfc6afb81197f22
+  metadata.gz: 6a696b8919a347bc903d4d95f0700a1cea0d605b370349f171ace0505d0a07ff74663a249a98bad1cc7f9bec5aa9fd6c91ff279f908807d38831521684d9db04
+  data.tar.gz: 74f06144598fbc1706430dbceddd97712d0d3be7d0d1d08474289ce59defdd25c32832b1a4be1bd77fb142d2642744240259294c7f85ec74f8f7b0d0945436a2

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.44.1] - 2023-08-02
+### Changed
+- Allows one to change what should be done with the slow query log message
+
 ## [0.44.0] - 2023-07-31
 ### Added
 - Slow Queries Logger feature logging slow queries in a dedicated log file
@@ -134,7 +138,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Locks: bug fix: allow small timeouts in lock()
 - Fix reentrant lock counter on steals
 
-[Unreleased]: https://github.com/nobrainerorm/nobrainer/compare/v0.44.0...HEAD
+[Unreleased]: https://github.com/nobrainerorm/nobrainer/compare/v0.44.1...HEAD
+[0.44.1]: https://github.com/nobrainerorm/nobrainer/compare/v0.44.0...v0.44.1
 [0.44.0]: https://github.com/nobrainerorm/nobrainer/compare/v0.43.0...v0.44.0
 [0.43.0]: https://github.com/nobrainerorm/nobrainer/compare/v0.42.0...v0.43.0
 [0.42.0]: https://github.com/nobrainerorm/nobrainer/compare/v0.41.1...v0.42.0

data/lib/no_brainer/config.rb

@@ -22,7 +22,7 @@ module NoBrainer::Config
     per_thread_connection: { default: -> { false }, valid_values: [true, false] },
     rethinkdb_urls: { default: -> { [default_rethinkdb_url] } },
     run_options: { default: -> { { durability: default_durability } } },
-    slow_query_log_file: { default: -> { File.join('/', 'var', 'log', 'rethinkdb', 'slow_queries.log') } },
+    on_slow_query: { default: -> { nil } },
     ssl_options: { default: -> {} },
     table_options: {
       default: -> { { shards: 1, replicas: 1, write_acks: :majority } },
@@ -55,6 +55,10 @@ module NoBrainer::Config
       @applied_defaults_for.each { |k| __send__("#{k}=", SETTINGS[k][:default].call) }
     end
 
+    def on_slow_query=(callback)
+      @on_slow_query = callback
+    end
+
     def geo_options=(value)
       @geo_options = value.try(:symbolize_keys)
     end

data/lib/no_brainer/profiler/slow_queries.rb

@@ -4,17 +4,14 @@ module NoBrainer
   module Profiler
     class SlowQueries < Logger
       def on_query(env)
-        return unless NoBrainer::Config.log_slow_queries
+        return unless NoBrainer::Config.on_slow_query
 
         query_duration = (env[:duration] * 1000.0).round(1)
 
         return unless query_duration > NoBrainer::Config.long_query_time
 
-        File.write(
-          NoBrainer::Config.slow_query_log_file,
-          build_message(env),
-          mode: 'a'
-        )
+        message = build_message(env)
+        NoBrainer::Config.on_slow_query.call(message)
       end
 
       NoBrainer::Profiler.register(new)

data/lib/rails/generators/templates/nobrainer.rb

@@ -97,15 +97,26 @@ NoBrainer.configure do |config|
   # out of memory issues.
   # config.criteria_cache_max_entries = 10_000
 
-  # Write queries running longer than config.long_query_time seconds.
-  # The slow query log can be used to find queries that take a long time to
-  # execute and are therefore candidates for optimization.
-  # config.log_slow_queries = true
+  #
+  # Slow queries
+  #
 
   # Queries running longer than the bellow value will be logged in a log file if
   # the above `config.log_slow_queries` is `true`.
   # config.long_query_time = 10 # seconds
 
-  # Path of the slow queries log file
-  # config.slow_query_log_file = File.join('/', 'var', 'log', 'rethinkdb', 'slow_queries.log')
+  # Uncomment the following block in order to do something with slow query log
+  # message.
+  # The example writes the log message in a log file, but you could of course
+  # change it to do something else with that log message.
+  # Nothing happens when `config.on_slow_query` is commented and a slow query is
+  # detected.
+  # config.on_slow_query = lambda do |message|
+  #   # Write the log message to /var/log/rethinkdb/slow_queries.log file
+  #   File.write(
+  #     File.join('/', 'var', 'log', 'rethinkdb', 'slow_queries.log'),
+  #     message,
+  #     mode: 'a'
+  #   )
+  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nobrainer
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.44.1
 platform: ruby
 authors:
 - Nicolas Viennot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel