javacore-analyser 2.2.0.dev121__py3-none-any.whl → 2.3__py3-none-any.whl

javacore_analyser/code_snapshot_collection.py

@@ -1,5 +1,5 @@
 #
-# Copyright IBM Corp. 2024 - 2024
+# Copyright IBM Corp. 2024 - 2025
 # SPDX-License-Identifier: Apache-2.0
 #
 
@@ -21,7 +21,6 @@ class CodeSnapshotCollection(AbstractSnapshotCollection):
     """
     Returns list of the threads for which given stack appears
     """
-
     def get_threads(self):
         result = set()
         for snapshot in self.thread_snapshots:
@@ -29,6 +28,9 @@ class CodeSnapshotCollection(AbstractSnapshotCollection):
             result.add(thread)
         return result
 
+    def is_interesting(self):  # method is to be overloaded in subclasses, ignore the static warning
+        return True
+
     def get_xml(self, doc):
         snapshot_collection_node = super().get_xml(doc)
         stack_strace = self.get_stack_trace()

javacore_analyser/data/xml/report.xsl

@@ -550,6 +550,8 @@
                                 of the code that the thread was executing in each of the javacores in which it appears.
                                 Note that there may be multiple threads with the same name,
                                 since the names of threads are not unique over time, and may be reused.
+                                A 'More' link may appear next to the thread name to allow to drilldown into that thread's individual page
+                                The drilldown may be supressed for threads that don't appear to be doing anything interesting.
                             </li>
                             <li><strong>Total CPU usage</strong>
                                 is the total number of seconds the thread was using CPU time since the first javacore,
@@ -598,13 +600,17 @@
                                             <xsl:attribute name="class">expandit</xsl:attribute>
                                             <xsl:value-of select="thread_name"/>
                                         </a>
-                                        <a class="right" target="_blank">
-                                            <xsl:attribute name="href">
-                                                <xsl:value-of select="concat('threads/thread_', thread_hash, '.html')"/>
-                                            </xsl:attribute>
-                                            More...
-                                        </a>
-                                        <br/>
+                                        <xsl:choose>
+                                                <xsl:when test="@has_drill_down='True'">
+                                                <a class="right" target="_blank">
+                                                    <xsl:attribute name="href">
+                                                        <xsl:value-of select="concat('threads/thread_', thread_hash, '.html')"/>
+                                                    </xsl:attribute>
+                                                    More...
+                                                </a>
+                                                <br/>
+                                            </xsl:when>
+                                        </xsl:choose>
                                         <div  style="display:none;" >
                                             <xsl:attribute name="id"><xsl:value-of select="concat('stack',$i)"/></xsl:attribute>
                                             java/lang/Thread:<xsl:value-of select="thread_address"/>

javacore_analyser/java_thread.py

@@ -1,9 +1,9 @@
 #
-# Copyright IBM Corp. 2024 - 2024
+# Copyright IBM Corp. 2024 - 2025
 # SPDX-License-Identifier: Apache-2.0
 #
-
 from javacore_analyser.abstract_snapshot_collection import AbstractSnapshotCollection
+from javacore_analyser.properties import Properties
 
 
 class Thread(AbstractSnapshotCollection):
@@ -16,6 +16,13 @@ class Thread(AbstractSnapshotCollection):
         super().create(thread_snapshot)
         self.thread_address = thread_snapshot.thread_address
 
+    def is_interesting(self):
+        if self.get_total_cpu() > 0: return True
+        if self.get_avg_mem() // (1024 * 1024) > 0: return True     # memory in megabytes
+        if len(self.get_blocker_threads()) > 0: return True
+        if len(self.get_blocking_threads()) > 0: return True
+        return False
+
     def get_hash(self):
         id_str = self.name + str(self.id)
         hashcode = abs(hash(id_str))
@@ -24,6 +31,9 @@ class Thread(AbstractSnapshotCollection):
     def get_xml(self, doc):
         thread_node = super().get_xml(doc)
 
+        thread_node.setAttribute("has_drill_down",
+                                 str(self.is_interesting() or not Properties.get_instance().skip_boring))
+
         # thread ID
         id_node = doc.createElement("thread_id")
         id_node.appendChild(doc.createTextNode(str(self.id)))

