javacore-analyser 2.4.1.dev12__py3-none-any.whl → 2.5.0__py3-none-any.whl

javacore_analyser/abstract_snapshot_collection.py

@@ -23,6 +23,20 @@ class AbstractSnapshotCollection(abc.ABC):
         self.add(thread_snapshot)
 
     def get_xml(self, doc):
+        """
+        Creates an XML node representing a snapshot collection with various metrics.
+
+        This method constructs an XML node named 'snapshot_collection' and populates it with child nodes for different metrics.
+        Each child node corresponds to a specific metric, such as total CPU usage, total time, CPU percentage, average memory,
+        maximum Java stack depth, and average Java stack depth. The text content of each child node is set to the string representation
+        of the respective metric value obtained from the class instance.
+
+        Args:
+            doc (xml.dom.minidom.Document): The XML document object to create nodes within.
+
+        Returns:
+            xml.dom.minidom.Element: The root 'snapshot_collection' node with all child nodes populated.
+        """
         snapshot_collection_node = doc.createElement('snapshot_collection')
         # total CPU usage
         total_cpu_usage_node = doc.createElement('total_cpu_usage')

javacore_analyser/code_snapshot_collection.py

@@ -9,19 +9,21 @@ from javacore_analyser.thread_snapshot import ThreadSnapshot
 
 
 class CodeSnapshotCollection(AbstractSnapshotCollection):
-    """
-    returns the stack trace that is common for all the
-    snapshots in this collection """
+    
 
     def get_stack_trace(self):
+        """
+        returns the stack trace that is common for all the
+        snapshots in this collection 
+        """
         snapshot = self.thread_snapshots[0]  # they all have the same stack,
         # so we can just take the first one
         return snapshot.stack_trace
 
-    """
-    Returns list of the threads for which given stack appears
-    """
     def get_threads(self):
+        """
+        Returns list of the threads for which given stack appears
+        """
         result = set()
         for snapshot in self.thread_snapshots:
             thread = snapshot.thread

javacore_analyser/javacore.py

@@ -1,5 +1,5 @@
 #
-# Copyright IBM Corp. 2024 - 2024
+# Copyright IBM Corp. 2024 - 2025
 # SPDX-License-Identifier: Apache-2.0
 #
 
@@ -122,7 +122,10 @@ class Javacore:
             if not line:
                 break
             if line.startswith(ENCODING):
-                self.__encoding = line.split(" ")[-1].strip()
+                # Leave the default encoding if it was not defined
+                # 1TICHARSET     [not available]
+                if not line.__contains__("[not available]"):
+                    self.__encoding = line.split(" ")[-1].strip()
                 break
         file.close()
         return self.__encoding

{javacore_analyser-2.4.1.dev12.dist-info → javacore_analyser-2.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.4.1.dev12
+Version: 2.5.0
 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
@@ -338,7 +338,31 @@ NOTE: If you get a `PermissionError: [Errno 13] Permission denied: '/reports/wai
 try specifying a different folder as the `src` parameter value or use the
 [--volume](https://docs.docker.com/engine/storage/volumes/) option instead of `--mount`. Find more on 
 [Issue #140](https://github.com/IBM/javacore-analyser/issues/140#issuecomment-2757809160).
- 
+
+
+### Running collectors
+There is a collector available that will gather javacores, verbose gc and some further server configuration (`ulimit`, `ps`, memory and disk usage) for Linux systems.
+Perform the following steps to run the tool:
+1. Download the collector from [javacoreCollector.sh](collectors/javacoreCollector.sh) to the machine where you want to gather data. 
+2. Execute it with the following command:
+
+`./javacoreCollector.sh libertyPath=/opt/ibm/liberty server=liberty_server_name` - for collecting diagnostic data from a java application running on an IBM WebSphere Liberty profile,
+
+or
+
+`./javacoreCollector.sh javaPid=12345 javacoresDir=/location/for/javacores` - for collecting diagnostic data from any java aplication.
+
+
+You can add the 'count' and 'interval' parameters to specify the number of javacores (default: 10) and interval between each of them (defaul: 30s).
+
+Type `./javacoreCollector.sh` to get more help.
+
+After collection, the collector creates `javacores.tar.gz` file containing the following data:
+* javacore files, 
+* Verbose gc files, if found in `javacoresDir` or `libertyPath` location, 
+* Ulimit settings in `ulimit.txt` file,
+* output from `ps`, memory and disk usage it iteration files. This data is gathered periodically with the same interval as javacores. There is separate file created for each collection.
+
 <!-- The following are OPTIONAL, but strongly suggested to have in your repository. -->
 <!--
 * [dco.yml](.github/dco.yml) - This enables DCO bot for you, please take a look https://github.com/probot/dco for more details.

{javacore_analyser-2.4.1.dev12.dist-info → javacore_analyser-2.5.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
 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=yag25_O1JOQjz2uIK2gQzaTvovINnJ4ClnNhmrbC0Fg,2776
+javacore_analyser/abstract_snapshot_collection.py,sha256=ZA5rRD8YjaDJozLqT2RNMcJ_TaAfcAFjyIZasYnq9yQ,6393
+javacore_analyser/code_snapshot_collection.py,sha256=vk1Tlprt6iCZLL0VDWgf-ByvE008SbmkbQFwsAsuMAk,2814
 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=J_i2O87ws8LcwUHHDBE-pcFe-bV764iOO0PU_59ckVE,5780
-javacore_analyser/javacore.py,sha256=oqJ-nKkZvq8xk_zlF9Z4dX61isqLRndSVLnQob_KUG4,7006
+javacore_analyser/javacore.py,sha256=K6NG1iLOuel8d3fXFRpdP7XnBGfCJn1qJ9GHB7TyKyU,7187
 javacore_analyser/javacore_analyser_batch.py,sha256=hLd4J_Q7JiZlkKp57KirK3_WtMaLuLC-X293a0bA8fU,8393
 javacore_analyser/javacore_analyser_web.py,sha256=L3-BG5ljYllPkwHfKHL_yvG6m0cUjkDFdxpd6qsQDH8,6269
 javacore_analyser/javacore_set.py,sha256=5x16j8KfA_DXD3FlvKlRHfRJ2B1rj5j2EkMfb2dV3dg,33341
@@ -43,8 +43,8 @@ javacore_analyser/data/xml/javacores/javacore.xsl,sha256=puJl7CDR7FACAHbb2lTKHiw
 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=c40-JY3eXG9NzPVMy14VSZFj1Yq7cuUDVUg5BWa2WY0,2466
-javacore_analyser-2.4.1.dev12.dist-info/METADATA,sha256=dhoPkcEsi4esNZblFoVzXwMznt3hsMm4f4KAWNCzgSY,22743
-javacore_analyser-2.4.1.dev12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-javacore_analyser-2.4.1.dev12.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
-javacore_analyser-2.4.1.dev12.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-javacore_analyser-2.4.1.dev12.dist-info/RECORD,,
+javacore_analyser-2.5.0.dist-info/METADATA,sha256=XNjRx_kKr1WtVLY0s5yTlfyy9JeDpltQCv7R9QCayq0,24088
+javacore_analyser-2.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+javacore_analyser-2.5.0.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
+javacore_analyser-2.5.0.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+javacore_analyser-2.5.0.dist-info/RECORD,,