aws-logs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f80b63c48f228ee6420c2d97226ac8fe1fab65fe42b847b15bfe80fd3f72197a
-  data.tar.gz: de12e2063cb6e25ee6505fa48ffb8d6d695b0bfa33afc9c3334a4cc132d82c00
+  metadata.gz: f269c1e0f5e4f2ce2c783602017351445cc9f4849e132005c2de67735531d782
+  data.tar.gz: e43326f8b20d3dad93ab0f61d6bb2b6e14409619093827f6fa3a6f2eced8d369
 SHA512:
-  metadata.gz: ec6276ffea2146c914704fb1021a0b3b4cc9b595640ef83cf444ef5217dbdb672504084f12cc3773afdb9ddf02018579512286c8ae25eb7399bf437b60d26c5c
-  data.tar.gz: 8af7b076de6042316a374321278dadee5d27dea00fcf08d97f58b5c1578fa07dd151b2cbb65f074d5457903c2fcb8ea77f7aa3c01af2a0ffff02ac8e28178050
+  metadata.gz: 1d3126451461293fa32cd56eb3fe567516b30188387c3aabee1112c03e6d5ceae92dc31e7175c4b20d954c90c5a9464e72f64bc86252f2150692759e59aef85b
+  data.tar.gz: 6499a4bdcd957f85b56e83ff2b159cd4086eab79e04e8de89f61845699a086ff86b2ffd789e7b2c98e896a49af40d70116cb9e1680e663bca0cdd8cf894cd523

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.
 
+## [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?
+- update tail desc
+
+## [0.4.1] - 2022-04-23
+- [#4](https://github.com/tongueroo/aws-logs/pull/4) quiet not found option
+
 ## [0.4.0] - 2022-01-07
 - [#3](https://github.com/tongueroo/aws-logs/pull/3) streams cli command and data method
 - fix activesupport require

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem dependencies in aws-logs.gemspec
 gemspec
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/lib/aws_logs/cli.rb

@@ -2,7 +2,7 @@ module AwsLogs
   class CLI < Command
     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."
+    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 :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."

data/lib/aws_logs/core_ext/file.rb

@@ -0,0 +1,11 @@
+class File
+  class << self
+    # Ruby 3.2 removed File.exists?
+    # aws_config/store.rb uses it
+    # https://github.com/a2ikm/aws_config/blob/ef9cdd0eda116577f7d358bc421afd8e2f1eb1d3/lib/aws_config/store.rb#L6
+    # Probably a bunch of other libraries still use File.exists? also
+    unless method_defined?(:exist?)
+      alias_method :exists?, :exist?
+    end
+  end
+end

data/lib/aws_logs/tail.rb

@@ -6,6 +6,9 @@ module AwsLogs
       super
       # Setting to ensure matches default CLI option
       @follow = @options[:follow].nil? ? true : @options[:follow]
+      @refresh_rate = @options[:refresh_rate] || 5
+      @wait_exists = @options[:wait_exists]
+      @wait_exists_retries = @options[:wait_exists_retries]
 
       @loop_count = 0
       @output = [] # for specs
@@ -13,12 +16,12 @@ module AwsLogs
       set_trap
     end
 
-    def data(since="1d")
+    def data(since="1d", 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}"
+      puts "WARN: #{e.class}: #{e.message}" unless quiet_not_found
       []
     end
 
@@ -46,21 +49,32 @@ module AwsLogs
       # 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
       since, now = initial_since, current_now
+      @wait_retries ||= 0
       until end_loop?
         refresh_events(since, now)
         display
         since, now = now-overlap, current_now
         loop_count!
-        sleep 5 if @follow && !ENV["AWS_LOGS_TEST"]
+        sleep @refresh_rate if @follow && !ENV["AWS_LOGS_TEST"]
       end
       # Refresh and display a final time in case the end_loop gets interrupted by stop_follow!
       refresh_events(since, now)
       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."
+        sleep seconds
+        @wait_retries += 1
+        if !@wait_exists_retries || @wait_retries < @wait_exists_retries
+          retry
+        end
+      end
       puts "ERROR: #{e.class}: #{e.message}".color(:red)
       puts "Log group #{@log_group_name} not found."
     end
 
+    # TODO: lazy Enum or else its seems stuck for long --since
     def refresh_events(start_time, end_time)
       @events = []
       next_token = :start

data/lib/aws_logs/version.rb

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

data/lib/aws_logs.rb

@@ -4,6 +4,8 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "aws_logs/version"
 require "rainbow/ext/string"
 
+require "aws_logs/core_ext/file"
+
 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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,7 @@ files:
 - lib/aws_logs/completer.rb
 - lib/aws_logs/completer/script.rb
 - lib/aws_logs/completer/script.sh
+- lib/aws_logs/core_ext/file.rb
 - lib/aws_logs/help.rb
 - lib/aws_logs/help/completion.md
 - lib/aws_logs/help/completion_script.md
@@ -227,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: Tail AWS CloudWatch Logs