chopshop-logreader 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa1d6a0266d4f7ee6fe20dd3a0d0e5042e1f587f5d276ba11a514b811742ff1c
-  data.tar.gz: d90185bece540bbce81b47e31a8346ad976f17ed54688d0234c26a3f277c62bf
+  metadata.gz: ed7a741e3549b4d7b48cc7a30bb099a9debda0378c2d9873cea0ba07fafcad2d
+  data.tar.gz: 9b8f94a7360e0319370c5391a547f2ad874833a27ff00e4325a7731e30fb908d
 SHA512:
-  metadata.gz: 3bd32954bfc925ff2194b51ea5704764152b248134a5e228b30973d5f7c2991fb8cccf540db357193fe76508a2ba03cb54dc271223cf1a4946ed2fc035614045
-  data.tar.gz: a993a805d2f281005b75b64cbc94deae2fc1401ec19d29a5f08370e6f426cc28c13664349050c21703b6394afefd34d21a286b33b2939537afd5ca01bdc6bf36
+  metadata.gz: e2a513f331481b74f60a122b318552826d08d8fca8dcb651e212ca4fbad37257378efe8f286490aae16d02428814b918ba0ee3f5f262503a2bdc6ca3462e52b7
+  data.tar.gz: 3fc6ad5d1c1fbe8810132e45258672728079e1ebcb5871755b7ae8432025224d75e85bc12e142fd0c015836152788bf7122e1fa4fdb64076d54e81ab8266b2a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chopshop-logreader (0.2.3)
+    chopshop-logreader (0.2.4)
 
 GEM
   remote: https://rubygems.org/

data/lib/chopshop/logreader/executor.rb

@@ -3,8 +3,12 @@ require "chopshop/logreader/parser"
 module Chopshop
   module Logreader
     class Executor
-      attr_reader :parser
+      attr_reader :parser, :options, :profile, :tenant,
+        :region, :namespace, :container, :service_name
 
+      # The regex + time calculator takes the human readable output from the kubernetes CLI
+      # and calculates how long any given pod has been running. It then selects the most
+      # recently pod/shortest living pod
       REGEX = /(?<t1>\d+)(?<v1>[a-z]+)(?<t2>\d*)(?<v2>[a-z]*)/i
       TIME_CALCULATOR = {
         "s" => 1,
@@ -22,32 +26,43 @@ module Chopshop
         @parser = Chopshop::Logreader::Parser.new
       end
 
-      def execute!
-        options = @parser.parse 
-        profile = options.profile || ENV["AWS_PROFILE"] || ENV["PROFILE"]
-        tenant = options.tenant || ENV["DEFAULT_TENANT"]
-        region = options.region || ENV["AWS_REGION"] || "us-east-1"
-        container = options.container
+      def parse_options
+        @options = @parser.parse
+        @profile = options.profile || ENV["AWS_PROFILE"] || ENV["PROFILE"]
+        @tenant = options.tenant || ENV["DEFAULT_TENANT"]
+        @region = options.region || ENV["AWS_REGION"] || "us-east-1"
+        @namespace = options.namespace || ENV["K8_NAMESPACE"] || "connect"
+        @container = options.container
+        @service_name = ARGV[0]
+      end
 
+      def execute!
+        parse_options
         service = nil
-        service_name = ARGV[0]
+
+        # log into the EKS cluster, may require 2FA authing here.
         `rally-kubectl -a #{region} -e #{profile} -t #{tenant}`
         puts "looking for valid service container"
         while !service
-          services = `kubectl get pods --namespace #{options.namespace} | grep #{service_name}`
+          services = `kubectl get pods --namespace #{namespace} | grep #{service_name}`
           service = services.split("\n").map {|line| line.split(" ") }.each do |line|
+            # get the length of time the pod has been running from the kubernetes CLI output
             match_data = REGEX.match(line[4])
+            # calculate the human readable version of time into a single integer for comparison
             line[5] = TIME_CALCULATOR[match_data.captures[1].downcase] * match_data.captures[0].to_i + TIME_CALCULATOR[match_data.captures[3].downcase] * match_data.captures[2].to_i
+            # select the most recent/shortest living pod
           end.select{|line| line[2] == options.status }.sort_by {|line| line[5] }.first
 
+          # if we have a pod we want logs from, then get logs and be done
           if service
             if container
-              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace connect --container=#{container} #{service[0]}"
+              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace #{namespace} --container=#{container} #{service[0]}"
             else
-              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace connect #{service[0]}"
+              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace #{namespace} #{service[0]}"
             end
           end
 
+          # no pod with logs, wait 1 second and try again.
           print "."
           sleep 1
         end

data/lib/chopshop/logreader/parser.rb

@@ -9,7 +9,7 @@ module Chopshop
           follow: true, # follow output from log file
           lines: -1, # whole file always,
           status: "Running", # look for a currently running service
-          namespace: "connect",
+          namespace: nil,
           tenant: nil,
           profile: nil,
           region: nil,
@@ -32,8 +32,8 @@ module Chopshop
             options[:status] = status
           end
 
-          opts.on("-n [NAMESPACE]", "--namespace [NAMESPACE]", "sets the kubernetes namespace to look for service/job in. default: connect", String) do |status|
-            options[:status] = status
+          opts.on("-n [NAMESPACE]", "--namespace [NAMESPACE]", "sets the kubernetes namespace to look for service/job in. default: connect", String) do |namespace|
+            options[:namespace] = namespace
           end
 
           opts.on("-p [PROFILE]", "--profile [PROFILE]", "chooses the cloud profile to use for permissions. default: nil.  You must provide this value or set the ENV VAR AWS_PROFILE' or the ENV VAR 'PROFILE'", String) do |profile|
@@ -64,4 +64,4 @@ module Chopshop
       end
     end
   end
-end
+end

data/lib/chopshop/logreader/version.rb

@@ -1,5 +1,5 @@
 module Chopshop
   module Logreader
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chopshop-logreader
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Travis Perdue
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler