javacore-analyser 2.4.2__tar.gz → 2.5.0__tar.gz

{javacore_analyser-2.4.2 → javacore_analyser-2.5.0}/.travis.yml

@@ -26,7 +26,9 @@ deploy:
  - provider: releases
    edge: true
    draft: true
-   file: dist/*
+   file: 
+    - dist/*
+    - collectors/*
    on:
     # all_branches: true # uncomment for testing purposes
     # branch: main # uncomment on production

{javacore_analyser-2.4.2 → javacore_analyser-2.5.0}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [2.4.2] - 2025-06-16
+* #156 LookupError-unknown-encoding-available by @tjanasiewicz in https://github.com/IBM/javacore-analyser/pull/157
+
+[2.4.2]: https://github.com/IBM/javacore-analyser/releases/tag/2.4.2
+
+## [2.4.1] - 2025-05-20
+* #142 treat any thread with a truncated stack as interesting by @PiotrAniola82 in https://github.com/IBM/javacore-analyser/pull/148
+
+[2.4.1]: https://github.com/IBM/javacore-analyser/releases/tag/2.4.1
+
 ## [2.4.0] - 2025-04-24
 * Removing vagueness by @yashrajmotwani23 in https://github.com/IBM/javacore-analyser/pull/134
 * Fixed javacore drilldown does not contain thread names by @PiotrAniola82 in https://github.com/IBM/javacore-analyser/pull/136

{javacore_analyser-2.4.2 → javacore_analyser-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.4.2
+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.2 → javacore_analyser-2.5.0}/README.md

@@ -99,7 +99,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.5.0/collectors/javacoreCollector.sh

@@ -0,0 +1,105 @@
+#!/bin/bash
+
+#Copyright IBM Corp. 2025 - 2025
+#SPDX-License-Identifier: Apache-2.0
+
+echo "executing javacore collector script"
+current=`date`
+echo "Current time: $current"
+for arg in "$@"; do
+    if [[ $arg == libertyPath=* ]]; then
+        libertyPath="${arg#libertyPath=}"
+    elif [[ $arg == javaPid=* ]]; then
+        javaPid="${arg#javaPid=}"
+    elif [[ $arg == count=*  ]]; then
+        count="${arg#count=}"
+    elif [[ $arg == interval=* ]]; then
+        interval="${arg#interval=}"
+    elif [[ $arg == server=* ]]; then
+        server="${arg#server=}"
+    elif [[ $arg == javacoresDir=* ]]; then
+        javacoresDir="${arg#javacoresDir=}"
+    fi
+done
+
+# Validation
+validated=false
+if [ -n "${libertyPath}" ] && [ -n "${server}" ]; then
+    validated=true
+elif [ -n "${javaPid}" ] && [ -n "${javacoresDir}" ]; then
+    validated=true
+else
+    validated=false
+fi
+if [ "$validated" = false ]; then
+    echo "Invalid arguments provided."
+    echo "You must provide either libertyPath with server name or javaPid with javacores dir arguments:"
+    echo "  ./javacoreCollector.sh libertyPath=/opt/ibm/liberty server=server_name"
+    echo "  ./javacoreCollector.sh javaPid=12345 javacoresDir=/path/to/javacores"
+    echo ""
+    echo "Optional arguments:"
+    echo ""
+    echo "   count - number of Javacores (default: 10)"
+    echo "   interval - interval in seconds to gather javacores (default: 30)"
+    echo ""
+    echo "Examples:"
+    echo "   ./javacoreCollector.sh libertyPath=/opt/ibm/liberty server=clm count=5 interval=60"
+    echo "   ./javacoreCollector.sh javaPid=12345 javacoresDir=/my_app/javacores count=5 interval=60"
+    exit 1
+ fi
+
+[ -z "$interval" ] && interval=30
+[ -z "$count" ] && count=10
+
+
+if [[ -n "$libertyPath" ]]; then
+    echo "Liberty path provided: $libertyPath"
+    javacoresDir="$libertyPath/servers/$server/"
+    export WLP_USER_DIR=$libertyPath
+    verbosegcDir="$libertyPath/servers/$server"
+else
+    echo "Java PID provided: $javaPid"
+    verbosegcDir=
+fi
+
+mkdir javacore_data
+echo "Ulimit" >> javacore_data/ulimit.txt
+ulimit -a>>javacore_data/ulimit.txt
+
+for i in $(seq 1 $count); do
+
+    file_name=javacore_data/iteration${i}.txt
+    echo "Writing current system resources usage to $file_name"
+    echo "List of processes">>"$file_name"
+    ps aux>>"$file_name"
+    echo "Memory usage">>"$file_name"
+    free -k>>"$file_name"
+    echo "Disk usage">>"$file_name"
+    df -h>>"$file_name"
+
+    echo "[$(date)] Generating javacore #$i..."
+    if [[ -n "$libertyPath" ]]; then
+        echo "Running following command: $libertyPath/wlp/bin/server javadump $server"
+        "$libertyPath"/wlp/bin/server javadump $server
+    else
+        kill -3 $javaPid
+    fi
+    if [ $i -lt $count ]; then
+        sleep $interval
+    fi
+done
+
+
+echo "Creating archive file"
+#copy all javacore files newer than script starting time
+cp -vf `find $javacoresDir javacore*.txt -newermt "$current"` javacore_data
+#copy verbose gc files if they exist
+if [ -n "$verbosegcDir" ]; then
+    cp -vf $libertyPath/servers/$server/verbosegc.txt* javacore_data
+fi
+tar -czvf javacores.tar.gz javacore_data
+echo "Javacores and verbose gc data saved to javacores.tar.gz archive."
+echo "Deleting javacore_data dir"
+rm -rfv javacore_data
+
+exit 1

{javacore_analyser-2.4.2 → javacore_analyser-2.5.0}/src/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-2.4.2 → javacore_analyser-2.5.0}/src/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