logtail 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b733e09dc3c2fe5e34726a20e57f2b6b812077599aa8b90acee18387296b87d2
-  data.tar.gz: 805f7124e4796e3ea453dd917f1d6abbcd1ef1844869d543bb884195329258f7
+  metadata.gz: 0a6b0738bfe520cbd3e443365dff1cb77b6e2ae2849799badf8d47f785df52d4
+  data.tar.gz: ba02074bd5ee3e2ced09e286712c2af97b6b78175e06d372c50e4bc1a158d114
 SHA512:
-  metadata.gz: 394455d1941c94c0a19e1c4a25486b0a9c67f14461be14a43cd65019d10ad274ffe7d5d1fc3614edaf6c2011394d515741ddd411e7674d1ef418f67342657ea6
-  data.tar.gz: a4654f2d5dc978fe2c48c4223a1a439bae9a7e41c8ef74e15a9f76892dd43846d7994c6b5d999ac860f39b8e084750af7165f66af109fdb9efa4423e60196f47
+  metadata.gz: 0f1f0865055d6f29eff1d251e8f4b13609ce3306ae2b2e72bd38afb44294c28d562ec7ee3aac74a4fd9ad386c302743d5a9c929741c511401afd50f8e59638ff
+  data.tar.gz: c95ee4374d040f864130b6f5ed0fc4f732e94e6d9b17b64c6579cea8fad59f1710b422a878b6bd798cf09b9d773ef0f3a86e609ac597c87d3c3b3c7ae77e2f1f

data/.github/workflows/main.yml

@@ -1,24 +1,28 @@
 name: build
 
-on: [push, pull_request]
+on:
+  push:
+  schedule:
+    - cron: '20 5 * * 1'
+  workflow_dispatch:
 
 jobs:
   test:
-
     runs-on: ubuntu-20.04
 
     strategy:
+      fail-fast: false
+
       matrix:
         ruby-version:
-          - 3.2.1
-          - 3.1.2
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
-          - 2.5.8
-          - 2.4.10
-          - 2.3.8
-          - 2.2.10
+          - 3.2
+          - 3.1
+          - 3.0
+          - 2.7
+          - 2.6
+          - 2.5
+          - 2.4
+          - 2.3
           - jruby-9.4.3.0
           - jruby-9.2.14.0
           - truffleruby-23.0.0

data/example-project/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gem "logtail"
+gem "logtail", "~> 0.1.12"

data/example-project/Gemfile.lock

@@ -1,9 +1,9 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    logtail (0.1.9)
+    logtail (0.1.12)
       msgpack (~> 1.0)
-    msgpack (1.7.1)
+    msgpack (1.7.2)
 
 PLATFORMS
   ruby

data/example-project/main.rb

@@ -15,6 +15,9 @@ end
 http_device = Logtail::LogDevices::HTTP.new(ARGV[0])
 logger = Logtail::Logger.new(http_device)
 
+# Filter logs that shouldn't be sent to Better Stack, see {Logtail::LogEntry} for available attributes
+Logtail.config.filter_sent_to_better_stack { |log_entry| log_entry.message.include?("DO_NOT_SEND") }
+
 # LOGGING
 
 # Send debug logs messages using the debug() method
@@ -33,6 +36,9 @@ logger.warn(
     }
 )
 
+# Some messages can be filtered, see {Logtail::Config#filter_sent_to_better_stack} call above
+logger.info("This message will not be sent to Better Stack because it contains 'DO_NOT_SEND'")
+
 # Send error messages using the error() method
 logger.error("Oops! An error occurred!")
 

data/lib/logtail/config.rb

@@ -32,6 +32,28 @@ module Logtail
 
     attr_writer :http_body_limit
 
+    # Whether a particular {Logtail::LogEntry} should be sent to Better Stack
+    def send_to_better_stack?(log_entry)
+      !@better_stack_filters&.any? { |blocker| blocker.call(log_entry) }
+    rescue => e
+      debug { "Could not determine whether to send LogEntry to Better Stack (assumed yes): #{e}" }
+      true
+    end
+
+    # This allows filtering logs that are sent to Better Stack. Can be called multiple times, all filters will
+    # be applied. If the passed block RETURNS TRUE for a particular LogEntry, it WILL NOT BE SENT to Better Stack.
+    #
+    # See {Logtail::LogEntry} for available attributes of the block parameter.
+    #
+    # @example Rails
+    #   config.logtail.filter_sent_to_better_stack { |log_entry| log_entry.context_snapshot[:http][:path].start_with?('_') }
+    # @example Everything else
+    #   Logtail.config.filter_sent_to_better_stack { |log_entry| log_entry.message.include?('IGNORE') }
+    def filter_sent_to_better_stack(&block)
+      @better_stack_filters ||= []
+      @better_stack_filters << -> (log_entry) { yield(log_entry) }
+    end
+
     # Convenience method for logging debug statements to the debug logger
     # set in this class.
     # @private

data/lib/logtail/log_devices/http.rb

@@ -89,6 +89,8 @@ module Logtail
       # size is constricted by the Logtail API. The actual application limit is a multiple
       # of this. Hence the `@request_queue`.
       def write(msg)
+        return unless Logtail.config.send_to_better_stack?(msg)
+
         @msg_queue.enq(msg)
 
         # Lazily start flush threads to ensure threads are alive after forking processes.

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/logtail.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.2.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3")
 
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Better Stack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -216,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="