kubetailrb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427b49a8499da9f1c69481130560ba2b783dc122b1a89146e4b2e6ce2f516ec9
-  data.tar.gz: 6be87b2d3529725ef21c2acaee397ddf1989dec3e91bd98f9b99494c6531b9e2
+  metadata.gz: '0916dd6a8baf85b2f7b4771e9d0623fdbe1ff22ca0ea4111cc54ba1fcfab7fd4'
+  data.tar.gz: 051cc8d7bae42f86ce12b2ac43a567674d187170c73f5079aee14f66cb91a44b
 SHA512:
-  metadata.gz: a63a5917935cda345eab9b35f918efdd84778bc58ababf1ede52425cbb71760ac40738cf24ae11596b0c71b373c7aee00b25ec4fc343d0b58deb226e072919f6
-  data.tar.gz: '08b4cb3695fb7704010a0bf868fa3465fe6ee7f0a1b5dafc5e90de3fd83295e8b266aec4555ab2f2840becffcb9f5137564781dbfa8edd69698dff091ebb5d98'
+  metadata.gz: 35a876c94e0a0c812e92d9e1828996c186a7e9179ada8222265ee30925cb20d91ea67f0047661df4c87eb0508b26752ee50de37ef5078740288bb6cb75c38214
+  data.tar.gz: 776f10f0896164550dee36bdae375852b8e374aef9d304c5ddde313202c809fa59ffcf46dbc5a7252464425b695cc62f1536895874c0c4ceeed242d8c41a6763

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.0] - 2024-12-11
+
+- rename `--exclude` flag to `--excludes`
+- add `--mdcs` flag to include specific MDCs
+
 ## [0.2.0] - 2024-12-05
 
 - remove `--pretty` flag

data/README.md

@@ -5,16 +5,6 @@
 
 > Tail your Kubernetes pod logs at the same time.
 
