PyPI - javacore-analyser - Versions diffs - 2.0rc3__py3-none-any.whl → 2.1.0.dev66__py3-none-any.whl - Mend

javacore-analyser 2.0rc3py3-none-any.whl → 2.1.0.dev66py3-none-any.whl

Files changed (20) hide show

javacore_analyser/abstract_snapshot_collection.py CHANGED Viewed

@@ -59,7 +59,7 @@ class AbstractSnapshotCollection(abc.ABC):
         self.thread_snapshots.append(snapshot)
     def index_of(self, snapshot):
-        for i in range(len(self.thread_snapshotssnaps)):
+        for i in range(len(self.thread_snapshots)):
             if self.thread_snapshots[i] == snapshot: return i
         return -1
@@ -142,7 +142,7 @@ class AbstractSnapshotCollection(abc.ABC):
         result = 0
         for i in self.thread_snapshots:
             el = i.get_java_stack_depth()
-            if el>result:
+            if el > result:
                 result = el
         return result

javacore_analyser/constants.py CHANGED Viewed

@@ -30,10 +30,11 @@ ENCODING = '1TICHARSET'
 DATA_OUTPUT_SUBDIR = '/data/'
 DEFAULT_FILE_DELIMITER = ';'
-MIN_JAVACORE_SIZE = 5 * 1024 # Minimal Javacore size in bytes
+MIN_JAVACORE_SIZE = 5 * 1024  # Minimal Javacore size in bytes
 DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
 # Web application constants
 DEFAULT_REPORTS_DIR = "reports"
 DEFAULT_PORT = 5000
+TEMP_DIR = "temp_data"  # Folder to store temporary data for creating reports

javacore_analyser/data/expand.js CHANGED Viewed

