aix-errlog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e98415b5db1bba3a83301429dbc6fb7d8e5f860a35c75225596c3f3493f9df
-  data.tar.gz: 77e593f0c156f3dd12209eed4806d7d87e0cf15710ef42dbb3eb96f0804dc043
+  metadata.gz: e5294c01b19b7bd0a1977c511df790d5d002c34fa968c4c1ccc432d927f7406a
+  data.tar.gz: a7e9fe17605da84b4f4c0cc694c99886a3690859cbf52a37854a045e151a6e0f
 SHA512:
-  metadata.gz: 7f20031f90faa552c4f99795b9fd2395b9658cd3b2aa3a02590b10bc68d3615ffab59fc21aeb84fb9ae46512f4644539a899ea97a79067325a065082845ecdc3
-  data.tar.gz: 6d8753b599485fdc819c80e646d5b318794ed49ce89ad5112af38efa804fcb8982344f7b8891a84f6df8befc34a511c66e00e98799596c094a2732729fb2094a
+  metadata.gz: ee963b63a3877ca69c5e180e7f20613ac41c0a9ba424cdda648e1ba9aefb089b4280d8b7212081ea9e74dfe3f792a7edd7bbd82dd2d7cfc80f69d46e5953c286
+  data.tar.gz: 6d34ac53693e129524de2ddeac04559e1ed8a33d0cc0c12b80090977e95316bf8d54b04e9e229fbdcb5c2541be7404c2f83dca0bf671ed141124042efba29eab

data/lib/aix/errlog/entry.rb

@@ -4,14 +4,21 @@ require 'aix/errlog/constants'
 
 module AIX
   module Errlog
+    PARSE_REGEX = /(?:^Detail Data$\n(.*?))?(?:^Symptom Data$\n(.*))?\z/m.freeze
+
     ##
     # An errlog entry class.  Used to parse the raw errlog_entry_t struct into a
     # more useful Ruby object.
     # 
     # You shouldn't need to invoke this class directly; it is generated by the
     # Errlog#forward_each and Errlog#reverse_each.
+    #
+    # Unfortunately, the retreived detail and symptom fields aren't horribly
+    # useful, and IBM has presented no API for parsing these correctly, so the
+    # only canonical path to getting the correct detail and symptom data is
+    # through a call to the errpt command.
     class Entry
-      attr_reader :magic, :sequence, :label, :timestamp, :crcid, :errdiag, :machineid, :nodeid, :class, :type, :resource, :rclass, :rtype, :vpd_ibm, :vpd_user, :in, :connwhere, :flags, :detail, :symptom, :dup_count, :dup_time1, :dup_time2, :wparid
+      attr_reader :magic, :sequence, :label, :timestamp, :crcid, :errdiag, :machineid, :nodeid, :class, :type, :resource, :rclass, :rtype, :vpd_ibm, :vpd_user, :in, :connwhere, :flags, :raw_detail, :raw_symptom, :dup_count, :dup_time1, :dup_time2, :wparid
 
       def initialize(raw)
         @magic = raw[:el_magic]
@@ -33,14 +40,37 @@ module AIX
         @connwhere = raw[:el_connwhere].to_s.freeze
         @flags = raw[:el_flags]
         length = raw[:el_detail_length]
-        @detail = raw[:el_detail_data].to_ptr.get_bytes(0, length).freeze
+        @raw_detail = raw[:el_detail_data].to_ptr.get_bytes(0, length).freeze
         length = raw[:el_symptom_length]
-        @symptom = raw[:el_symptom_data].to_ptr.get_bytes(0, length).freeze
+        @raw_symptom = raw[:el_symptom_data].to_ptr.get_bytes(0, length).freeze
         @dup_count = raw[:el_errdup][:ed_dupcount]
         @dup_time1 = Time.at(raw[:el_errdup][:ed_time1]).freeze
         @dup_time2 = Time.at(raw[:el_errdup][:ed_time2]).freeze
         @wparid = raw[:el_wparid].to_s.freeze
       end
