Added Top entries in text form; added Output graph image in PNG format (#124)

* perf:record artifacts: added Top entries in text form; added Output graph image in PNG format

* Bumping version from 0.2.0 to 0.2.1

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.2.0"
+version = "0.2.1"
 description = "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... )."
 authors = ["filipecosta90 <[email protected]>"]
 readme = "README.md"

redisbench_admin/profilers/perf.py

@@ -10,7 +10,13 @@
 import subprocess
 import time
 
+from redisbench_admin.profilers.pprof import (
+    PPROF_FORMAT_TEXT,
+    run_pprof,
+    PPROF_FORMAT_PNG,
+)
 from redisbench_admin.profilers.profilers import STACKCOLLAPSE_PATH, FLAMEGRAPH_PATH
+from redisbench_admin.utils.utils import whereis
 
 
 class Perf:
@@ -50,6 +56,8 @@ def __init__(self):
         self.profile_start_time = None
         self.profile_end_time = None
 
+        self.pprof_bin = whereis("pprof")
+
     def retrieve_perf_version(self):
         try:
             self.version = subprocess.Popen(
@@ -114,7 +122,7 @@ def _is_alive(self, process):
             return True
         return False
 
-    def stop_profile(self):
+    def stop_profile(self, **kwargs):
         """
         @return: returns True if profiler stop, False if unsuccessful
         """
@@ -233,15 +241,48 @@ def stack_collapse(self, filename=None):
                 logging.error("Unable to open {0}".format(self.trace_file))
         return result
 
-    def generate_outputs(self, use_case, details=""):
-        result = False
+    def generate_outputs(self, use_case, **kwargs):
         outputs = {}
+        binary = kwargs.get("binary")
+        details = kwargs.get("details")
+        if details is None:
+            details = ""
+        result = True
         # generate flame graph
-        result, flame_graph_output = self.generate_flame_graph(
+        artifact_result, flame_graph_output = self.generate_flame_graph(
             "Flame Graph: " + use_case, details
         )
-        if result is True:
+        if artifact_result is True:
             outputs["Flame Graph"] = flame_graph_output
+        result &= artifact_result
+
+        if self.pprof_bin is None:
+            logging.error(
+                "Unable to detect pprof. Some of the capabilities will be disabled"
+            )
+        else:
+            logging.info("Generating pprof text output")
+            pprof_text_output = self.output + ".pprof.txt"
+            artifact_result, pprof_artifact_text_output = run_pprof(
+                self.pprof_bin,
+                PPROF_FORMAT_TEXT,
+                pprof_text_output,
+                binary,
+                self.output,
+            )
+            result &= artifact_result
+
+            if artifact_result is True:
+                outputs["Top entries in text form"] = pprof_artifact_text_output
+            logging.info("Generating pprof png output")
+            pprof_png_output = self.output + ".pprof.png"
+            artifact_result, pprof_artifact_png_output = run_pprof(
+                self.pprof_bin, PPROF_FORMAT_PNG, pprof_png_output, binary, self.output
+            )
+            if artifact_result is True:
+                outputs["Output graph image in PNG format"] = pprof_artifact_png_output
+            result &= artifact_result
+
         return result, outputs
 
     def generate_flame_graph(self, title="Flame Graph", subtitle="", filename=None):

redisbench_admin/profilers/pprof.py

@@ -0,0 +1,67 @@
+#  BSD 3-Clause License
+#
+#  Copyright (c) 2021., Redis Labs Modules
+#  All rights reserved.
+#
+
+import logging
+import os
+import subprocess
+
+PPROF_FORMAT_TEXT = "-text"
+PPROF_FORMAT_PS = "-ps"
+PPROF_FORMAT_PNG = "-png"
+
+
+def generate_pprof_cmd_args(
+    pprof_bin,
+    format,
+    output,
+    main_binary,
+    profile,
+    edge_fraction=0.01,
+    node_fraction=0.01,
+):
+    cmd = [
+        pprof_bin,
+        format,
+        "-edgefraction",
+        "{}".format(edge_fraction),
+        "-nodefraction",
+        "{}".format(node_fraction),
+        "-output",
+        "{}".format(output),
+        main_binary,
+        profile,
+    ]
+    return cmd
+
+
+def run_pprof(
+    pprof_bin,
+    format,
+    output,
+    main_binary,
+    profile,
+    edge_fraction=0.01,
+    node_fraction=0.01,
+):
+    status = False
+    result_artifact = None
+    args = generate_pprof_cmd_args(
+        pprof_bin, format, output, main_binary, profile, edge_fraction, node_fraction
+    )
+    try:
+        logging.info("Running pprof {} with args {}".format(pprof_bin, args))
+        pprof_process = subprocess.Popen(args=args)
+        pprof_return_code = pprof_process.wait()
+        if pprof_return_code <= 0:
+            status = True
+            result_artifact = os.path.abspath(output)
+    except OSError as e:
+        logging.error(
+            "Unable to run {} format {}. Error {}".format(
+                pprof_bin, format, e.__str__()
+            )
+        )
+    return status, result_artifact

redisbench_admin/run_local/run_local.py

@@ -222,11 +222,18 @@ def run_local_command_logic(args):
                     )
                     profiler_obj.stop_profile()
 
-                    # Generate Flame Graph SVG.
+                    # Generate:
+                    #  - artifact with Flame Graph SVG
+                    #  - artifact with output graph image in PNG format
+                    #  - artifact with top entries in text form
                     (
                         profile_res,
                         profile_res_artifacts_map,
-                    ) = profiler_obj.generate_outputs(test_name, collection_summary_str)
+                    ) = profiler_obj.generate_outputs(
+                        test_name,
+                        details=collection_summary_str,
+                        binary=local_module_file,
+                    )
                     if profile_res is True:
                         logging.info(
                             "Profiler {} for pid {} ran successfully and generated {} artifacts.".format(