Enabled to specify profile mode in profiler daemon (#323)

Author: filipecosta90

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.7.17"
+version = "0.7.18"
 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]>","Redis Performance Group <[email protected]>"]
 readme = "README.md"

redisbench_admin/profilers/daemon.py

@@ -126,6 +126,7 @@ def ping():
 
         @app.route("/profiler/<profiler_name>/start/<pid>", methods=["POST"])
         def profile_start(profiler_name, pid):
+            callgraph_mode = request.args.get("callgraph_mode", default="fp", type=str)
             setup_process_number = 1
             total_involved_processes = 1
             (
@@ -173,9 +174,7 @@ def profile_start(profiler_name, pid):
             )
             app.logger.info("Storing profile in {}".format(profile_filename))
             result = self.perf.start_profile(
-                pid,
-                profile_filename,
-                DEFAULT_PROFILE_FREQ,
+                pid, profile_filename, DEFAULT_PROFILE_FREQ, callgraph_mode
             )
             status_dict = {
                 "result": result,

redisbench_admin/profilers/perf.py

@@ -19,6 +19,9 @@
 from redisbench_admin.utils.utils import whereis
 
 PERF_CALLGRAPH_MODE_DEFAULT = "fp"
+PERF_CALLGRAPH_MODE = os.getenv("PERF_CALLGRAPH_MODE", PERF_CALLGRAPH_MODE_DEFAULT)
+PERF_PROFILE_TIME_DEFAULT = "60"
+PERF_PROFILE_TIME = int(os.getenv("PERF_PROFILE_TIME", PERF_PROFILE_TIME_DEFAULT))
 LINUX_PERF_SETTINGS_MESSAGE = (
     "If running in non-root user please confirm that you have:\n"
     + " - access to Kernel address maps."
@@ -42,9 +45,8 @@ def __init__(self):
 
         self.stack_collapser = os.getenv("STACKCOLLAPSE_PATH", STACKCOLLAPSE_PATH)
         self.flamegraph_utity = os.getenv("FLAMEGRAPH_PATH", FLAMEGRAPH_PATH)
-        self.callgraph_mode = os.getenv(
-            "PERF_CALLGRAPH_MODE", PERF_CALLGRAPH_MODE_DEFAULT
-        )
+        self.callgraph_mode = PERF_CALLGRAPH_MODE
+        self.default_profile_time = PERF_PROFILE_TIME
 
         self.output = None
         self.profiler_process = None
@@ -86,9 +88,15 @@ def retrieve_perf_version(self):
             self.version_minor = m.group(2)
         return m, self.version_major, self.version_minor
 
-    def generate_record_command(self, pid, output, frequency=None):
+    def generate_record_command(
+        self, pid, output, frequency=None, callgraph_mode=None, profile_time=None
+    ):
         self.output = output
         self.pid = pid
+        if callgraph_mode is not None:
+            self.callgraph_mode = callgraph_mode
+        if profile_time is not None:
+            self.default_profile_time = profile_time
         cmd = [
             self.perf,
             "record",
@@ -104,6 +112,8 @@ def generate_record_command(self, pid, output, frequency=None):
         ]
         if frequency:
             cmd += ["--freq", "{}".format(frequency)]
+        if self.default_profile_time:
+            cmd += ["--", "sleep", "{}".format(self.default_profile_time)]
         return cmd
 
     def generate_report_command(
@@ -134,7 +144,9 @@ def generate_report_command(
             cmd.extend(extra_options)
         return cmd
 
-    def start_profile(self, pid, output, frequency=99):
+    def start_profile(
+        self, pid, output, frequency=99, callgraph_mode=None, profile_time=None
+    ):
         """
         @param pid: profile events on specified process id
         @param output: output file name
@@ -157,7 +169,9 @@ def start_profile(self, pid, output, frequency=99):
                 "env": self.environ,
             }
 
-            args = self.generate_record_command(pid, output, frequency)
+            args = self.generate_record_command(
+                pid, output, frequency, callgraph_mode, profile_time
+            )
             self.logger.info(
                 "Starting profile of pid {} with args {}".format(pid, args)
             )
@@ -193,20 +207,10 @@ def stop_profile(self, **kwargs):
                     self.profiler_process_exit_code
                 )
             )
-            (
-                self.profiler_process_stdout,
-                self.profiler_process_stderr,
-            ) = self.profiler_process.communicate()
-            self.logger.error(
-                "Profiler stderr: {}".format(self.profiler_process_stderr)
-            )
-            self.logger.error(
-                "Profiler stdout: {}".format(self.profiler_process_stdout)
-            )
-            return result
-        try:
+        else:
             self.profiler_process.terminate()
             self.profiler_process.wait()
+        try:
             (
                 self.profiler_process_stdout,
                 self.profiler_process_stderr,
@@ -235,6 +239,12 @@ def stop_profile(self, **kwargs):
                     )
                     + LINUX_PERF_SETTINGS_MESSAGE
                 )
+                self.logger.error(
+                    "Profiler stdout: {}".format(self.profiler_process_stdout)
+                )
+                self.logger.error(
+                    "Profiler stderr: {}".format(self.profiler_process_stderr)
+                )
 
         except OSError as e:
             self.logger.error(

redisbench_admin/profilers/perf_daemon_caller.py

@@ -62,7 +62,7 @@ def __init__(self, remote_endpoint, **kwargs):
         if "region_name" in kwargs:
             self.region_name = kwargs["region_name"]
 
-    def start_profile(self, pid, output="", frequency=99):
+    def start_profile(self, pid, output="", frequency=99, call_graph_mode="fp"):
         """
         @param pid: profile events on specified process id
         @param output: output file name
@@ -80,8 +80,8 @@ def start_profile(self, pid, output="", frequency=99):
             "github_org_name": self.github_org_name,
             "github_sha": self.github_sha,
         }
-        url = "http://{}/profiler/perf/start/{}?frequency={}".format(
-            self.remote_endpoint, pid, frequency
+        url = "http://{}/profiler/perf/start/{}?frequency={}&callgraph_mode={}".format(
+            self.remote_endpoint, pid, frequency, call_graph_mode
         )
 
         response = requests.post(url, data=None, json=data)

redisbench_admin/run_remote/run_remote.py

@@ -12,6 +12,7 @@
 import pytablewriter
 from pytablewriter import MarkdownTableWriter
 import redisbench_admin.run.metrics
+from redisbench_admin.profilers.perf import PERF_CALLGRAPH_MODE
 from redisbench_admin.run.metrics import (
     from_info_to_overall_shard_cpu,
     collect_redis_metrics,
@@ -450,7 +451,10 @@ def run_remote_command_logic(args, project_name, project_version):
                                         ]
                                         start_profile_result = (
                                             remote_perf.start_profile(
-                                                primary_one_pid, "", PROFILE_FREQ
+                                                primary_one_pid,
+                                                "",
+                                                PROFILE_FREQ,
+                                                PERF_CALLGRAPH_MODE,
                                             )
                                         )
                                         if start_profile_result is True: