Class: AwsLogs::Tail

Inherits:
Base
  • Object
show all
Defined in:
lib/aws_logs/tail.rb

Constant Summary collapse

@@end_loop_signal =

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.

false

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AwsServices

#cloudwatchlogs

Constructor Details

#initialize(options = {}) ⇒ Tail

Returns a new instance of Tail.



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/aws_logs/tail.rb', line 5

def initialize(options={})
  super
  # Setting to ensure matches default CLI option
  @follow = @options[:follow].nil? ? true : @options[:follow]

  @loop_count = 0
  @output = [] # for specs
  reset
  set_trap
end

Class Method Details

.stop_follow! ⇒ Object 



142
143
144
 
# File 'lib/aws_logs/tail.rb', line 142

def self.stop_follow!
  @@end_loop_signal = true
end

Instance Method Details

#check_follow_until! ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/aws_logs/tail.rb', line 115

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

#data(since = "1d", quiet_not_found = false) ⇒ Object 



16
17
18
19
20
21
22
23
 
# File 'lib/aws_logs/tail.rb', line 16

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}" unless quiet_not_found
  []
end

#display ⇒ Object

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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aws_logs/tail.rb', line 97

def display
  new_events = @events
  shown_index = new_events.find_index { |e| e.event_id == @last_shown_event_id }
  if shown_index
    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]
    format = @options[:format] || "detailed"
    line.insert(1, e.log_stream_name.color(:purple)) if format == "detailed"
    say line.join(' ') unless @options[:silence]
  end
  @last_shown_event_id = @events.last&.event_id
  check_follow_until!
end

#filter_log_events(start_time, end_time, next_token = nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aws_logs/tail.rb', line 78

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,
    # limit: 1000,
    # interleaved: true,
  }

  options[:log_stream_names] = @options[:log_stream_names] if @options[:log_stream_names]
  options[:log_stream_name_prefix] = @options[:log_stream_name_prefix] if @options[:log_stream_name_prefix]
  options[:filter_pattern] = @options[:filter_pattern] if @options[:filter_pattern]
  options[:next_token] = next_token if next_token != :start && !next_token.nil?

  cloudwatchlogs.filter_log_events(options)
end

#output ⇒ Object 



127
128
129
 
# File 'lib/aws_logs/tail.rb', line 127

def output
  @output.join("\n") + "\n"
end

#refresh_events(start_time, end_time) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aws_logs/tail.rb', line 64

def refresh_events(start_time, end_time)
  @events = []
  next_token = :start

  # TODO: can hit throttle limit if there are lots of pages
  while next_token
    resp = filter_log_events(start_time, end_time, next_token)
    @events += resp.events
    next_token = resp.next_token
  end

  @events
end

#reset ⇒ Object 



25
26
27
28
29
 
# File 'lib/aws_logs/tail.rb', line 25

def reset
  @events = [] # constantly replaced with recent events
  @last_shown_event_id = nil
  @completed = nil
end

#run ⇒ Object

The start and end time is useful to limit results and make the API fast. We’ll leverage it like so:

1. load all events from an initial since time
2. after that load events pass that first window

It’s a sliding window of time we’re using.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/aws_logs/tail.rb', line 38

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
  since, now = initial_since, current_now
  until end_loop?
    refresh_events(since, now)
    display
    since, now = now-overlap, current_now
    loop_count!
    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

#say(text) ⇒ Object 



123
124
125
 
# File 'lib/aws_logs/tail.rb', line 123

def say(text)
  ENV["AWS_LOGS_TEST"] ? @output << text : puts(text)
end

#set_trap ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/aws_logs/tail.rb', line 131

def set_trap
  Signal.trap("INT") {
    puts "\nCtrl-C detected. Exiting..."
    exit # immediate exit
  }
end