aws-logs 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56d76017d06966a77c263a2aaa65e2925882cc919e2f3baff52276b5b1f53b05
-  data.tar.gz: 0f60ef45cdea2a00de22c924b2815f14be84fc59dd16957f527416ad58ac6eb7
+  metadata.gz: e2d97ba7271f44e4d07374bf86cb6925ada130f8359f4efa1c56ecb7903d7d0c
+  data.tar.gz: 8faef88a6dbf7c0a0ed7f9d10d2a7975fd942fb89a5fc88ea43a29cac645c0ee
 SHA512:
-  metadata.gz: db6f055ed5ef2094493f22484bf2fa56c40977980b915583aa61c72c2e74fc8675a5c3a4992d64ec15e042aa9692eec7e0f696f57e39b3f2fd0722a79657d402
-  data.tar.gz: e3970d0c5db5c4eb363a02333d7262a87359cd73577aad5b986fba4c78ed9d33bedb5b9becdbefe614eac554bdfa170d4405a1df0cae68d55740b627591bec9e
+  metadata.gz: ebcf238f59349ec1ba0abc6e4f285db9b23062f9d1d35085af59d16b976bd0ba84a0bf37740fd8726cc33fe9f8607cc286faefbd5b3d55a5134dcd30ea796f83
+  data.tar.gz: 27a69941be1c6b4ec8b62850eafb7764f47b3995bdabff1dd780120f9d8091c060567d2d8834b409efd71042a3fa4fa4e5b3b2fefa207c506f074e070b0cdba2

data/CHANGELOG.md

@@ -3,5 +3,22 @@
 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.3.3]
+- #2 add overlap to window to account for delayed logs received at the same time
+
+## [0.3.2]
+- #1 clean up end_loop_signal logic
+
+## [0.3.1]
+- fix --no-follow option
+
+## [0.3.0]
+- display final logs upon stop_follow!
+
+## [0.2.0]
+- add stop_follow! method
+- friendly error message when log not found
+- improve `@follow` default, `@log_group_name` and stdout sync true by default
+
 ## [0.1.0]
 - Initial release.

data/README.md

@@ -1,4 +1,4 @@
-# AwsLogs
+# aws-logs
 
 [![Gem Version](https://badge.fury.io/rb/GEMNAME.png)](http://badge.fury.io/rb/GEMNAME)
 
@@ -12,7 +12,7 @@ Tail AWS CloudWatch Logs.
 
 ## Examples
 
-Here's a couple of examples where the `LOG_GROUP=/aws/codebuild/demo`:
+Here's a couple of examples where `LOG_GROUP=/aws/codebuild/demo`:
 
     aws-logs tail /aws/codebuild/demo --since 60m
     aws-logs tail /aws/codebuild/demo --since "2018-08-08 08:00:00"
@@ -25,15 +25,7 @@ Here's a couple of examples where the `LOG_GROUP=/aws/codebuild/demo`:
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem "aws-logs"
-
-And then execute:
-
-    bundle
-
-Or install it yourself as:
+Install with:
 
     gem install aws-logs
 

data/lib/aws_logs.rb

@@ -1,3 +1,5 @@
+$stdout.sync = true unless ENV["AWS_LOGS_STDOUT_SYNC"] == "0"
+
 $:.unshift(File.expand_path("../", __FILE__))
 require "aws_logs/version"
 require "rainbow/ext/string"

data/lib/aws_logs/cli.rb

@@ -9,8 +9,8 @@ module AwsLogs
     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"
     option :follow_until, desc: "Exit out of the follow loop once this text is found."
-    def tail(log_group)
-      Tail.new(options.merge(log_group: log_group)).run
+    def tail(log_group_name)
+      Tail.new(options.merge(log_group_name: log_group_name)).run
     end
 
     desc "completion *PARAMS", "Prints words for auto-completion."

data/lib/aws_logs/help/tail.md

@@ -41,4 +41,17 @@ Since supports these formats:
 * d - days
 * w - weeks
 
-Since does not current support combining the formats. IE: 5m30s.
+Since does not support combining the formats. IE: 5m30s.
+
+## Filter Pattern
+
+The `--filter-pattern` option is quite powerful as CloudWatch supports a full
+[Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
+
+To match terms with spaces in it, you'll need quotes around it. Otherise, the match will be an OR of the terms. Example:
+
+    aws-logs tail /aws/codebuild/demo --filter-pattern '"Wed Nov 27 23"' --since 3h --no-follow
+
+Here's an example of matching with an exclude pattern using the `-` (minus sign).
+
+    aws-logs tail /aws/codebuild/demo --filter-pattern '"ERROR" - "Exiting"' --since 3h --no-follow

data/lib/aws_logs/tail.rb

@@ -6,7 +6,9 @@ module AwsLogs
 
     def initialize(options={})
       @options = options
-      @log_group = options[:log_group]
+      @log_group_name = options[:log_group_name]
+      # Setting to ensure matches default CLI option
+      @follow = @options[:follow].nil? ? true : @options[:follow]
 
       @loop_count = 0
       @output = [] # for specs
@@ -14,15 +16,6 @@ module AwsLogs
       set_trap
     end
 
-    @@end_loop_signal = false
-    def set_trap
-      Signal.trap("INT") {
-        puts "\nCtrl-C detected. Exiting..."
-        @@end_loop_signal = true  # delayed exit, usefu control loop flow though
-        exit # immediate exit
-      }
-    end
-
     def reset
       @events = [] # constantly replaced with recent events
       @last_shown_event_id = nil
@@ -42,14 +35,24 @@ module AwsLogs
         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
       since, now = initial_since, current_now
-      while true && !end_loop?
+      until end_loop?
         refresh_events(since, now)
         display
-        since, now = now, current_now
+        since, now = now-overlap, current_now
         loop_count!
-        sleep 5 if @options[:follow] && !@@end_loop_signal && !ENV["AWS_LOGS_TEST"]
+        sleep 5 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
+      puts "ERROR: #{e.class}: #{e.message}".color(:red)
+      puts "Log group #{@log_group_name} not found."
     end
 
     def refresh_events(start_time, end_time)
@@ -59,7 +62,7 @@ module AwsLogs
       # TODO: can hit throttle limit if there are lots of pages
       while next_token
         options = {
-          log_group_name: @log_group, # required
+          log_group_name: @log_group_name, # required
           start_time: start_time,
           end_time: end_time,
           # limit: 10,
@@ -101,9 +104,7 @@ module AwsLogs
       return unless follow_until
 
       messages = @events.map(&:message)
-      if messages.detect { |m| m.include?(follow_until) }
-        @@end_loop_signal = true
-      end
+      @@end_loop_signal = messages.detect { |m| m.include?(follow_until) }
     end
 
     def say(text)
@@ -114,6 +115,21 @@ module AwsLogs
       @output.join("\n") + "\n"
     end
 
+    def set_trap
+      Signal.trap("INT") {
+        puts "\nCtrl-C detected. Exiting..."
+        exit # immediate exit
+      }
+    end
+
+    # 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 self.stop_follow!
+      @@end_loop_signal = true
+    end
+
   private
     def initial_since
       since = @options[:since]
@@ -136,7 +152,7 @@ module AwsLogs
 
     # Useful for specs
     def max_loop_count
-      @options[:follow] ? nil : 1
+      @follow ? nil : 1
     end
   end
 end

data/lib/aws_logs/version.rb

@@ -1,3 +1,3 @@
 module AwsLogs
-  VERSION = "0.1.0"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-logs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport