aws-logs 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f269c1e0f5e4f2ce2c783602017351445cc9f4849e132005c2de67735531d782
-  data.tar.gz: e43326f8b20d3dad93ab0f61d6bb2b6e14409619093827f6fa3a6f2eced8d369
+  metadata.gz: a20d3f0309f68ff523f15344158eef8a4de19249864b9aa84fe1b8e92e4de5d3
+  data.tar.gz: c1f87e3d3d0cf69b56c416c4766c2c09e8ed7b3b5d1372d5b9d28057770e930b
 SHA512:
-  metadata.gz: 1d3126451461293fa32cd56eb3fe567516b30188387c3aabee1112c03e6d5ceae92dc31e7175c4b20d954c90c5a9464e72f64bc86252f2150692759e59aef85b
-  data.tar.gz: 6499a4bdcd957f85b56e83ff2b159cd4086eab79e04e8de89f61845699a086ff86b2ffd789e7b2c98e896a49af40d70116cb9e1680e663bca0cdd8cf894cd523
+  metadata.gz: 488378c0430bb39dc08e6250da811393abb2010f53ecbc65e20e72c32274f66d5b338db46350e90d2d355c500b3ebbe98fcd64c6ecd6527b0b999158cde48ce1
+  data.tar.gz: 2f66c7a229ee4e697d07badd4deb0e4a2fafca700a79efe8aeea5224885106a39ff21377571a381f4be3a7f608c10b69ae48bf3bbdafc5d459f0f350b3dce621

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.0.0] - 2024-04-16
+- [#7](https://github.com/tongueroo/aws-logs/pull/7) show if filter, plain default, thread-safe improvements
+- change follow to false by default
+- custom formatter for puts behavior
+- plain format support and fix sliding window
+- show_if filter to customize output
+- thread-safe logger file option
+
+## [0.5.1] - 2023-11-22
+- [#6](https://github.com/tongueroo/aws-logs/pull/6) fix eager load
+
 ## [0.5.0] - 2023-11-22
 - [#5](https://github.com/tongueroo/aws-logs/pull/5) add options: refresh_rate and wait_exists
 - alias File.exists?

data/lib/aws_logs/autoloader.rb

@@ -13,8 +13,10 @@ module AwsLogs
       def setup
         loader = Zeitwerk::Loader.new
         loader.inflector = Inflector.new
-        loader.push_dir(File.dirname(__dir__)) # lib
-        loader.ignore("#{File.dirname(__dir__)}/aws-logs.rb")
+        lib = File.dirname(__dir__) # lib
+        loader.push_dir(lib)
+        loader.do_not_eager_load("#{lib}/aws_logs/core_ext")
+        loader.ignore("#{lib}/aws-logs.rb")
         loader.setup
       end
     end

data/lib/aws_logs/cli.rb

@@ -3,8 +3,8 @@ module AwsLogs
     desc "tail LOG_GROUP", "Tail the CloudWatch log group."
     long_desc Help.text(:tail)
     option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 10m in the past. The value provided can be an ISO 8601 timestamp or a relative time. Examples: 10m 2d 2w"
-    option :follow, default: true, type: :boolean, desc: " Whether to continuously poll for new logs. To exit from this mode, use Control-C."
-    option :format, default: "detailed", desc: "The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown."
+    option :follow, aliases: :f, default: false, type: :boolean, desc: "Whether to continuously poll for new logs. To exit from this mode, use Control-C."
+    option :format, default: "detailed", desc: "The format to display the logs. IE: detailed, short, plain.  With detailed, the log stream name is also shown. Plain is the simplest andd does not show the timestamp or log stream name."
     option :log_stream_names, type: :array, desc: "Filters the results to only logs from the log streams. Can only use log_stream_names or log_stream_name_prefix but not both."
     option :log_stream_name_prefix, desc: "Filters the results to include only events from log streams that have names starting with this prefix. Can only use log_stream_names or log_stream_name_prefix but not both."
     option :filter_pattern, desc: "The filter pattern to use. If not provided, all the events are matched"

data/lib/aws_logs/tail.rb

@@ -2,13 +2,15 @@ require "json"
 
 module AwsLogs
   class Tail < Base
-    def initialize(options={})
+    attr_reader :logger
+    def initialize(options = {})
       super
       # Setting to ensure matches default CLI option
       @follow = @options[:follow].nil? ? true : @options[:follow]
-      @refresh_rate = @options[:refresh_rate] || 5
+      @refresh_rate = @options[:refresh_rate] || 2
       @wait_exists = @options[:wait_exists]
       @wait_exists_retries = @options[:wait_exists_retries]
+      @logger = @options[:logger] || default_logger # separate logger instance for thread-safety
 
       @loop_count = 0
       @output = [] # for specs
@@ -16,12 +18,25 @@ module AwsLogs
       set_trap
     end
 
-    def data(since="1d", quiet_not_found=false)
+    def default_logger
+      logger = ActiveSupport::Logger.new($stdout)
+      # The ActiveSupport::Logger::SimpleFormatter always adds extra lines to the output,
+      # unlike puts, which only adds a newline if it's needed.
+      # We want the simpler puts behavior.
+      logger.formatter = proc { |severity, timestamp, progname, msg|
+        msg = "#{msg}\n" unless msg.end_with?("\n")
+        "#{msg}"
+      }
+      logger.level = ENV["AWS_LOGS_LOG_LEVEL"] || :info
+      logger
+    end
+
+    def data(since = "24h", quiet_not_found = false)
       since, now = Since.new(since).to_i, current_now
       resp = filter_log_events(since, now)
       resp.events
     rescue Aws::CloudWatchLogs::Errors::ResourceNotFoundException => e
-      puts "WARN: #{e.class}: #{e.message}" unless quiet_not_found
+      logger.info "WARN: #{e.class}: #{e.message}" unless quiet_not_found
       []
     end
 
@@ -39,21 +54,21 @@ module AwsLogs
     # It's a sliding window of time we're using.
     #
     def run
-      if ENV['AWS_LOGS_NOOP']
-        puts "Noop test"
-        return
-      end
-
       # We overlap the sliding window because CloudWatch logs can receive or send the logs out of order.
       # For example, a bunch of logs can all come in at the same second, but they haven't registered to CloudWatch logs
       # yet. If we don't overlap the sliding window then we'll miss the logs that were delayed in registering.
-      overlap = 60*1000 # overlap the sliding window by a minute
+      overlap = 60 * 1000 # overlap the sliding window by a minute
       since, now = initial_since, current_now
       @wait_retries ||= 0
       until end_loop?
         refresh_events(since, now)
         display
-        since, now = now-overlap, current_now
+
+        # @last_shown_event.timestamp changes and creates a "sliding window"
+        # The overlap is a just in case buffer
+        since = @last_shown_event ? @last_shown_event.timestamp - overlap : initial_since
+        now = current_now
+
         loop_count!
         sleep @refresh_rate if @follow && !ENV["AWS_LOGS_TEST"]
       end
@@ -62,17 +77,23 @@ module AwsLogs
       display
     rescue Aws::CloudWatchLogs::Errors::ResourceNotFoundException => e
       if @wait_exists
-        seconds = 5
-        puts "Waiting for log group #{@log_group_name} to exist. Waiting #{seconds} seconds."
+        seconds = Integer(@options[:wait_exists_seconds] || 5)
+        unless @@waiting_already_shown
+          logger.info "Waiting for log group to exist: #{@log_group_name}"
+          @@waiting_already_shown = true
+        end
         sleep seconds
         @wait_retries += 1
+        logger.info "Waiting #{seconds} seconds. #{@wait_retries} of #{@wait_exists_retries} retries"
         if !@wait_exists_retries || @wait_retries < @wait_exists_retries
           retry
         end
+        logger.info "Giving up waiting for log group to exist"
       end
-      puts "ERROR: #{e.class}: #{e.message}".color(:red)
-      puts "Log group #{@log_group_name} not found."
+      logger.info "ERROR: #{e.class}: #{e.message}".color(:red)
+      logger.info "Log group #{@log_group_name} not found."
     end
+    @@waiting_already_shown = false
 
     # TODO: lazy Enum or else its seems stuck for long --since
     def refresh_events(start_time, end_time)
@@ -89,11 +110,11 @@ module AwsLogs
       @events
     end
 
-    def filter_log_events(start_time, end_time, next_token=nil)
+    def filter_log_events(start_time, end_time, next_token = nil)
       options = {
         log_group_name: @log_group_name, # required
         start_time: start_time,
-        end_time: end_time,
+        end_time: end_time
         # limit: 1000,
         # interleaved: true,
       }
@@ -107,35 +128,56 @@ module AwsLogs
     end
 
     # There can be duplicated events as events can be written to the exact same timestamp.
-    # So also track the last_shown_event_id and prevent duplicate log lines from re-appearing.
+    # So also track the last_shown_event and prevent duplicate log lines from re-appearing.
     def display
       new_events = @events
-      shown_index = new_events.find_index { |e| e.event_id == @last_shown_event_id }
+      shown_index = new_events.find_index { |e| e.event_id == @last_shown_event&.event_id }
       if shown_index
-        new_events = @events[shown_index+1..-1] || []
+        new_events = @events[shown_index + 1..-1] || []
       end
 
       new_events.each do |e|
-        time = Time.at(e.timestamp/1000).utc
-        line = [time.to_s.color(:green), e.message]
+        time = Time.at(e.timestamp / 1000).utc.to_s.color(:green) unless @options[:format] == "plain"
+        line = [time, e.message].compact
         format = @options[:format] || "detailed"
         line.insert(1, e.log_stream_name.color(:purple)) if format == "detailed"
-        say line.join(' ') unless @options[:silence]
+
+        filtered = show_if? ? show_if(e) : true
+        say line.join(" ") if !@options[:silence] && filtered
       end
-      @last_shown_event_id = @events.last&.event_id
+      @last_shown_event = @events.last
       check_follow_until!
     end
 
+    def show_if?
+      !@options[:show_if].nil?
+    end
+
+    def show_if(e)
+      filter = @options[:show_if]
+      case filter
+      when ->(f) { f.respond_to?(:call) }
+        filter.call(e)
+      else
+        filter # true or false
+      end
+    end
+
+    # [Container] 2024/03/27 02:35:32.086024 Phase complete: BUILD State: SUCCEEDED
+    def codebuild_complete?(message)
+      message.starts_with?("[Container]") && message.include?("Phase complete: BUILD")
+    end
+
     def check_follow_until!
       follow_until = @options[:follow_until]
       return unless follow_until
 
       messages = @events.map(&:message)
-      @@end_loop_signal = messages.detect { |m| m.include?(follow_until) }
+      @end_loop_signal = messages.detect { |m| m.include?(follow_until) }
     end
 
     def say(text)
-      ENV["AWS_LOGS_TEST"] ? @output << text : puts(text)
+      ENV["AWS_LOGS_TEST"] ? @output << text : logger.info(text)
     end
 
     def output
@@ -144,6 +186,7 @@ module AwsLogs
 
     def set_trap
       Signal.trap("INT") {
+        # puts must be used here instead of logger.info or else get Thread-safe error
         puts "\nCtrl-C detected. Exiting..."
         exit # immediate exit
       }
@@ -152,12 +195,19 @@ module AwsLogs
     # The stop_follow! results in a little waiting because it signals to break the polling loop.
     # Since it's in the middle of the loop process, the loop will finish the sleep 5 first.
     # So it can pause from 0-5 seconds.
-    @@end_loop_signal = false
+    def stop_follow!
+      @end_loop_signal = true
+    end
+
+    # For backwards compatibility. This is not thread-safe.
+    @@global_end_loop_signal = false
     def self.stop_follow!
-      @@end_loop_signal = true
+      logger.info "WARN: AwsLogs::Tail.stop_follow! is deprecated. Use AwsLogs::Tail#stop_follow! instead which is thread-safe."
+      @@global_end_loop_signal = true
     end
 
-  private
+    private
+
     def initial_since
       since = @options[:since]
       seconds = since ? Since.new(since).to_i : Since::DEFAULT
@@ -165,11 +215,12 @@ module AwsLogs
     end
 
     def current_now
-      (Time.now.to_i) * 1000 # now in milliseconds
+      Time.now.to_i * 1000 # now in milliseconds
     end
 
     def end_loop?
-      return true if @@end_loop_signal
+      return true if @@global_end_loop_signal
+      return true if @end_loop_signal
       max_loop_count && @loop_count >= max_loop_count
     end
 

data/lib/aws_logs/version.rb

@@ -1,3 +1,3 @@
 module AwsLogs
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/lib/aws_logs.rb

@@ -1,10 +1,12 @@
 $stdout.sync = true unless ENV["AWS_LOGS_STDOUT_SYNC"] == "0"
 
-$:.unshift(File.expand_path("../", __FILE__))
-require "aws_logs/version"
-require "rainbow/ext/string"
+$:.unshift(File.expand_path(".", __dir__))
 
 require "aws_logs/core_ext/file"
+require "aws_logs/version"
+require "rainbow/ext/string"
+require "active_support"
+require "active_support/core_ext"
 
 require "aws_logs/autoloader"
 AwsLogs::Autoloader.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-logs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Tail AWS CloudWatch Logs