+
+      def errpt
+        @errpt ||= %x(errpt -al#{@sequence}).freeze
+      end
+
+      def parse_errpt
+        unless @parsed
+          @detail, @symptom = errpt.match(PARSE_REGEX).captures
+          @detail ||= ''.freeze
+          @symptom ||= ''.freeze
+          @detail.freeze
+          @symptom.freeze
+          @parsed = true
+        end
+      end
+      def detail
+        parse_errpt unless @parsed
+        @detail 
+      end
+      def symptom
+        parse_errpt unless @parsed
+        @symptom 
+      end
     end
   end
 end

data/lib/aix/errlog/errlog.rb

@@ -30,11 +30,10 @@ module AIX
     # operates as a cursor, so if you try to re-invoke one before it is
     # finished, the cursor will get reset, and you'll get jumbled results).
     # While one of these enumerators as active, trying to re-invoke one will
-    # raise an EnumeratorError.
+    # raise an Errors::EnumeratorError.
     #
-    # If you need to do complex matching, use the #match_* methods in here to
-    # create Match objects to work with.  You can see Match for more details as
-    # to how to create those.
+    # If you need to do complex matching, use #match or ::match to build a match
+    # expression using a DSL.
     #
     # A simple example, showing how to get a list of all labels of all log
     # entries in forward order which contain the string 'KILL' in their label
@@ -47,19 +46,19 @@ module AIX
     #   require 'aix/errlog'
     #
     #   AIX::Errlog.open do |log|
-    #     log.forward_each(match: (
-    #       log.match_label.include?('KILL') & (
+    #     log.forward_each(match: log.match {
+    #       label.include?('KILL') & (
     #         (
-    #           (log.match_sequence > 1000) &
-    #           (log.match_timestamp >= DateTime.new(2017, 1, 1)) &
-    #           (log.match_timestamp < DateTime.new(2017, 2, 1))
+    #           (sequence > 1000) &
+    #           (timestamp >= DateTime.new(2017, 1, 1)) &
+    #           (timestamp < DateTime.new(2017, 2, 1))
     #         ) | (
-    #           (log.match_sequence < 500) &
-    #           (log.match_timestamp >= DateTime.new(2016, 12, 1)) &
-    #           (log.match_timestamp < DateTime.new(2017, 1, 1))
+    #           (sequence < 500) &
+    #           (timestamp >= DateTime.new(2016, 12, 1)) &
+    #           (timestamp < DateTime.new(2017, 1, 1))
     #         )
     #       )
-    #     )).map(&:label)
+    #     }).map(&:label)
     #   end
     #
     # Certainly, that looks a little complex, but it is a bit more efficient
@@ -156,7 +155,7 @@ module AIX
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
       # methods while another has not finished and exited, you'll raise an
-      # EnumeratorError.  You can create an enumerator of one within the other,
+      # Errors::EnumeratorError.  You can create an enumerator of one within the other,
       # as long as you don't activate it until the first one has exited.
       #
       # Warning: if the sequence does not exist (which is common when error logs
@@ -190,7 +189,7 @@ module AIX
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
       # methods while another has not finished and exited, you'll raise an
-      # EnumeratorError.  You can create an enumerator of one within the other,
+      # Errors::EnumeratorError.  You can create an enumerator of one within the other,
       # as long as you don't activate it until the first one has exited.
       #
       # Warning: if the sequence does not exist (which is common when error logs
@@ -208,129 +207,33 @@ module AIX
       end
 
       ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # sequence.
-      def match_sequence
-        Match.new(left: :sequence)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # label.
-      def match_label
-        Match.new(left: :label)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # timestamp.
-      def match_timestamp
-        Match.new(left: :timestamp)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # crcid.
-      def match_crcid
-        Match.new(left: :crcid)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # machineid.
-      def match_machineid
-        Match.new(left: :machineid)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # nodeid.
-      def match_nodeid
-        Match.new(left: :nodeid)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # class.
-      def match_class
-        Match.new(left: :class)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # type.
-      def match_type
-        Match.new(left: :type)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # resource.
-      def match_resource
-        Match.new(left: :resource)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # rclass.
-      def match_rclass
-        Match.new(left: :rclass)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # rtype.
-      def match_rtype
-        Match.new(left: :rtype)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # vpd_ibm.
-      def match_vpd_ibm
-        Match.new(left: :vpd_ibm)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # vpd_user.
-      def match_vpd_user
-        Match.new(left: :vpd_user)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against in.
-      def match_in
-        Match.new(left: :in)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # connwhere.
-      def match_connwhere
-        Match.new(left: :connwhere)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # flag_err64.
-      def match_flag_err64
-        Match.new(left: :flag_err64)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # flag_errdup.
-      def match_flag_errdup
-        Match.new(left: :flag_errdup)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # detail_data.
-      def match_detail_data
-        Match.new(left: :detail_data)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # symptom_data.
-      def match_symptom_data
-        Match.new(left: :symptom_data)
-      end
-      ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # errdiag.
-      def match_errdiag
-        Match.new(left: :errdiag)
+      # Calls ::match
+      def match(&block)
+        Errlog.match(&block)
       end
+
       ##
-      # Match convenience function.  Gets a Leaf match for comparing against
-      # wparid.
-      def match_wparid
-        Match.new(left: :wparid)
+      # Used to build a match expression using a DSL.  This simply calls
+      # instance_eval on Match, so remember the semantics of block scope.  If
+      # you have a local +sequence+ variable, for instance, you'll need to use
+      # an explicit self to escape that:
+      #
+      #     [2] pry(main)> AIX::Errlog::Errlog.match { sequence }
+      #     => #<AIX::Errlog::Match:0xeb32a4df @left=:sequence, @operator=nil, @right=nil>
+      #     [3] pry(main)> sequence = 5
+      #     => 5
+      #     [4] pry(main)> AIX::Errlog::Errlog.match { sequence }
+      #     => 5
+      #     [5] pry(main)> AIX::Errlog::Errlog.match { self.sequence }
+      #     => #<AIX::Errlog::Match:0xcb7d8c03 @left=:sequence, @operator=nil, @right=nil>
+      #     [6] pry(main)> AIX::Errlog::Errlog.match { self.sequence > sequence }
+      #     => #<AIX::Errlog::Match:0x7be0bbf5 @left=:sequence, @operator=:gt, @right=5>
+      #
+      # In any case, this function lets you use a block as a shortcut to call a
+      # bunch of public class methods on the Match class, in order to build
+      # complex match expressions, as shown in the summary of this class.
+      def self.match(&block)
+        Match.instance_eval(&block)
       end
 
       private
@@ -344,7 +247,7 @@ module AIX
         return if status == :done
         Errors.throw(status, "handle: #{@handle}, sequence: #{id}") unless status == :ok
 
-        Entry.new(entry).freeze
+        Entry.new(entry)
       end
 
       ##
@@ -356,7 +259,7 @@ module AIX
         return if status == :done
         Errors.throw(status, "handle: #{@handle}, match: #{match}") unless status == :ok
 
-        Entry.new(entry).freeze
+        Entry.new(entry)
       end
 
       ##
@@ -366,7 +269,7 @@ module AIX
         status = Lib.errlog_find_next(@handle, entry)
         return if status == :done
         Errors.throw(status, "handle: #{@handle}") unless status == :ok
-        Entry.new(entry).freeze
+        Entry.new(entry)
       end
 
       ##
@@ -393,7 +296,7 @@ module AIX
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
       # methods while another has not finished and exited, you'll raise an
-      # EnumeratorError.  You can create an enumerator of one within the other,
+      # Errors::EnumeratorError.  You can create an enumerator of one within the other,
       # as long as you don't activate it until the first one has exited.
       #
       # Warning: if the sequence does not exist (which is common when error logs

data/lib/aix/errlog/match.rb

@@ -9,8 +9,7 @@ module AIX
     # A class that is useful for building errlog matchers.
     #
     # You usually won't need to access this class directly; you'll be able to
-    # create instances of it indirectly through the field accessors that are
-    # available in Errlog.
+    # create instances of it indirectly through the use of Errlog::match
     #
     # You can build field matchers using the methods on the errlog and standard
     # logical operators, and there are standard conversions for certain things
@@ -18,18 +17,18 @@ module AIX
     # entries only in January 2018 with +FOO+ in the label somewhere, you cold
     # use a match like this with an Errlog instance.
     #
-    #   (
-    #     (errlog.match_timestamp >= DateTime.new(2018, 1, 1)) &
-    #     (errlog.match_timestamp < DateTime.new(2018, 2, 1)) &
-    #     errlog.match_label.include?('FOO')
-    #   )
+    #   errlog.match {
+    #     (timestamp >= DateTime.new(2018, 1, 1)) &
+    #     (timestamp < DateTime.new(2018, 2, 1)) &
+    #     label.include?('FOO')
+    #   }
     #
     # It really is that easy.  The rest of the magic is done for you behind the
     # scenes, as long as you follow the rules and know how to make these matches
     # in the C equivalent.  Note that there must always be a Match on the left
     # side of all comparisons, so something like 
     #
-    #   DateTime.new(2018, 1, 1) <= errlog.match_timestamp
+    #   DateTime.new(2018, 1, 1) <= errlog.match{timestamp}
     #
     # is not possible.
     # 
@@ -151,6 +150,132 @@ module AIX
           operator: :not,
         )
       end
