Refactor read trace invocation to avoid duplicate calls to post import script and to exclude log_NNN.trc files (#471)

* #470 allow for a seprate line for pssdiag trace files to show up in SQL Nexus

* #470 refactor code so that we can control which post execution scripts is run and make sure the appropriate script is run for .TRC/XEL files and not every time

* #470 don't log that script is skipped

* #470 exclude the processing of default trace files (log_*.trc) - refactor code

Author: PiJoCoder

ReadTraceNexusImporter/ReadTraceNexusImporter.cs

@@ -15,6 +15,7 @@
 using System.Xml;
 using System.Reflection;
 using System.Windows.Forms;
+using System.Linq;
 
 
 namespace ReadTrace
@@ -284,14 +285,19 @@ private decimal GetLocalServerTimeOffset()
 
 
 
-        private bool SkipFile(string FullFileName)
+        private bool SkipFile(string fullFileName)
         {
-            bool ret = false;
-            if (FullFileName.ToLower().EndsWith("_blk.trc"))
-                ret = true;
+            string name = Path.GetFileName(fullFileName);
+            if (name == null) 
+                return false;
 
-            return ret;
+            if (name.EndsWith("_blk.trc", StringComparison.OrdinalIgnoreCase))
+                return true;
+
+            if (System.Text.RegularExpressions.Regex.IsMatch(name, @"^log_\d+\.trc$", System.Text.RegularExpressions.RegexOptions.IgnoreCase))
+                return true;
 
+            return false;
         }
         /// <summary>Find the first trace file</summary>
         /// <remarks>If a trace file without a rollover number exists (e.g. "ABC_sp_trace.trc"), prefer it. 
@@ -310,8 +316,6 @@ private string FindFirstTraceFile(string[] files)
             Array.Sort(files);
             foreach (string f in files)
             {
-                if (SkipFile(f))
-                    continue;
 
                 string trcFileNoExt = Path.GetFileNameWithoutExtension(f);
                 if ((trcFileNoExt.LastIndexOf('_') > -1)     // find the last underscore in the filename
@@ -394,16 +398,27 @@ public bool DoImport()
             string timeAdjForLocalTimeMinutes = "";
             decimal UtcToLocalOffsetHours = 99;
             Util.Logger.LogMessage("ReadTraceNexusImporter - Starting import...");
-            string[] files = Directory.GetFiles(Path.GetDirectoryName(this.traceFileSpec), Path.GetFileName(this.traceFileSpec));
+
+            string[] allFiles = Directory.GetFiles(Path.GetDirectoryName(this.traceFileSpec), Path.GetFileName(this.traceFileSpec));
+            string[] filteredFiles = allFiles.Where(f => !SkipFile(f)).ToArray();
+            int excludedCount = allFiles.Length - filteredFiles.Length;
+
+            if (excludedCount > 0)
+                Util.Logger.LogMessage($"ReadTraceNexusImporter: Excluded {excludedCount} trace file(s) (log_NNN.trc / *_blk.trc).");
 
             if (null == this.readTracePath)
                 throw new Exception("Cannot locate ReadTrace.exe. This import requires ReadTrace version 9.0.9.0 or later.");
-            if (0 == files.Length)
+            
+            if (filteredFiles.Length == 0)
             {
+                Util.Logger.LogMessage("ReadTraceNexusImporter: No eligible trace files after exclusions.");
                 State = ImportState.NoFiles;
                 return false;
             }
 
+            // Use filtered array
+            string[] files = filteredFiles;
+
             State = ImportState.Importing;
 
             // Find the first trace file. 
@@ -620,7 +635,7 @@ public void OnStatusChanged(EventArgs e)
         /// <summary>Filemask (e.g. "*.trc") used to advertise the set of files that a given importer knows how to process</summary>
         public string[] SupportedMasks
         {
-            get { return new string[] { "*.TRC", "*pssdiag*.xel", "*LogScout*.xel" }; }
+            get { return new string[] { "*.trc", "*pssdiag*.xel", "*LogScout*.xel"}; }
         }
 
         /// <summary>Number of rows/lines/events processed from source file.  Used to communicate progress back to host.</summary>

sqlnexus/fmImport.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Data;
+using System.Linq;
 using System.Drawing;
 using System.Text;
 using System.IO;
@@ -95,26 +95,68 @@ private bool BlockFile(string FileName)
             return ToBlock;
 
         }
+
+        //exclusion for trace files
+        private static bool IsExcludedTraceFile(string fullPath)
+        {
+            string name = Path.GetFileName(fullPath);
+            if (name == null) return false;
+
+            // Existing exclusion
+            if (name.EndsWith("_blk.trc", StringComparison.OrdinalIgnoreCase))
+                return true;
+
+            // New exclusion: log_NNN.trc pattern
+            if (System.Text.RegularExpressions.Regex.IsMatch(name, @"^log_\d+\.trc$", RegexOptions.IgnoreCase))
+                return true;
+
+            return false;
+        }
+
         private void AddFiles(string Mask, INexusImporter Importer)
         {
-            string[] files2 = Directory.GetFiles(cbPath.Text.Trim().Replace("\"", ""), Mask);
+            string basePath = cbPath.Text.Trim().Replace("\"", "");
+            string[] allMatches = Directory.GetFiles(basePath, Mask);
+
 
             //if no file found for this mask, just return
-            if (files2.Length <= 0)
-            {
+            if (allMatches.Length <= 0)
                 return;
+
+            // If this is a trace mask (*.trc) for ReadTrace, filter out excluded files
+            bool isReadTrace = Importer != null &&
+                               Importer.Name.IndexOf("ReadTrace", StringComparison.OrdinalIgnoreCase) >= 0 &&
+                               Mask.Equals("*.trc", StringComparison.OrdinalIgnoreCase);
+
+            //apply exclusion for trace files
+            string[] includedFiles = allMatches;
+            if (isReadTrace)
+            {
+                includedFiles = allMatches
+                    .Where(f => !IsExcludedTraceFile(f))
+                    .ToArray();
+
+                int excludedCount = allMatches.Length - includedFiles.Length;
+                if (excludedCount > 0)
+                {
+                    MainForm.LogMessage($"Excluded {excludedCount} trace file(s) from import based on exclusion criteria (log_NNN.trc / *_blk.trc).", MessageOptions.Silent);
+                }
             }
-            int i = tlpFiles.RowCount - 1;
+
+            // If after filtering there are NO included files, do NOT add any UI row.
+            if (includedFiles.Length == 0)
+                return;
+
+            int rowIndex = tlpFiles.RowCount - 1;
 
 
             if (Importer is INexusFileImporter)
             {
-                string[] files = Directory.GetFiles(cbPath.Text.Trim().Replace("\"", ""), Mask);
+
                 int blockedCounter = 0;
-                foreach (string f in files)
+                foreach (string f in includedFiles)
                 {
 
-
                     //handle multiple instances
                     //block all text files that are from excluded instances
                     if (BlockFile(f) || instances.Block(f))
@@ -123,40 +165,33 @@ private void AddFiles(string Mask, INexusImporter Importer)
                         continue;
                     }
 
-                    AddFileRow(i, Path.GetFileName(f), Importer, "");
-                    i++;
+                    AddFileRow(rowIndex, Path.GetFileName(f), Importer, "");
+                    rowIndex++;
 
                 }
                 MainForm.LogMessage("Number of files blocked for import (due to multiple instance or unrelated files such as sqldump*: " + blockedCounter, MessageOptions.Silent);
             }
             else
             {
-                if (0 != Directory.GetFiles(cbPath.Text.Trim().Replace("\"", ""), Mask).Length)  //Only add the mask if matching files are found
+                if (includedFiles.Length > 0)  //Only add the mask if matching files are found
                 {
                     //need special handling read trace for multiple instances
                     //when multiple instances files are caputred, only provide the one instnance selected.
-                    if (Importer.Name.ToUpper().IndexOf("READTRACE") >= 0 && instances.Count > 1)
+                    if (isReadTrace && instances.Count > 1)
                     {
                         if (Mask.ToUpper().Contains("XEL"))
-                        {
-                            AddFileRow(i, instances.SelectedXEventFileMask, Importer, "");
-                        }
+                            AddFileRow(rowIndex, instances.SelectedXEventFileMask, Importer, "");
                         else
-                        {
-                            AddFileRow(i, instances.SelectedTraceFileMask, Importer, "");
-                        }
-
-
-
+                            AddFileRow(rowIndex, instances.SelectedTraceFileMask, Importer, "");
                     }
                     else
                     {
-                        AddFileRow(i, Mask, Importer, "");
+                        AddFileRow(rowIndex, Mask, Importer, "");
                     }
 
                 }
             }
-        }
+        }//end of AddFiles
 
         private void AddFileRow(int row, string labelText, INexusImporter Importer, string RowType)
         {
@@ -888,13 +923,13 @@ private void DoImport()
                                                     MainForm);
 
                             //Run pre-scripts and cache post scripts for later use
-                            if (!PostScripts.ContainsKey(ri.GetType().Name))
+                            if (!PostScripts.ContainsKey(ri.Name))
                             {
-                                PostScripts.Add(ri.GetType().Name, ri.PostScripts);
-                                foreach (string s in ri.PreScripts)
+                                PostScripts.Add(ri.Name, ri.PostScripts);
+                                foreach (string pre_script in ri.PreScripts)
                                 {
-                                    MainForm.LogMessage("Executing pre-script: " + s);
-                                    RunScript(s);
+                                    MainForm.LogMessage("Executing pre-script: " + pre_script);
+                                    RunScript(pre_script);
                                 }
                             }
 
@@ -908,10 +943,8 @@ private void DoImport()
 
 
 
-                            if (ri.Name.ToLower().Contains("rowset"))
-                            {
-                                RunPostScripts();
-                            }
+                            RunPostScripts(ri.Name);
+                        
                             Globals.IsNexusCoreImporterSuccessful = true;
                             //ll.LinkBehavior = LinkBehavior.HoverUnderline;
                         }