javacore_analyser/javacore.py

@@ -42,6 +42,9 @@ class Javacore:
         self.javacore_set = javacore_set
         self.extract_thread_snapshots()
 
+    def is_interesting(self):  # method is to be overloaded in subclasses, ignore the static warning
+        return True
+
     def get_cpu_percentage(self):
         if self.__total_cpu == -1:
             self.__calculate_total_cpu_and_load()

javacore_analyser/javacore_analyser_batch.py

@@ -22,6 +22,7 @@ from importlib_resources.abc import Traversable
 from javacore_analyser import logging_utils
 from javacore_analyser.constants import DEFAULT_FILE_DELIMITER
 from javacore_analyser.javacore_set import JavacoreSet
+from javacore_analyser.properties import Properties
 
 SUPPORTED_ARCHIVES_FORMATS = {"zip", "gz", "tgz", "bz2", "lzma", "7z"}
 
@@ -76,11 +77,14 @@ def main():
     parser.add_argument("--separator",
                         help='Input files separator (default "' + DEFAULT_FILE_DELIMITER + '")',
                         default=DEFAULT_FILE_DELIMITER)
+    parser.add_argument("--skip_boring", help='Skips drilldown page generation for threads that do not do anything',
+                        default='True')
     args = parser.parse_args()
 
     input_param = args.input
     output_param = args.output
     files_separator = args.separator
+    Properties.get_instance().skip_boring = args.skip_boring != 'False'
 
     batch_process(input_param, output_param, files_separator)
 

javacore_analyser/javacore_set.py

@@ -25,6 +25,7 @@ from javacore_analyser.constants import *
 from javacore_analyser.har_file import HarFile
 from javacore_analyser.java_thread import Thread
 from javacore_analyser.javacore import Javacore
+from javacore_analyser.properties import Properties
 from javacore_analyser.snapshot_collection import SnapshotCollection
 from javacore_analyser.snapshot_collection_collection import SnapshotCollectionCollection
 from javacore_analyser.verbose_gc import VerboseGcParser
