WebSVN – DevTools – Diff – /dpkg_management/trunk/src/sbin/jats_quarantine.pl

 # May be supplemented by xxx.cnf file
 my %retainPkgs = (
     'core_devl' => 1,
 );
+#
+#   Statistics
+#   Listed here to ensure that they exist in the stats file
+#
+my %statistics = (
+    timeStamp               => 0,               # Age of the stats file
+    statsName               => 'Quarantine',    # Name of the stats file
+    state                   => 'OK',            # Overall reported state
+    # Error counters
+    QuarantineError         => 0,
+    S3TransferError         => 0,
+    # Major Statistics
+    Quarantine              => 0,
+    # Minor Statistics
+    fileNotInReleaseManager => 0,
+    inDeploymentManager     => 0,
+    inSdk                   => 0,
+    isPatch                 => 0,
+    ManualBuild             => 0,
+    RetainTime              => 0,
+    NoBuildStandard         => 0,
+    NoPackageEntry          => 0,
+    NoPVid                  => 0,
+    NotInArchive            => 0,
+    NotInReleaseManager     => 0,
+    NotLocked               => 0,
+    SecondLevelPackage      => 0,
+    TopLevelPackage         => 0,
+    TotalPackages           => 0,
+    ZeroTime                => 0,
+);
 #-------------------------------------------------------------------------------
 # Function        : Main Entry
+#
 # Description     :
+#
     prepQdir();
     unless ($opt_purge) {
         readInputData();
         processDpkgArchive();
         reportMissingPkgs();
+        reportStats();
+    }
     Verbose ("Quarantine to: $quarantineInstance");
     Verbose ("Log to: $logPath");
+}
+                    {
+                        #
                         #   Package is in dpkg-archive, but not in Release
                         #   Manager. Allow for a short while
+                        #
+                        $statistics{TotalPackages}++;
+                        $statistics{'NotInReleaseManager'}++;
                         if ( $mtime > $config{retainNoRm} )
+                        {
                             #Log("Package not in RM: $pkgName, $pkgVersion, Age: $mtime");
                             quarantineItem( 'X', $mtime, $pkgPath );
+                            $statistics{'Quarantine'}++;
+                        }
+                        if ($opt_explain)
+                        {
+                            Information("Reason:-, $pkgName, $pkgVersion, Reason:NotInReleaseManager");
+                        }
+                    }
 #Message("$pkgName, $pkgVersion, $pkgPvid{$pkgName}{$pkgVersion}{mtime}");
+                }
         elsif ( -f $pkgDir )
+        {
             Warning("Unexpected file in dpkg_archive: $pkgName");
             Log("Unexpected file in dpkg_archive: $pkgName");
             quarantineItem( 'F', -1, $pkgDir );
+            $statistics{'fileNotInReleaseManager'}++;
+            $statistics{'Quarantine'}++;
+            $statistics{'NotInReleaseManager'}++;
+            if ($opt_explain)
+            {
+                Information("Reason:-, $pkgDir, -, Reason:fileNotInReleaseManager");
+            }
+        }
         else
+        {
             Warning("Unexpected entry in dpkg_archive: $pkgName");
+        }
             my $keepReason = '';
             my $entry = $Packages{$pvid};
+            {
                 # Examine entry. Determine a reason to keep the package
+                #   Some reasons to keep a package are no longer needed now that versions are pumped into S3
                 unless ($entry) { $keepReason ='NoPackageEntry'; last;}
                 unless ($entry->{dpkg_archive}) { $keepReason ='NotInArchive'; last;}
                 unless ($pvid) { $keepReason = 'NoPVid'; last;}
-                if (exists $entry->{tlp}) { $keepReason ='tlp'; last;}
+                if (exists $entry->{tlp}) { $keepReason = 'TopLevelPackage'; last;}
-                if (exists $entry->{slp}) { $keepReason ='slp'; last;}
+                if (exists $entry->{slp}) { $keepReason = 'SecondLevelPackage'; last;}
-                if (exists $entry->{sdk}) { $keepReason ='sdk'; last;}
+                if (exists $entry->{sdk}) { $keepReason ='inSdk'; last;}
-                if (exists $entry->{dm}) { $keepReason ='dm'; last;}
+                if (exists $entry->{dm}) { $keepReason = 'inDeploymentManager'; last;}
-                if ($entry->{isPatch}) { $keepReason ='isPatch'; last;}
+                if ($entry->{isPatch}) { $keepReason = 'isPatch'; last;}
                 unless ($mtime) { $keepReason ='ZeroTime'; last;}
-                if ($mtime <= $config{retain}) { $keepReason ='mtime<Retain:' . ($config{retain} - $mtime); last;}
+                if ($mtime <= $config{retain}) { $keepReason ='RetainTime:' . ($config{retain} - $mtime); last;}
-                unless ($entry->{buildStandard}) { $keepReason ='NoBuildStandard' . $mtime; last;}
+                #unless ($entry->{buildStandard}) { $keepReason ='NoBuildStandard:' . $mtime; last;}
                 if ($entry->{locked} ne 'Y') { $keepReason ='NotLocked:' . $entry->{locked}; last;}
                 #if ($entry->{buildType} eq 'M') { $keepReason ='ManualBuild:' . $entry->{buildType}; last;}
                 $pkgPvid{$pkgName}{$pkgVersion}{keepReason} = $keepReason;
+            }
             unless ( $keepReason )