-> [!NOTE]
-> This project is a pet project I used to learn the [Ruby programming language](https://www.ruby-lang.org/en/).
-> So you might find lots of my [personal notes](./journey_log.md) in the codebase.
->
-> If you want to have something that works, please look at the following
-> projects that were used as inspirations instead:
->
-> - https://github.com/stern/stern
-> - https://github.com/johanhaleby/kubetail
-
 ![kubetailrb](./kubetailrb.png)
 
 ## Installation
@@ -51,7 +41,17 @@ kubetailrb 'clock-json' -n sandbox -f
 kubetailrb '^clock(?!-json)' -n sandbox -f
 
 # you can also filter the containers using regex on the container names
-kubetailrb 'clock' -n sandbox -f -c 'json'
+kubetailrb 'clock' -n sandbox -f -c 'my-container'
+
+# you can exclude access logs
+kubetailrb 'clock' -n sandbox -f --excludes access-logs
+# or Datadog logs
+kubetailrb 'clock' -n sandbox -f --excludes dd-logs
+# or both
+kubetailrb 'clock' -n sandbox -f --excludes access-logs,dd-logs
+
+# you can include your MDCs by adding your MDC names separated by a comma
+kubetailrb 'clock' -n sandbox -f --mdcs thread.name,service.version
 ```
 
 ## Development
@@ -94,6 +94,15 @@ Then execute the script:
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/l-lin/kubetailrb.
 
+## Note
+
+This project is a pet project I used to learn the [Ruby programming language](https://www.ruby-lang.org/en/).
+So you might find lots of my [personal notes](./journey_log.md) in the codebase.
+
+If you want to have something that is more complete, please look at
+[stern](https://github.com/stern/stern) project that was used as inspirations
+instead.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/kubetailrb/cmd/help.rb

@@ -23,6 +23,8 @@ module Kubetailrb
                 --display-names Display pod and container names.
             -n, --namespace     Kubernetes namespace to use.
             -c, --container     Container name when multiple containers in pod. Default to '.'.
+            -e, --excludes      Exclude types of log, separated by a comma. Supporting only 'access-logs' and 'dd-logs'.
+            -m, --mdcs          Include MDCs if present in the JSON log, separated by a comma. E.g. 'account.id,thread.name'.
         HELP
       end
 

data/lib/kubetailrb/cmd/k8s.rb

@@ -17,7 +17,9 @@ module Kubetailrb
       DISPLAY_NAMES_FLAG = '--display-names'
 
       CONTAINER_FLAGS = %w[-c --container].freeze
-      EXCLUDE_FLAGS = %w[-e --exclude].freeze
+      EXCLUDES_FLAGS = %w[-e --excludes].freeze
+
+      MDCS_FLAGS = %w[-m --mdcs].freeze
 
       attr_reader :reader
 
@@ -44,7 +46,8 @@ module Kubetailrb
               follow: parse_follow(*args),
               raw: parse_raw(*args),
               display_names: parse_display_names(*args),
-              exclude: parse_exclude(*args)
+              excludes: parse_excludes(*args),
+              mdcs: parse_mdcs(*args)
             )
           )
         end
@@ -65,7 +68,7 @@ module Kubetailrb
         #
         # will return 'sandbox'.
         #
-        # Will raise `MissingNamespaceValueError` if the value is not provided:
+        # Will raise `ArgumentError` if the value is not provided:
         #
         #   kubetailrb some-pod -n
         #
@@ -74,7 +77,7 @@ module Kubetailrb
 
           index = args.find_index { |arg| NAMESPACE_FLAGS.include?(arg) }.to_i
 
-          raise MissingNamespaceValueError, "Missing #{NAMESPACE_FLAGS} value." if args[index + 1].nil?
+          raise ArgumentError, "Missing #{NAMESPACE_FLAGS} value." if args[index + 1].nil?
 
           args[index + 1]
         end
@@ -86,11 +89,11 @@ module Kubetailrb
         #
         # will return 3.
         #
-        # Will raise `MissingNbLinesValueError` if the value is not provided:
+        # Will raise `ArgumentError` if the value is not provided:
         #
         #   kubetailrb some-pod --tail
         #
-        # Will raise `InvalidNbLinesValueError` if the provided value is not a
+        # Will raise `ArgumentError` if the provided value is not a
         # number:
         #
         #   kubetailrb some-pod --tail some-string
@@ -100,11 +103,11 @@ module Kubetailrb
 
           index = args.find_index { |arg| arg == TAIL_FLAG }.to_i
 
-          raise MissingNbLinesValueError, "Missing #{TAIL_FLAG} value." if args[index + 1].nil?
+          raise ArgumentError, "Missing #{TAIL_FLAG} value." if args[index + 1].nil?
 
           last_nb_lines = args[index + 1].to_i
 
-          raise InvalidNbLinesValueError, "Invalid #{TAIL_FLAG} value: #{args[index + 1]}." if last_nb_lines.zero?
+          raise ArgumentError, "Invalid #{TAIL_FLAG} value: #{args[index + 1]}." if last_nb_lines.zero?
 
           last_nb_lines
         end
@@ -122,7 +125,7 @@ module Kubetailrb
 
           index = args.find_index { |arg| CONTAINER_FLAGS.include?(arg) }.to_i
 
-          raise MissingContainerQueryValueError, "Missing #{CONTAINER_FLAGS} value." if args[index + 1].nil?
+          raise ArgumentError, "Missing #{CONTAINER_FLAGS} value." if args[index + 1].nil?
 
           args[index + 1]
         end
@@ -138,35 +141,41 @@ module Kubetailrb
         #
         # will return [access-logs, dd-logs].
         #
-        # Will raise `MissingExcludeValueError` if the value is not provided:
+        # Will raise `ArgumentError` if the value is not provided:
         #
         #   kubetailrb some-pod --exclude
         #
-        def parse_exclude(*args)
-          return [] unless args.any? { |arg| EXCLUDE_FLAGS.include?(arg) }
+        def parse_excludes(*args)
+          return [] unless args.any? { |arg| EXCLUDES_FLAGS.include?(arg) }
 
-          index = args.find_index { |arg| EXCLUDE_FLAGS.include?(arg) }.to_i
+          index = args.find_index { |arg| EXCLUDES_FLAGS.include?(arg) }.to_i
 
-          raise MissingExcludeValueError, "Missing #{EXCLUDE_FLAGS} value." if args[index + 1].nil?
+          raise ArgumentError, "Missing #{EXCLUDES_FLAGS} value." if args[index + 1].nil?
 
           args[index + 1].split(',')
         end
-      end
-    end
-
-    class MissingNbLinesValueError < RuntimeError
-    end
 
-    class MissingNamespaceValueError < RuntimeError
-    end
+        #
+        # Parse MDCs to include from arguments provided in the CLI, e.g.
+        #
+        #   kubetailrb some-pod --mdc account.id,process.thread.name
+        #
+        # will return [account.id, thread.name].
+        #
+        # Will raise `ArgumentError` if the value is not provided:
+        #
+        #   kubetailrb some-pod --mdc
+        #
+        def parse_mdcs(*args)
+          return [] unless args.any? { |arg| MDCS_FLAGS.include?(arg) }
 
-    class MissingContainerQueryValueError < RuntimeError
-    end
+          index = args.find_index { |arg| MDCS_FLAGS.include?(arg) }.to_i
 
-    class MissingExcludeValueError < RuntimeError
-    end
+          raise ArgumentError, "Missing #{MDCS_FLAGS} value." if args[index + 1].nil?
 
-    class InvalidNbLinesValueError < RuntimeError
+          args[index + 1].split(',')
+        end
+      end
     end
   end
 end

data/lib/kubetailrb/formatter/json_formatter.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 require 'kubetailrb/painter'
+require 'kubetailrb/validated'
 
 module Kubetailrb
   module Formatter
     # Format JSON to human readable.
     class JsonFormatter
       include Painter
+      include Validated
+
+      def initialize(mdcs = [])
+        @mdcs = mdcs
+
+        validate
+      end
 
       def format(log)
         json = JSON.parse(log)
@@ -20,16 +28,20 @@ module Kubetailrb
 
       private
 
+      def validate
+        raise_if_nil @mdcs, 'MDCs not set.'
+      end
+
       def access_log?(json)
         json.include?('http.response.status_code') || json.include?('http_status')
       end
 
       def format_access_log(json)
-        "#{json["@timestamp"]}#{http_status_code json}#{http_method json} #{url_path json}"
+        "#{json["@timestamp"]}#{format_http_status_code json}#{http_method json} #{url_path json}"
       end
 
       def format_application_log(json)
-        "#{json["@timestamp"]}#{log_level json}#{json["message"]}#{format_stack_trace json}"
+        "#{json["@timestamp"]}#{format_log_level json}#{format_mdcs json}#{json["message"]}#{format_stack_trace json}"
       end
 
       def format_stack_trace(json)
@@ -40,7 +52,7 @@ module Kubetailrb
         "\n#{stack_trace}"
       end
 
-      def http_status_code(json)
+      def format_http_status_code(json)
         code = json['http.response.status_code'] || json['http_status']
 
         return " #{highlight_blue(" I ")} [#{code}] " if code >= 200 && code < 400
@@ -50,7 +62,7 @@ module Kubetailrb
         " #{code} "
       end
 
-      def log_level(json)
+      def format_log_level(json)
         level = json['log.level'] || json.dig('log', 'level')
         return ' ' if level.nil? || level.strip.empty?
         return " #{highlight_blue(" I ")} " if level == 'INFO'
@@ -67,6 +79,15 @@ module Kubetailrb
       def url_path(json)
         json['url.path'] || json['http_path']
       end
+
+      def format_mdcs(json)
+        result = ''
+        @mdcs.each do |mdc|
+          value = json[mdc] || json.dig(*mdc.split('.'))
+          result += "#{cyan("#{mdc}=#{value}")} " unless value.nil?
+        end
+        result.to_s
+      end
     end
   end
 end

data/lib/kubetailrb/k8s_opts.rb

@@ -7,15 +7,27 @@ module Kubetailrb
   class K8sOpts
     include Validated
 
-    attr_reader :namespace, :last_nb_lines, :exclude
-
-    def initialize(namespace:, last_nb_lines:, follow:, raw:, display_names:, exclude:) # rubocop:disable Metrics/ParameterLists
+    DEFAULT_NAMESPACE = 'default'
+    DEFAULT_NB_LINES = 10
+
+    attr_reader :namespace, :last_nb_lines, :excludes, :mdcs
+
+    def initialize( # rubocop:disable Metrics/ParameterLists
+      namespace: DEFAULT_NAMESPACE,
+      last_nb_lines: DEFAULT_NB_LINES,
+      follow: false,
+      raw: false,
+      display_names: false,
+      excludes: [],
+      mdcs: []
+    )
       @namespace = namespace
       @last_nb_lines = last_nb_lines
       @follow = follow
       @raw = raw
       @display_names = display_names
-      @exclude = exclude
+      @excludes = excludes
+      @mdcs = mdcs
 
       validate
     end
@@ -40,7 +52,8 @@ module Kubetailrb
       validate_boolean @follow, "Invalid follow: #{@follow}."
       validate_boolean @raw, "Invalid raw: #{@raw}."
       validate_boolean @display_names, "Invalid display names: #{@display_names}."
-      raise_if_nil @exclude, 'Exclude not set'
+      raise_if_nil @excludes, 'Excludes not set.'
+      raise_if_nil @mdcs, 'MDCs not set.'
     end
   end
 end

data/lib/kubetailrb/painter.rb

@@ -11,6 +11,10 @@ module Kubetailrb
       colorize(text, '31')
     end
 
+    def cyan(text)
+      colorize(text, '36')
+    end
+
     def highlight_blue(text)
       colorize(text, '1;30;44')
     end

data/lib/kubetailrb/reader/k8s_pod_reader.rb

@@ -23,7 +23,7 @@ module Kubetailrb
         @pod_name = pod_name
         @container_name = container_name
         @formatter = create_formatter(opts, pod_name, container_name)
-        @filter = Kubetailrb::Filter::LogFilter.create(opts.exclude)
+        @filter = Kubetailrb::Filter::LogFilter.create(opts.excludes)
         @opts = opts
       end
 
@@ -95,7 +95,7 @@ module Kubetailrb
         formatter = if opts.raw?
                       Kubetailrb::Formatter::NoOpFormatter.new
                     else
-                      Kubetailrb::Formatter::JsonFormatter.new
+                      Kubetailrb::Formatter::JsonFormatter.new(opts.mdcs)
                     end
 
         if opts.display_names?

data/lib/kubetailrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kubetailrb
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubetailrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Louis Lin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kubeclient