@@ -15,6 +15,8 @@ $('.show').click(function () {
     }
 });
 function expand_it(whichEl, link) {
     whichEl.style.display = (whichEl.style.display == "none") ? "" : "none";
     //if (link) {

javacore_analyser/data/html/processing_data.html ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<!--
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: Apache-2.0
+-->
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="30" /> <!-- Refresh this page every 30s until generated page appears -->
+    <meta charset="UTF-8">
+    <title>The page is being generated</title>
+</head>
+<body>
+    <h1>The page is being generated. Once it is ready, it will appear here.</h1>
+</body>
+</html>

javacore_analyser/data/jquery/search.js CHANGED Viewed

@@ -49,10 +49,32 @@ $(function() {
     searchInNode(rootNode, searchTerm);
   }
+    function processChild(child) {
+        try {
+            if (isDomNode(child) && child.classList.contains('toggle_expand')) {
+                for (i = 0; i < child.childNodes.length; ++i) {
+                    grandchild = child.childNodes[i];
+                    if (isDomNode(grandchild) && grandchild.text == '[+] Expand') {
+                        grandchild.text = '[-] Collapse';
+                    }
+                }
+            }
+        } catch(err) {
+            console.log(err);
+        }
+    }
     function searchInNode(node, searchTerm) {
         if (!isDomNode(node)) return;
         if (node.textContent.toUpperCase().match(searchTerm.toUpperCase())) {
             // expand the node here
+            if (!node.classList.contains('show-all')) {
+                node.classList.add('show-all');
+                for (i = 0; i < node.childNodes.length; ++i) {
+                    child = node.childNodes[i];
+                    processChild(child);
+                }
+            }
             if (node.getAttribute('style') && node.style.display == "none") {
                 node.style.display = "";
             }

javacore_analyser/javacore.py CHANGED Viewed

@@ -127,7 +127,8 @@ class Javacore:
     def encode(self, string):
         bts = str.encode(string, self.get_encoding(), 'ignore')
         for i in range(0, len(bts)):
-            if bts[i] < 32 and bts[i] != 9 and bts[i] != 10 and bts[i] != 13 and bts[i] != 1:         # fix for 'XML Syntax error PCDATA invalid char#405'
+            # fix for 'XML Syntax error PCDATA invalid char#405'
+            if bts[i] < 32 and bts[i] != 9 and bts[i] != 10 and bts[i] != 13 and bts[i] != 1:
                 raise CorruptedJavacoreException("Javacore " + self.filename + " is corrupted in line " + string)
         string = bts.decode('utf-8', 'ignore')
         return string
@@ -145,7 +146,7 @@ class Javacore:
                     break
                 line = self.encode(line)
                 if line.startswith(THREAD_INFO):
-                    line = self.processThreadName(line, file)
+                    line = Javacore.process_thread_name(line, file)
                     snapshot = ThreadSnapshot.create(line, file, self)
                     self.snapshots.append(snapshot)
         except Exception as e:
@@ -158,7 +159,8 @@ class Javacore:
         finally:
             file.close()
-    def processThreadName(self, line, file):
+    @staticmethod
+    def process_thread_name(line, file):
         count = line.count('"')
         if count == 0: return line  # anonymous native threads
         while True:

javacore_analyser/javacore_analyser_batch.py CHANGED Viewed

@@ -12,10 +12,11 @@ import shutil
 import sys
 import tarfile
 import tempfile
-import traceback
 import zipfile
+import importlib_resources
 import py7zr
+from importlib_resources.abc import Traversable
 from javacore_analyser import logging_utils
 from javacore_analyser.constants import DEFAULT_FILE_DELIMITER
@@ -69,15 +70,20 @@ def main():
     logging.info("Preferred encoding: " + locale.getpreferredencoding())
     parser = argparse.ArgumentParser()
-    parser.add_argument("input_param", help="Input file(s) or directory")
-    parser.add_argument("output_param", help="Report output directory")
+    parser.add_argument("input", help="Input javacore file(s) or directory with javacores. "
+                                      "The javacores can be packed "
+                                      "into one of the supported archive formats: zip, gz, bz2, lzma, 7z. "
+                                      "Additional the verbose GC logs from the time "
+                                      "when the javacores were collected can be added. "
+                                      "See doc: https://github.com/IBM/javacore-analyser/wiki")
+    parser.add_argument("output", help="Name of directory where report will be generated")
     parser.add_argument("--separator",
                         help='Input files separator (default "' + DEFAULT_FILE_DELIMITER + '")',
                         default=DEFAULT_FILE_DELIMITER)
     args = parser.parse_args()
-    input_param = args.input_param
-    output_param = args.output_param
+    input_param = args.input
+    output_param = args.output
     files_separator = args.separator
     logging.info("Input parameter: " + input_param)
@@ -89,17 +95,15 @@ def main():
     # Check whether as input we got list of files or single file
     # Semicolon is separation mark for list of input files
     if files_separator in input_param or fnmatch.fnmatch(input_param, '*javacore*.txt'):
-        # Process list of the files (copy all or them to output dir
+        # Process list of the files (copy all or them to output dir)
         files = input_param.split(files_separator)
     else:
         files = [input_param]
     try:
         process_javacores_and_generate_report_data(files, output_param)
     except Exception as ex:
-        traceback.print_exc(file=sys.stdout)
-        logging.error("Processing was not successful. Correct the problem and try again. Exiting with error 13",
-                      exc_info=True)
+        logging.exception(ex)
+        logging.error("Processing was not successful. Correct the problem and try again. Exiting with error 13")
         exit(13)
@@ -115,12 +119,9 @@ def generate_javecore_set_data(files):
     Returns:
     - JavacoreSet: Generated JavacoreSet object containing the processed data.
     """
+    javacores_temp_dir = tempfile.TemporaryDirectory()
     try:
         # Location when we store extracted archive or copied javacores files
-        javacores_temp_dir = tempfile.TemporaryDirectory()
         javacores_temp_dir_name = javacores_temp_dir.name
         for file in files:
             if os.path.isdir(file):
@@ -137,6 +138,24 @@ def generate_javecore_set_data(files):
         javacores_temp_dir.cleanup()
+def create_output_files_structure(output_dir):
+    if not os.path.isdir(output_dir):
+        os.mkdir(output_dir)
+    data_output_dir = os.path.normpath(os.path.join(output_dir, 'data'))
+    if not data_output_dir.startswith(output_dir):
+        raise Exception("Security exception: Uncontrolled data used in path expression")
+    if os.path.isdir(data_output_dir):
+        shutil.rmtree(data_output_dir, ignore_errors=True)
+    logging.info("Data dir: " + data_output_dir)
+    style_css_resource: Traversable = importlib_resources.files("javacore_analyser") / "data" / "style.css"
+    data_dir = os.path.dirname(str(style_css_resource))
+    os.mkdir(data_output_dir)
+    shutil.copytree(data_dir, data_output_dir, dirs_exist_ok=True)
+    shutil.copy2(os.path.join(data_output_dir, "html", "processing_data.html"),
+                 os.path.join(output_dir, "index.html"))
 # Assisted by WCA@IBM
 # Latest GenAI contribution: ibm/granite-8b-code-instruct
 def process_javacores_and_generate_report_data(input_files, output_dir):
@@ -150,6 +169,7 @@ def process_javacores_and_generate_report_data(input_files, output_dir):
     Returns:
     None
     """
+    create_output_files_structure(output_dir)
     javacore_set = generate_javecore_set_data(input_files)
     javacore_set.generate_report_files(output_dir)

javacore_analyser/javacore_analyser_web.py CHANGED Viewed

@@ -2,6 +2,7 @@
 # Copyright IBM Corp. 2024 - 2024
 # SPDX-License-Identifier: Apache-2.0
 #
+import argparse
 import locale
 import logging
 import os
@@ -9,6 +10,7 @@ import re
 import shutil
 import sys
 import tempfile
+import threading
 import time
 from pathlib import Path
@@ -16,29 +18,30 @@ from flask import Flask, render_template, request, send_from_directory, redirect
 from waitress import serve
 import javacore_analyser.javacore_analyser_batch
-from javacore_analyser.constants import DEFAULT_REPORTS_DIR, DEFAULT_PORT
+from javacore_analyser.constants import DEFAULT_REPORTS_DIR, DEFAULT_PORT, TEMP_DIR
 from javacore_analyser.logging_utils import create_console_logging, create_file_logging
 """
 To run the application from cmd type:
-export REPORTS_DIR=/tmp/reports
 flask --app javacore_analyser_web run
 """
 app = Flask(__name__)
-with app.app_context():
-    create_console_logging()
-    logging.info("Javacore analyser")
-    logging.info("Python version: " + sys.version)
-    logging.info("Preferred encoding: " + locale.getpreferredencoding())
-    reports_dir = os.getenv("REPORTS_DIR", DEFAULT_REPORTS_DIR)
-    logging.info("Reports directory: " + reports_dir)
-    create_file_logging(reports_dir)
+reports_dir = DEFAULT_REPORTS_DIR
+# Assisted by watsonx Code Assistant
+def create_temp_data_in_reports_dir(directory):
+    tmp_reports_dir = os.path.join(directory, TEMP_DIR)
+    if os.path.isdir(tmp_reports_dir):
+        shutil.rmtree(tmp_reports_dir, ignore_errors=True)
+    os.mkdir(tmp_reports_dir)
 @app.route('/')
 def index():
     reports = [{"name": Path(f).name, "date": time.ctime(os.path.getctime(f)), "timestamp": os.path.getctime(f)}
-               for f in os.scandir(reports_dir) if f.is_dir()]
+               for f in os.scandir(reports_dir) if f.is_dir() and Path(f).name is not TEMP_DIR]
     reports.sort(key=lambda item: item["timestamp"], reverse=True)
     return render_template('index.html', reports=reports)
@@ -50,8 +53,8 @@ def dir_listing(path):
 @app.route('/zip/<path:path>')
 def compress(path):
+    temp_zip_dir = tempfile.TemporaryDirectory()
     try:
-        temp_zip_dir = tempfile.TemporaryDirectory()
         temp_zip_dir_name = temp_zip_dir.name
         zip_filename = path + ".zip"
         report_location = os.path.join(reports_dir, path)
@@ -68,7 +71,7 @@ def compress(path):
 def delete(path):
     # Checking if the report exists. This is to prevent attempt to delete any data by deleting any file outside
     # report dir if you prepare path variable.
-    reports_list = os.listdir(reports_dir)
+    # reports_list = os.listdir(reports_dir)
     report_location = os.path.normpath(os.path.join(reports_dir, path))
     if not report_location.startswith(reports_dir):
         logging.error("Deleted report in report list. Not deleting")
@@ -82,10 +85,19 @@ def delete(path):
 # Latest GenAI contribution: ibm/granite-20b-code-instruct-v2
 @app.route('/upload', methods=['POST'])
 def upload_file():
+    report_name = request.values.get("report_name")
+    report_name = re.sub(r'[^a-zA-Z0-9]', '_', report_name)
+    # Create a temporary directory to store uploaded files
+    # Note We have to use permanent files and then delete them.
+    # tempfile.Temporary_directory function does not work when you want to access files from another threads.
+    javacores_temp_dir_name = os.path.normpath(os.path.join(reports_dir, TEMP_DIR, report_name))
+    if not javacores_temp_dir_name.startswith(reports_dir):
+        raise Exception("Security exception: Uncontrolled data used in path expression")
     try:
-        # Create a temporary directory to store uploaded files
-        javacores_temp_dir = tempfile.TemporaryDirectory()
-        javacores_temp_dir_name = javacores_temp_dir.name
+        os.mkdir(javacores_temp_dir_name)
         # Get the list of files from webpage
         files = request.files.getlist("files")
@@ -97,26 +109,46 @@ def upload_file():
             file.save(file_name)
             input_files.append(file_name)
-        report_name = request.values.get("report_name")
-        report_name = re.sub(r'[^a-zA-Z0-9]', '_', report_name)
         # Process the uploaded file
-        report_output_dir = reports_dir + '/' + report_name
-        javacore_analyser.javacore_analyser_batch.process_javacores_and_generate_report_data(input_files,
-                                                                                             report_output_dir)
+        report_output_dir = os.path.join(reports_dir, report_name)
+        processing_thread = threading.Thread(
+            target=javacore_analyser.javacore_analyser_batch.process_javacores_and_generate_report_data,
+            name="Processing javacore data", args=(input_files, report_output_dir)
+        )
+        processing_thread.start()
+        time.sleep(1)  # Give 1 second to generate index.html in processing_thread before redirecting
         return redirect("/reports/" + report_name + "/index.html")
     finally:
-        javacores_temp_dir.cleanup()
+        shutil.rmtree(javacores_temp_dir_name, ignore_errors=True)
 def main():
-    debug = os.getenv("DEBUG", False)
-    port = os.getenv("PORT", DEFAULT_PORT)
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--debug", help="Debug mode. Use only for development", default=False)
+    parser.add_argument("--port", help="Port to run application", default=DEFAULT_PORT)
+    parser.add_argument("--reports-dir", help="Directory where app reports are stored",
+                        default=DEFAULT_REPORTS_DIR)
+    args = parser.parse_args()
+    debug = args.debug
+    port = args.port
+    global reports_dir
+    reports_dir = args.reports_dir
+    create_console_logging()
+    logging.info("Javacore analyser")
+    logging.info("Python version: " + sys.version)
+    logging.info("Preferred encoding: " + locale.getpreferredencoding())
+    logging.info("Reports directory: " + reports_dir)
+    create_file_logging(reports_dir)
+    create_temp_data_in_reports_dir(reports_dir)
     if debug:
         app.run(debug=True, port=port)  # Run Flask for development
     else:
         serve(app, port=port)  # Run Waitress in production
 if __name__ == '__main__':
     """
     The application passes the following environmental variables:

javacore_analyser/javacore_set.py CHANGED Viewed

@@ -15,7 +15,6 @@ from pathlib import Path
 from xml.dom.minidom import parseString
 import importlib_resources
-from importlib_resources.abc import Traversable
 from lxml import etree
 from lxml.etree import XMLSyntaxError
 from tqdm import tqdm
@@ -34,7 +33,7 @@ def _create_xml_xsl_for_collection(tmp_dir, templates_dir, xml_xsl_filename, col
     logging.info("Creating xmls and xsls in " + tmp_dir)
     os.mkdir(tmp_dir)
     extensions = [".xsl", ".xml"]
-    for extension in extensions:
+    for extension in tqdm(extensions, desc="Creating xml/xsl files", unit=" file"):
         file_full_path = os.path.normpath(os.path.join(templates_dir, xml_xsl_filename + extension))
         if not file_full_path.startswith(templates_dir):
             raise Exception("Security exception: Uncontrolled data used in path expression")
@@ -91,6 +90,7 @@ class JavacoreSet:
     # Assisted by WCA@IBM
     # Latest GenAI contribution: ibm/granite-8b-code-instruct
+    @staticmethod
     def process_javacores(input_path):
         """
         Processes Java core data and generates tips based on the analysis.
@@ -126,26 +126,30 @@ class JavacoreSet:
         temp_dir = tempfile.TemporaryDirectory()
         temp_dir_name = temp_dir.name
         logging.info("Created temp dir: " + temp_dir_name)
-        self.__create_output_files_structure(output_dir)
         self.__create_report_xml(temp_dir_name + "/report.xml")
+        placeholder_filename = os.path.join(output_dir, "data", "html", "processing_data.html")
+        self.__generate_placeholder_htmls(placeholder_filename,
+                                          os.path.join(output_dir, "threads"),
+                                          self.threads, "thread")
+        self.__generate_placeholder_htmls(placeholder_filename,
+                                          os.path.join(output_dir, "javacores"),
+                                          self.javacores, "")
+        self.__create_index_html(temp_dir_name, output_dir)
         self.__generate_htmls_for_threads(output_dir, temp_dir_name)
         self.__generate_htmls_for_javacores(output_dir, temp_dir_name)
-        self.__create_index_html(temp_dir_name, output_dir)
-    def __create_output_files_structure(self, output_dir):
-        if not os.path.isdir(output_dir):
-            os.mkdir(output_dir)
-        data_output_dir = os.path.normpath(os.path.join(output_dir, 'data'))
-        if not data_output_dir.startswith(output_dir):
-            raise Exception("Security exception: Uncontrolled data used in path expression")
-        if os.path.isdir(data_output_dir):
-            shutil.rmtree(data_output_dir, ignore_errors=True)
-        logging.info("Data dir: " + data_output_dir)
+    @staticmethod
+    def __generate_placeholder_htmls(placeholder_file, directory, collection, file_prefix):
+        if os.path.exists(directory):
+            shutil.rmtree(directory)
+        os.mkdir(directory)
-        style_css_resource: Traversable = importlib_resources.files("javacore_analyser") / "data" / "style.css"
-        data_dir = os.path.dirname(style_css_resource)
-        os.mkdir(data_output_dir)
-        shutil.copytree(data_dir, data_output_dir, dirs_exist_ok=True)
+        for element in tqdm(collection, desc="Generating placeholder htmls", unit=" file"):
+            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)
     def __generate_htmls_for_threads(self, output_dir, temp_dir_name):
         _create_xml_xsl_for_collection(os.path.join(temp_dir_name, "threads"),
@@ -168,7 +172,7 @@ class JavacoreSet:
     def populate_snapshot_collections(self):
         for javacore in self.javacores:
             javacore.print_javacore()
-            for s in javacore.snapshots:
+            for s in tqdm(javacore.snapshots, desc="Populating snapshot collection", unit=" javacore"):
                 self.threads.add_snapshot(s)
                 self.stacks.add_snapshot(s)
@@ -236,6 +240,7 @@ class JavacoreSet:
         filename = os.path.join(self.path, filename)
         curr_line = ""
         i = 0
+        file = None
         try:
             file = open(filename, 'r')
             for line in file:
@@ -255,17 +260,18 @@ class JavacoreSet:
                 elif line.startswith(JAVA_VERSION):
                     self.java_version = line[len(JAVA_VERSION) + 1:].strip()
                     continue
-        except Exception as e:
-            print(f'Error during processing file: {file.name} \n'
-                  f'line number: {i} \n'
-                  f'line: {curr_line}\n'
-                  f'Check the exception below what happened')
+        except Exception as ex:
+            logging.exception(ex)
+            logging.error(f'Error during processing file: {file.name} \n'
+                          f'line number: {i} \n'
+                          f'line: {curr_line}\n'
+                          f'Check the exception below what happened')
         finally:
             file.close()
     def parse_javacores(self):
         """ creates a Javacore object for each javacore...txt file in the given path """
-        for filename in self.files:
+        for filename in tqdm(self.files, "Parsing javacore files", unit=" file"):
             filename = os.path.join(self.path, filename)
             javacore = Javacore()
             javacore.create(filename, self)
@@ -285,7 +291,7 @@ class JavacoreSet:
     #     return None
     def sort_snapshots(self):
-        for thread in self.threads:
+        for thread in tqdm(self.threads, "Sorting snapshot data", unit=" snapshot"):
             thread.sort_snapshots()
             # thread.compare_call_stacks()
@@ -316,7 +322,7 @@ class JavacoreSet:
     def print_thread_states(self):
         for thread in self.threads:
             logging.debug("max running states:" + str(thread.get_continuous_running_states()))
-            logging.debug(thread.name + "(id: " + str(thread.id) + "; hash: " + thread.get_hash() + ") " + \
+            logging.debug(thread.name + "(id: " + str(thread.id) + "; hash: " + thread.get_hash() + ") " +
                           "states: " + thread.get_snapshot_states())
     # Assisted by WCA@IBM
@@ -476,6 +482,7 @@ class JavacoreSet:
         Returns:
         str: The JavaCore set in the XML format.
         """
+        file = None
         try:
             file = open(self.report_xml_file, "r")
             content = file.read()
@@ -494,11 +501,12 @@ class JavacoreSet:
     def __create_index_html(input_dir, output_dir):
         # Copy index.xml and report.xsl to temp - for index.html we don't need to generate anything. Copying is enough.
-        #index_xml = validate_uncontrolled_data_used_in_path([output_dir, "data", "xml", "index.xml"])
-        index_xml = os.path.normpath(importlib_resources.files("javacore_analyser") / "data" / "xml" / "index.xml")
+        # index_xml = validate_uncontrolled_data_used_in_path([output_dir, "data", "xml", "index.xml"])
+        index_xml = os.path.normpath(str(importlib_resources.files("javacore_analyser") / "data" / "xml" / "index.xml"))
         shutil.copy2(index_xml, input_dir)
-        report_xsl = os.path.normpath(importlib_resources.files("javacore_analyser") / "data" / "xml" / "report.xsl")
+        report_xsl = os.path.normpath(
+            str(importlib_resources.files("javacore_analyser") / "data" / "xml" / "report.xsl"))
         shutil.copy2(report_xsl, input_dir)
         xslt_doc = etree.parse(input_dir + "/report.xsl")
@@ -521,6 +529,10 @@ class JavacoreSet:
             os.mkdir(output_dir)
         shutil.copy2(report_xml_file, data_input_dir)
+        # https://docs.python.org/3.8/library/multiprocessing.html
+        threads_no = JavacoreSet.get_number_of_parallel_threads()
+        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')
@@ -529,9 +541,6 @@ class JavacoreSet:
         for file in list_files:
             generate_html_from_xml_xsl_files_params.append((file, data_input_dir, output_dir, progress_bar))
-        # https://docs.python.org/3.8/library/multiprocessing.html
-        threads_no = JavacoreSet.get_number_of_parallel_threads()
-        logging.info(f"Using {threads_no} threads to generate html files")
         with Pool(threads_no) as p:
             p.map(JavacoreSet.generate_html_from_xml_xsl_files, generate_html_from_xml_xsl_files_params)
@@ -575,7 +584,8 @@ class JavacoreSet:
         progress_bar.update(1)
-    def create_xml_xsl_for_collection(self, tmp_dir, xml_xsls_prefix_path, collection, output_file_prefix):
+    @staticmethod
+    def create_xml_xsl_for_collection(tmp_dir, xml_xsls_prefix_path, collection, output_file_prefix):
         logging.info("Creating xmls and xsls in " + tmp_dir)
         os.mkdir(tmp_dir)
         extensions = [".xsl", ".xml"]
@@ -595,7 +605,7 @@ class JavacoreSet:
     @staticmethod
     def parse_mem_arg(line):
         line = line.split()[-1]  # avoid matching the '2' in tag name 2CIUSERARG
-        tokens = re.findall("[\d]+[KkMmGg]?$", line)
+        tokens = re.findall("\d+[KkMmGg]?$", line)
         if len(tokens) != 1: return UNKNOWN
         return tokens[0]

javacore_analyser/snapshot_collection_collection.py CHANGED Viewed

@@ -2,6 +2,8 @@
 # Copyright IBM Corp. 2024 - 2024
 # SPDX-License-Identifier: Apache-2.0
 #
+from tqdm import tqdm
 class SnapshotCollectionCollection:
@@ -23,15 +25,15 @@ class SnapshotCollectionCollection:
     def __iter__(self):
         return self.snapshot_collections.__iter__()
-    def __next__(self):
-        return self.snapshot_collections.__next__()
+    # def __next__(self):
+    #    return self.snapshot_collections.__next__()
     def get_xml(self, doc):
         info_node = doc.createElement(self.snapshot_collection_type.__name__)
         all_threads_node = doc.createElement('all_snapshot_collection')
         info_node.appendChild(all_threads_node)
-        for collection in self.snapshot_collections:
+        for collection in tqdm(self.snapshot_collections, desc=" Generating threads data", unit=" thread"):
             all_threads_node.appendChild(collection.get_xml(doc))
         return info_node

javacore_analyser/stack_trace.py CHANGED Viewed

@@ -26,8 +26,8 @@ class StackTrace:
     def __iter__(self):
         return self.stack_trace_elements.__iter__()
-    def __next__(self):
-        return self.stack_trace_elements.__next__()
+    # def __next__(self):
+    #    return self.stack_trace_elements.__next__()
     def equals(self, stack_trace):
         self_stack_trace_size = len(self.stack_trace_elements)

javacore_analyser/stack_trace_element.py CHANGED Viewed

@@ -9,7 +9,7 @@ from javacore_analyser.stack_trace_kind import StackTraceKind
 class StackTraceElement:
-    def __init__(self, line = None):
+    def __init__(self, line=None):
         if line is None:
             self.line = None
             self.kind = StackTraceKind.JAVA

javacore_analyser/thread_snapshot.py CHANGED Viewed

@@ -2,7 +2,7 @@
 # Copyright IBM Corp. 2024 - 2024
 # SPDX-License-Identifier: Apache-2.0
 #
+import logging
 import os
 import re
 from datetime import datetime
@@ -123,7 +123,8 @@ class ThreadSnapshot:
         try:
             token = m.group(1)
             self.cpu_usage = float(token)
-        except:
+        except Exception as ex:
+            logging.warning(ex)
             self.cpu_usage = 0
         # tokens = re.findall("[0-9]+\.[0-9]+", line)
         # if len(tokens) == 0:

javacore_analyser/tips.py CHANGED Viewed

@@ -2,6 +2,7 @@
 # Copyright IBM Corp. 2024 - 2024
 # SPDX-License-Identifier: Apache-2.0
 #
+import logging
 # This is a module containing list of the tips.
 # Each tip has to implement dynamic method generate(javacore_set)
@@ -16,6 +17,7 @@ class TestTip:
     @staticmethod
     def generate(javacore_set):
+        logging.info(javacore_set)
         return ["this is a test tip. Ignore it."]
@@ -157,7 +159,7 @@ class BlockingThreadsTip:
                 result.append(BlockingThreadsTip.BLOCKING_THREADS_TEXT.format(blocker_name,
                                                                               blocked_size / javacores_no))
                 if len(result) >= BlockingThreadsTip.MAX_BLOCKING_THREADS_NO:
-                    break;
+                    break
         return result
@@ -165,9 +167,9 @@ class HighCpuUsageTip:
     # Generates the tip if the thread is using above x percent of CPU. Also informs, if this is verbose gc thread.
     # Report as high cpu usage for the application using the cpu usage above this value
-    CRITICAL_CPU_USAGE = 50;
+    CRITICAL_CPU_USAGE = 50
-    CRITICAL_USAGE_FOR_GC = 5;
+    CRITICAL_USAGE_FOR_GC = 5
     MAX_NUMBER_OF_HIGH_CPU_USAGE_THREADS = 5

javacore_analyser/verbose_gc.py CHANGED Viewed

@@ -8,6 +8,8 @@ import ntpath
 from datetime import datetime
 from xml.dom.minidom import Element, parseString
+from tqdm import tqdm
 ROOT_CLOSING_TAG = "</verbosegc>"
 GC_START = "gc-start"
 GC_END = "gc-end"
@@ -43,7 +45,7 @@ class VerboseGcParser:
     def parse_files(self, start_time, stop_time):
         logging.info("Started parsing GC files")
-        for file_path in self.__file_paths:
+        for file_path in tqdm(self.__file_paths, desc="Parsing verbose gc", unit=" file"):
             try:
                 collects_from_time_range = 0
                 file = VerboseGcFile(file_path)
@@ -109,6 +111,7 @@ class VerboseGcFile:
     def __parse(self):
         # read in the file as collection of lines
+        file = None
         try:
             xml_text = ""
             root_closing_tag_available = False

{javacore_analyser-2.0rc3.dist-info → javacore_analyser-2.1.0.dev66.dist-info}/METADATA RENAMED Viewed

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: javacore_analyser
-Version: 2.0rc3
+Version: 2.1.0.dev66
 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
@@ -209,6 +209,7 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -280,9 +281,7 @@ This is recommended for geeks only:
 #### Running cmd application:
 1. Install application if not done yet
 2. Activate your created virtual environment according to activate Virtual Environment according to [Creating virtual environments](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments)
-3. Install the requirements using pip:
- `pip install requirements.txt`
-4. Run the following command from cmd: `javacore-analyser-batch <input-data> <generated-reports-dir>`
+3. Run the following command from cmd: `javacore-analyser-batch <input-data> <generated-reports-dir>`
 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
@@ -292,17 +291,28 @@ You can type the following command to obtain the help:
 #### Running web application:
 1. Repeat steps 1-3 from cmd application
-2. OPTIONAL: set the following variables:
-  ```
-  export REPORTS_DIR=/tmp/reports
-  export PORT=5000
-  ```
- The first parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.
- The first parameter set the port to use by application. If not specified, 5000 will be used.
-3. Execute the following command from cmd:
-  `javacore_analyser_web`
+2. Execute the following command from cmd:
+  `javacore_analyser_web --port=500 --reports-dir=/data/reports_dir`
+     The first parameter set the port to use by application. If not specified, 5000 will be used.
+     The second parameter sets where the reports need to be stored. If not set, then the `reports` dir will be created in current location.
   Now you can type (http://localhost:5000/).
+### Running container image
+There is an unofficial Docker/Podman container managed by one of projects developers. Use the following command
+to start it:
+`podman run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`
+or
+`docker run -it --rm --name javacore-analyser --mount type=bind,src="/local-reports-dir",target=/reports -p 5001:5000 ghcr.io/kkazmierczyk/javacore-analyser:latest`
+The `mount` option specifies where you want locally to store the reports. The reports in the container are stored in
+`/reports` directory. If you remove mount option, the application will work but the reports will not persist after
+restart.
+The application is running in the container on port 5000. By using `-p 5001:5000` option, you specify to map container
+port 5000 to port 5001 on your machine. Therefore the application will be available under `http://localhost:5001/`.
 <!-- The following are OPTIONAL, but strongly suggested to have in your repository. -->
 <!--

{javacore_analyser-2.0rc3.dist-info → javacore_analyser-2.1.0.dev66.dist-info}/RECORD RENAMED Viewed

@@ -1,23 +1,24 @@
 javacore_analyser/__init__.py,sha256=Sw2ZeqcI2Kx1cDDv083n1SiSY_FDRCmidTuzaN1uRSw,76
-javacore_analyser/abstract_snapshot_collection.py,sha256=zXLRPQRdFpOufC8OVMh1wAhFnFDYQgWy10zZOZWaZQc,5592
+javacore_analyser/abstract_snapshot_collection.py,sha256=jGfd2XgujurRlKgEtlJjqNJK9sUvTdFsdgFnX9oLzt4,5589
 javacore_analyser/code_snapshot_collection.py,sha256=6_C5myag5ocjOTwXVDbBamN6Lf1szgS3ylSHEEjUdVg,2655
-javacore_analyser/constants.py,sha256=hGEsldGuuJGqy1iM7POiQnjVqNLclO5CjIKeIW2oeIQ,924
+javacore_analyser/constants.py,sha256=iGYAznPK8AySq6uqk-cpCU8Dbjbq6PrCh6q2mF8oeu8,1003
 javacore_analyser/java_thread.py,sha256=4zUfmmlH47SrIxgfPmrJHl_YUziVJXVNVedD5X25vXY,4464
-javacore_analyser/javacore.py,sha256=NkvxN6C93eG24wEB_kfH-yf0_f_ECj7Let4bQ1i22AM,6860
-javacore_analyser/javacore_analyser_batch.py,sha256=ApC_xcDMIP4DxQ0MUiD6XrF3hzcyFmofVH1Jq4-6_4s,5408
-javacore_analyser/javacore_analyser_web.py,sha256=DJgzHKuGUkATKaE7pI6zOQPGITB6hdM86tUXsZ1fCWw,4526
-javacore_analyser/javacore_set.py,sha256=3_KfoT4wKYmUROUQXJInaPxKi60zauqAK11Iat3Y55Q,30689
+javacore_analyser/javacore.py,sha256=_2abTyvXEaZ6Tx8r9d3NEzRCIBcf4Is8lSjpKyPu-R8,6884
+javacore_analyser/javacore_analyser_batch.py,sha256=g6xVPYFDHTaXDbaruyMRUrD3g2IlJK3Ht-XUzHv3LoQ,6802
+javacore_analyser/javacore_analyser_web.py,sha256=Ef91ZTI5TBaJPJhl0FtzrFHvzJNPLe07fmvbvik3OJQ,5788
+javacore_analyser/javacore_set.py,sha256=YM6ZKUhbfqzjuKE5y7Jy19Hbl-BSLA1i5gIsP7NbX38,31241
 javacore_analyser/logging_utils.py,sha256=vLob0ikezysjGv9XGqv9GbLekxu4eO_csq22M-gtLiQ,966
 javacore_analyser/snapshot_collection.py,sha256=fLEnwg9-cOjVVUUludtzI7R2yO9BBVgJgxkhvqG5QDg,443
-javacore_analyser/snapshot_collection_collection.py,sha256=JyNr038nC8mcX1mjeXjNSzZT4oE9ACFmCYJORUKzyvw,1265
-javacore_analyser/stack_trace.py,sha256=RY1nmvSA_lyRqVejHcXBbxT8EhbkJPktBqsQ4kKSgtA,1661
-javacore_analyser/stack_trace_element.py,sha256=1WOV7pilb8RAc_hMN7lsXMrPevW6WFHAaLOGpsMmJgs,1145
+javacore_analyser/snapshot_collection_collection.py,sha256=1PV1TX4QQk01dAbX-k-kTpgKr6Il867Bw6X7HHBuv-Q,1346
+javacore_analyser/stack_trace.py,sha256=8sb8z4ac_L0yyxqJX1ukrTZRyngkHcA3zkXyqxG5ygA,1664
+javacore_analyser/stack_trace_element.py,sha256=pZPrK1ACBUDE7YsVOFhTfewXequ1m5P-B0N-9RuhkWo,1143
 javacore_analyser/stack_trace_kind.py,sha256=lOdfb_F3XrwDLciPk_ZgM_fmMn5JoXsIUjr7pjvmU4M,157
-javacore_analyser/thread_snapshot.py,sha256=TR0StpE-r4FYax8oULUANBsKJDYX3FQ0lwzwnvEPxic,13193
-javacore_analyser/tips.py,sha256=pA8mpmyPk9RXPVt5GFiB9dlhiBeiGPKUBgJgvPRUmLk,8608
-javacore_analyser/verbose_gc.py,sha256=mSFIRb-thl5nrdEd_SOxFcvobso_07NQ2_g1_9IXgY0,6782
-javacore_analyser/data/expand.js,sha256=mNjvT_00YHQxWhlAQwFElzlhBWvKP5WEMSWJkL1PKl8,954
+javacore_analyser/thread_snapshot.py,sha256=2Do8NPBXdpUezQrUI_9nyGbtU4b2s5euPnHqcuuKq7U,13255
+javacore_analyser/tips.py,sha256=EhwLUAha0FvFJtO5kmvba9a1nKXGdqNHFa2jFbHZr4U,8655
+javacore_analyser/verbose_gc.py,sha256=LLJ-PS2maOkP6zfW-RBGoEoHQBI99Reejb1tqpZispY,6872
+javacore_analyser/data/expand.js,sha256=KwqvNUoO7yMDeQKcnLDywfMdR3Zsjan5L8QoPsQQLGo,956
 javacore_analyser/data/style.css,sha256=YzHl0NSnfRik4ar6AInp7pZ_re1rirQy6L5jqdbKoKg,2246
+javacore_analyser/data/html/processing_data.html,sha256=S1S2GMXQ8oQdqdYTcPzVMxUib-NLtM4ffT3OJaIIO7w,421
 javacore_analyser/data/jquery/chart.js,sha256=tgiW1vJqfIKxE0F2uVvsXbgUlTyrhPMY_sm30hh_Sxc,203464
 javacore_analyser/data/jquery/chartjs-adapter-date-fns.bundle.min.js,sha256=6nqzDSbDjc8fLSa7Q-c6lFN7WPGQb1XhpUbdCTIbVhU,50650
 javacore_analyser/data/jquery/jq.css,sha256=CXwJ7OOkFWXsebmAipjne1TnNanpp_2z241eLsVB7Ls,6751
@@ -25,7 +26,7 @@ javacore_analyser/data/jquery/jquery.mark.min.js,sha256=p_nep2K57or4Km0eXahvl6J_
 javacore_analyser/data/jquery/jquery.min.js,sha256=pvPw-upLPUjgMXY0G-8O0xUf-_Im1MZjXxxgOcBQBXU,89947
 javacore_analyser/data/jquery/jquery.tablesorter.min.js,sha256=dtGH1XcAyKopMui5x20KnPxuGuSx9Rs6piJB_4Oqu6I,44365
 javacore_analyser/data/jquery/jquery.tablesorter.widgets.min.js,sha256=GxbszpUzg-iYIcyDGyNVLz9Y0dQvzmQgXXVk5cHJbw0,53100
-javacore_analyser/data/jquery/search.js,sha256=hY0kp5ZIUazzM32hEmArA3ql6MTiOjjf5wosxXvowAw,3398
+javacore_analyser/data/jquery/search.js,sha256=Jwi-cBJ9YKDHJwqIlcKXqrpcM1BX-wx93uKAR44JLww,4200
 javacore_analyser/data/jquery/sorting.js,sha256=HsuVLa7F70IM4ZMXZpjj7wtVI1TXL1SPbZGWenv0Jp8,369
 javacore_analyser/data/jquery/theme.blue.css,sha256=mI0RCGd6G5GOKSG7BPagp0N58xipSjPXUKvrcHJ4h1Q,7528
 javacore_analyser/data/jquery/theme.default.min.css,sha256=5sgExNTnkN8NcApKIU73_aqgZmqq_zJp9-9zXf9aSEw,4502
@@ -37,8 +38,8 @@ javacore_analyser/data/xml/javacores/javacore.xsl,sha256=5cnIp08Q9FccljHH8duoJQY
 javacore_analyser/data/xml/threads/thread.xml,sha256=6dG89Whx1_kpEYVS_F6Upa2XuXnXorlQATFc8kD5Mfc,280
 javacore_analyser/data/xml/threads/thread.xsl,sha256=rkqr5GQ2aZ_xrdhUjl2QZDCZ-09zxqUmtV8DFZVjTAA,13927
 javacore_analyser/templates/index.html,sha256=aEuyry-HZ9HlQNwfbugugvqbSxwlo7LrQnrDmqO34YE,1682
-javacore_analyser-2.0rc3.dist-info/METADATA,sha256=BuAHmwoorqey194rBsfXSbM8kTaBWfZE0OyjgADWlS0,20358
-javacore_analyser-2.0rc3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-javacore_analyser-2.0rc3.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
-javacore_analyser-2.0rc3.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-javacore_analyser-2.0rc3.dist-info/RECORD,,
+javacore_analyser-2.1.0.dev66.dist-info/METADATA,sha256=Viz5zYXbffyGSshp-4U0fTiKLOFoTN4wmNP2aAziw18,21231
+javacore_analyser-2.1.0.dev66.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+javacore_analyser-2.1.0.dev66.dist-info/entry_points.txt,sha256=W3S799zI58g5-jWMsC3wY9xksz21LPEMYOILv8sayfM,160
+javacore_analyser-2.1.0.dev66.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+javacore_analyser-2.1.0.dev66.dist-info/RECORD,,

{javacore_analyser-2.0rc3.dist-info → javacore_analyser-2.1.0.dev66.dist-info}/WHEEL RENAMED Viewed

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{javacore_analyser-2.0rc3.dist-info → javacore_analyser-2.1.0.dev66.dist-info}/entry_points.txt RENAMED Viewed

File without changes

{javacore_analyser-2.0rc3.dist-info → javacore_analyser-2.1.0.dev66.dist-info}/licenses/LICENSE RENAMED Viewed

File without changes

javacore-analyser 2.0rc3__py3-none-any.whl → 2.1.0.dev66__py3-none-any.whl

javacore-analyser 2.0rc3py3-none-any.whl → 2.1.0.dev66py3-none-any.whl