+            {
                 Verbose2("Quarantine:$pvid, $pkgName, $pkgVersion, Age:$mtime, Lock:$entry->{locked}, Patch:$entry->{isPatch}, BS:$entry->{buildStandard}, BT:$entry->{buildType}");
                 quarantineItem( 'Q', $mtime, join('/', $config{dpkg_archive}, $pkgName, $pkgVersion ) );
+                $keepReason = 'Quarantine';
+            }
             if ($opt_explain)
+            {
                 Information("Reason:$pvid, $pkgName, $pkgVersion, Reason:$keepReason");
+            }
+            #
+            #   Maintain Stats
+            #       Only use the Base Reason - remove details after the ':' character
+            #
+            my $sReason = $keepReason;
+            $sReason =~ s~:.*$~~;
+            $statistics{$sReason}++;
+            $statistics{TotalPackages}++;
+        }
+    }
+    #
     # Perform the quarantine
+    }
     return @releases;
+}
 #-------------------------------------------------------------------------------
+# Function        : reportStats
+#
+# Description     : Report statistics
+#                   Write statistics to a file
+#                       Write to a tmp file, then rename.
+#                       Attempt to make the operation atomic - so that the file consumer
+#                       doesn't get a badly formed file.
+#
+#
+# Inputs          :
+#
+# Returns         :
+#
+sub reportStats
+{
+    #
+    #   Time stamp the stats
+    #
+    $statistics{'timeStamp'} = time();
+    #
+    #   Save stats to a known file for Nagios to use
+    #
+    my $statsfiletmp = join('/', $config{logBase}, 'quarantine.stats.tmp' );
+    my $statsfile    = join('/', $config{logBase}, 'quarantine.stats');
+    my $fh;
+    unless (open ($fh, '>', $statsfiletmp))
+    {
+        $fh = undef;
+        Warning("Cannot create temp stats file: $!");
+    }
+    else
+    {
+        foreach my $key ( sort { lc($a) cmp lc($b) } keys %statistics)
+        {
+            print $fh $key . ':' . $statistics{$key} . "\n";
+            Log('Statistics: '. $key . ':' . $statistics{$key});
+        }
+        close $fh;
+        # Rename temp to real file
+        rename  $statsfiletmp,  $statsfile;
+    }
+}
+#-------------------------------------------------------------------------------
 # Function        : quarantineItem
+#
 # Description     : Add item to the list of stuff to be quarantined
+#
 # Inputs          : $reason         - Reason
+                {
                     ReportError ("Move $path to S3");
                     $s3msg = ' - with S3 error';
                     $s3error = 1;
                     $emsg = ' - S3 Error prevented quarantine';
+                    $statistics{'S3TransferError'}++;
+                }
                 Log (sprintf("S3Quarantined:%s%s,%4.4s,%s%s", $testMsg, $entry->{reason}, $entry->{age}, $path, $s3msg));
+            }
             unless ($s3error)
+                {
                     $rv = system ('mv', '-n', $path, $tdir);
                     if ( $rv )
+                    {
                         ReportError ("Move $path to $tdir");
+                        $statistics{'QuarantineError'}++;
+                        #
                         # Clean up what may have been moved
                         # NOTE: deleted so that we don't loose stuff if it gets ugly
         #                rmtree( $tpath);
         #                rmdir ($tdir);
  Options:
     -help              - brief help message
     -help -help        - Detailed help message
     -man               - Full documentation
     -verbose[=n]       - Control output
+    -explain           - Display each package version disposition
     -phase=nn          - Perform named phases
     -purge             - Just purge the old quarantined files
     -test              - Do not delete files
     -limit=n           - Limit packages processed. Test only
     -pcount=n          - Limit package count
 A verbose level of 1. will display progress information
 A verbose level of 3. will display detailed tracing of all operations
+=item B<-explain[=n]>
+This option will output a line per package-version explaining the reason that
+packages are retained.
+Only a level of 1 is supported.
 =item B<-phase=list>
 This option will limit the work done by the program. There are two phases
 called: 1 and 2.

Subversion Repositories DevTools

(root)/dpkg_management/trunk/src/sbin/jats_quarantine.pl – Rev 5272 → 5534