@@ -44,11 +45,14 @@ def _create_xml_xsl_for_collection(tmp_dir, templates_dir, xml_xsl_filename, col
             filename = output_file_prefix + "_" + str(element_id) + extension
             if filename.startswith("_"):
                 filename = filename[1:]
-            file = os.path.join(tmp_dir, filename)
-            logging.debug("Writing file " + file)
-            f = open(file, "w")
-            f.write(file_content.format(id=element_id))
-            f.close()
+            if element.is_interesting() or not Properties.get_instance().skip_boring:
+                file = os.path.join(tmp_dir, filename)
+                logging.debug("Writing file " + file)
+                f = open(file, "w")
+                f.write(file_content.format(id=element_id))
+                f.close()
+            else:
+                logging.debug("Skipping boring file: " + filename)
 
 
 class JavacoreSet:
@@ -149,12 +153,13 @@ class JavacoreSet:
             shutil.rmtree(directory)
         os.mkdir(directory)
 
-        for element in tqdm(collection, desc="Generating placeholder htmls", unit=" files"):
-            filename = file_prefix + "_" + element.get_id() + ".html"
-            if filename.startswith("_"):
-                filename = filename[1:]
-            file_path = os.path.join(directory, filename)
-            shutil.copy2(placeholder_file, file_path)
+        for element in tqdm(collection, desc="Generating placeholder htmls", unit=" file"):
+            if element.is_interesting() or not Properties.get_instance().skip_boring:
+                filename = file_prefix + "_" + element.get_id() + ".html"
+                if filename.startswith("_"):
+                    filename = filename[1:]
+                file_path = os.path.join(directory, filename)
+                shutil.copy2(placeholder_file, file_path)
         logging.info("Finished generating placeholder htmls")
 
     def __generate_htmls_for_threads(self, output_dir, temp_dir_name):
@@ -569,7 +574,7 @@ class JavacoreSet:
         logging.info(f"Using {threads_no} threads to generate html files")
 
         list_files = os.listdir(data_input_dir)
-        progress_bar = tqdm(desc="Generating html files", unit=' files')
+        progress_bar = tqdm(desc="Generating html files", unit=' file')
 
         # Generating list of tuples. This is required attribute for p.map function executed few lines below.
         generate_html_from_xml_xsl_files_params = []
@@ -626,7 +631,7 @@ class JavacoreSet:
         extensions = [".xsl", ".xml"]
         for extension in extensions:
             file_content = Path(xml_xsls_prefix_path + extension).read_text()
-            for element in tqdm(collection, desc="Creating xml/xsl files", unit=" files"):
+            for element in tqdm(collection, desc="Creating xml/xsl files", unit=" file"):
                 element_id = element.get_id()
                 filename = output_file_prefix + "_" + str(element_id) + extension
                 if filename.startswith("_"):

javacore_analyser/properties.py

@@ -0,0 +1,28 @@
+#
+# Copyright IBM Corp. 2024 - 2025
+# SPDX-License-Identifier: Apache-2.0
+#
+
+class Properties:
+
+    __instance = None
+
+    # Python doesn't have private constructors
+    # The key prevents creation of an object of this class from outside the class
+    __create_key = object()
+
+    @classmethod
+    def create(cls):
+        return Properties(cls.__create_key)
+
+    def __init__(self, create_key):
+        # the assertion below effectively makes the constructor private
+        assert (create_key == Properties.__create_key), \
+            "Properties objects must be created using Properties.create"
+        self.skip_boring = True
+
+    @staticmethod
+    def get_instance():
+        if not Properties.__instance:
+            Properties.__instance = Properties.create()
+        return Properties.__instance

{javacore_analyser-2.2.0.dev121.dist-info → javacore_analyser-2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.2.0.dev121
+Version: 2.3
 Summary: The tool to review IBM Javacore files
 Project-URL: Homepage, https://github.com/IBM/javacore-analyser
 Project-URL: Issues, https://github.com/IBM/javacore-analyser/issues
@@ -302,6 +302,7 @@ Where `<input-data>` is one of the following:
 * The directory containing javacores and optionally verbose gc
 * Archive (7z, zip, tar.gz, tar.bz2) containing the same
 * List of the javacores separated by `;` character. Optionally you can add `--separator` option to define your own separator.
+* You can specify `--skip_boring=False` if you want drill-down pages generated for all the threads, including the ones that do not do anything interesting.
 You can type the following command to obtain the help:  
 `javacore-analyser-batch --help` or `python -m javacore_analyser batch --help`
 

{javacore_analyser-2.2.0.dev121.dist-info → javacore_analyser-2.3.dist-info}/RECORD

@@ -1,15 +1,16 @@
 javacore_analyser/__init__.py,sha256=Sw2ZeqcI2Kx1cDDv083n1SiSY_FDRCmidTuzaN1uRSw,76
 javacore_analyser/__main__.py,sha256=wQCPgu8Gp7XczyNckNGmY30c5YMUMRByW7jrdFO0OBY,1694
 javacore_analyser/abstract_snapshot_collection.py,sha256=jGfd2XgujurRlKgEtlJjqNJK9sUvTdFsdgFnX9oLzt4,5589
-javacore_analyser/code_snapshot_collection.py,sha256=6_C5myag5ocjOTwXVDbBamN6Lf1szgS3ylSHEEjUdVg,2655
+javacore_analyser/code_snapshot_collection.py,sha256=yag25_O1JOQjz2uIK2gQzaTvovINnJ4ClnNhmrbC0Fg,2776
 javacore_analyser/constants.py,sha256=7-gbGLzUMIMe2UvmLT17ymmy_r_izadpAyhrEKFonP8,1054
 javacore_analyser/har_file.py,sha256=grXpfIyPek9xQ5jp3_AYOB5JDELd17o4O4rYELxWO7w,2131
-javacore_analyser/java_thread.py,sha256=0Qh857o0M05sO_WRkNM5DFtBK03HytUwdMp7Ha1WXGI,4916
-javacore_analyser/javacore.py,sha256=_2abTyvXEaZ6Tx8r9d3NEzRCIBcf4Is8lSjpKyPu-R8,6884
-javacore_analyser/javacore_analyser_batch.py,sha256=D9H6ct_PBAXR_PvTqGtKw_FIx9Q9KuJSFBeEZ2FIkbo,7607
+javacore_analyser/java_thread.py,sha256=nDFJiFQSO78jP9YdMpBr2d_M2RMT0te_kJxn5KY_RNo,5437
+javacore_analyser/javacore.py,sha256=oqJ-nKkZvq8xk_zlF9Z4dX61isqLRndSVLnQob_KUG4,7006
+javacore_analyser/javacore_analyser_batch.py,sha256=2JnRruA0jazWHspT60cXX-Yuwf4vFSA5ywXYPQ4-ZiM,7888
 javacore_analyser/javacore_analyser_web.py,sha256=o-Spq119Wi7w4pvBa7M7ZrxiZnzKmWqDhCdGtEReQAU,5951
-javacore_analyser/javacore_set.py,sha256=g-1NtOJ6r6HB6JqzIWVPjFJrXGNweBJx7WoavkF0ggE,32995
+javacore_analyser/javacore_set.py,sha256=5x16j8KfA_DXD3FlvKlRHfRJ2B1rj5j2EkMfb2dV3dg,33341
 javacore_analyser/logging_utils.py,sha256=vLob0ikezysjGv9XGqv9GbLekxu4eO_csq22M-gtLiQ,966
+javacore_analyser/properties.py,sha256=SVxe86mL4DM_vkPEBT-V0_xDeIbXp2vjYE1aD-Z_UCQ,805
 javacore_analyser/snapshot_collection.py,sha256=fLEnwg9-cOjVVUUludtzI7R2yO9BBVgJgxkhvqG5QDg,443
 javacore_analyser/snapshot_collection_collection.py,sha256=1PV1TX4QQk01dAbX-k-kTpgKr6Il867Bw6X7HHBuv-Q,1346
 javacore_analyser/stack_trace.py,sha256=8sb8z4ac_L0yyxqJX1ukrTZRyngkHcA3zkXyqxG5ygA,1664
@@ -35,14 +36,14 @@ javacore_analyser/data/jquery/theme.blue.css,sha256=cPcj8KaUj_zNy_xtDfrodSLue94n
 javacore_analyser/data/jquery/theme.default.min.css,sha256=5sgExNTnkN8NcApKIU73_aqgZmqq_zJp9-9zXf9aSEw,4502
 javacore_analyser/data/jquery/wait2scripts.js,sha256=jORUs9xgz_o-VnRm0RxjKlraZOleQrPp5DmTyrMBwrM,8577
 javacore_analyser/data/xml/index.xml,sha256=9VH2rmri3FQpXcW39kbyi2dON94C5XTiaQn0ioExCe8,282
-javacore_analyser/data/xml/report.xsl,sha256=uum_nBGzSyCa8LL51xjWQXUxYxo-1VR9wkhJrS_dbnI,59605
+javacore_analyser/data/xml/report.xsl,sha256=LlrleGFx9MC0VOhP6CBgII1uhP-kzhbo4pwro-HwAGo,60178
 javacore_analyser/data/xml/javacores/javacore.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
 javacore_analyser/data/xml/javacores/javacore.xsl,sha256=5cnIp08Q9FccljHH8duoJQYofyW8lwUCGtpdzz5Y0Y8,11644
 javacore_analyser/data/xml/threads/thread.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
 javacore_analyser/data/xml/threads/thread.xsl,sha256=1tg5tImtr1gyZ8Q61tqIukNtm1fQ6R8YoKC3EgIjLRA,14084
 javacore_analyser/templates/index.html,sha256=aEuyry-HZ9HlQNwfbugugvqbSxwlo7LrQnrDmqO34YE,1682
-javacore_analyser-2.2.0.dev121.dist-info/METADATA,sha256=nibsA3qxZSuFaqZl001YEcBLCN7roeKZac7_XLfTh9s,22215
-javacore_analyser-2.2.0.dev121.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-javacore_analyser-2.2.0.dev121.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
-javacore_analyser-2.2.0.dev121.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-javacore_analyser-2.2.0.dev121.dist-info/RECORD,,
+javacore_analyser-2.3.dist-info/METADATA,sha256=OqkpuvfVdhTUU35rvB1_OI2b1dTjIaS6FHY0XrF3e4Q,22362
+javacore_analyser-2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+javacore_analyser-2.3.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
+javacore_analyser-2.3.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+javacore_analyser-2.3.dist-info/RECORD,,