@@ -1282,30 +1315,53 @@ select count (distinct runtime) 'NumberOfRuntimes' from tbl_PERF_STATS_SCRIPT_RU
             return retString;
         }
 
-        private void RunPostScripts()
+        private void RunPostScripts(string importerName)
         {
-            MainForm.LogMessage("Executing post-mortem analysis scripts...");
-            //RunScript(Application.StartupPath + @"\TraceAnalysis.sql");
+            if (string.IsNullOrEmpty(importerName))
+                return;
+
+            // Only execute ReadTracePostProcessing.sql when the current importer is the ReadTrace importer.
+            bool isReadTraceImporter = importerName.Equals("ReadTrace (SQL XEL/TRC files)", StringComparison.OrdinalIgnoreCase);
 
-            //nothing to run
-            if (null == PostScripts || PostScripts.Count <= 0)
+            // If nothing to run, skip executing the post scripts.
+            if (!PostScripts.TryGetValue(importerName, out var scripts) || scripts == null || scripts.Length == 0)
                 return;
 
-            foreach (string[] scripts in PostScripts.Values)
+            MainForm.LogMessage($"Executing post-mortem analysis scripts for importer '{importerName}'...");
+
+            //RunScript(Application.StartupPath + @"\TraceAnalysis.sql");
+
+            // Execute each post script from the list.
+            foreach (string script in scripts)
             {
-                if (scripts == null || scripts.Length <= 0)
+                if (string.IsNullOrWhiteSpace(script))
                     continue;
-                foreach (string script in scripts)
-                {
-                    if (string.IsNullOrEmpty(script))
-                        continue; //nothign to run
 
-                    MainForm.LogMessage("Executing post-script: " + script);
-                    RunScript(script);
+                // run ReadTracePostProcessing.sql only for the ReadTrace importer
+                if (script.Equals("ReadTracePostProcessing.sql", StringComparison.OrdinalIgnoreCase))
+                {
+                    if (!isReadTraceImporter)
+                    {
+                        // Skip this script if the current importer is not ReadTrace.
+                        continue;
+                    }
                 }
+                
+                // in the future we can add more special cases here for other importers if needed (else if ...)
+                //else if (script.Equals("AnotherPostProcessing.sql", StringComparison.OrdinalIgnoreCase))
+                //{
+                //    if (!isAnotherImporter)
+                //    {
+                //        MainForm.LogMessage($"Skipping '{script}' (only runs for Another importer).", MessageOptions.Silent);
+                //        continue;
+                //    }
+                //}
+
+                MainForm.LogMessage("Executing post-script: " + script);
+                RunScript(script);
             }
 
-            MainForm.LogMessage("Execution of post-mortem analysis scripts complete.");
+            MainForm.LogMessage($"Execution of post-mortem analysis scripts complete for importer '{importerName}'.");
         }
 
         private void RunScript(string scriptname)