+
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # sequence.
+      def self.sequence
+        new(left: :sequence)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # label.
+      def self.label
+        new(left: :label)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # timestamp.
+      def self.timestamp
+        new(left: :timestamp)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # crcid.
+      def self.crcid
+        new(left: :crcid)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # machineid.
+      def self.machineid
+        new(left: :machineid)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # nodeid.
+      def self.nodeid
+        new(left: :nodeid)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # class.
+      def self.class
+        new(left: :class)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # type.
+      def self.type
+        new(left: :type)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # resource.
+      def self.resource
+        new(left: :resource)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # rclass.
+      def self.rclass
+        new(left: :rclass)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # rtype.
+      def self.rtype
+        new(left: :rtype)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # vpd_ibm.
+      def self.vpd_ibm
+        new(left: :vpd_ibm)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # vpd_user.
+      def self.vpd_user
+        new(left: :vpd_user)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against in.
+      def self.in
+        new(left: :in)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # connwhere.
+      def self.connwhere
+        new(left: :connwhere)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # flag_err64.
+      def self.flag_err64
+        new(left: :flag_err64)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # flag_errdup.
+      def self.flag_errdup
+        new(left: :flag_errdup)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # detail_data.
+      def self.detail_data
+        new(left: :detail_data)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # symptom_data.
+      def self.symptom_data
+        new(left: :symptom_data)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # errdiag.
+      def self.errdiag
+        new(left: :errdiag)
+      end
+      ##
+      # Match convenience function.  Gets a Leaf match for comparing against
+      # wparid.
+      def self.wparid
+        new(left: :wparid)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aix-errlog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Taylor C. Richberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi