Revert "Feature/stacks container name (#35)" for now, will merge back when backend is ready for it (#64)

Author: Alon Ben Tamar

.flake8

@@ -2,4 +2,3 @@
 max-line-length = 120
 # options for compatibility with black - see https://black.readthedocs.io/en/stable/compatible_configs.html#flake8
 extend-ignore = E203, W503
-exclude = .git,__pycache__,build,gprofiler.egg-info,venv

README.md

@@ -61,8 +61,7 @@ docker pull granulate/gprofiler:latest
 docker run --name gprofiler -d --restart=always \
     --network=host --pid=host --userns=host --privileged \
     -v /lib/modules:/lib/modules:ro -v /usr/src:/usr/src:ro \
-    -v /var/run/docker.sock:/var/run/docker.sock \
-	granulate/gprofiler:latest -cu --token <token> --service-name <service> [options]
+    granulate/gprofiler:latest -cu --token <token> --service-name <service> [options]
 ```
 
 For profiling with eBPF, kernel headers must be accessible from within the container at

deploy/k8s/gprofiler.yaml

@@ -26,9 +26,6 @@ spec:
         - name: usr-src
           hostPath:
             path: /usr/src
-        - name: docker-sock # Allow containers to fetch the names
-            hostPath:
-              path: /var/run/docker.sock
       hostPID: true
       securityContext:
         runAsUser: 0
@@ -54,8 +51,6 @@ spec:
             - name: usr-src
               mountPath: /usr/src
               readOnly: true
-            - name: docker-sock
-                mountPath: /var/run/docker.sock
           args:
             - -cu
             - --token

dev-requirements.txt

@@ -3,5 +3,6 @@ flake8
 black
 mypy
 isort
+docker
 pyinstaller==4.0
 staticx

gprofiler/__main__.py

@@ -2,7 +2,7 @@
 # Copyright (c) Granulate. All rights reserved.
 # Licensed under the AGPL3 License. See LICENSE.md in the project root for license information.
 #
-from gprofiler.main import main
+from .main import main
 
 if __name__ == "__main__":
     main()

gprofiler/client.py

@@ -12,7 +12,7 @@
 import requests
 from requests import Session
 
-from gprofiler.utils import get_iso8061_format_time
+from .utils import get_iso8061_format_time
 
 logger = logging.getLogger(__name__)
 
@@ -48,18 +48,11 @@ def _init_session(self, key: str, service: str):
         # Raises on failure
         self.get_health()
 
-    def get_base_url(self, api_version: str = None) -> str:
-        version = api_version if api_version is not None else self._version
-        return "{}/{}/{}".format(self._host.rstrip("/"), self.BASE_PATH, version)
+    def get_base_url(self) -> str:
+        return "{}/{}/{}".format(self._host.rstrip("/"), self.BASE_PATH, self._version)
 
     def _send_request(
-        self,
-        method: str,
-        path: str,
-        data: Dict,
-        files: Dict = None,
-        timeout: float = DEFAULT_REQUEST_TIMEOUT,
-        api_version: str = None,
+        self, method: str, path: str, data: Dict, files: Dict = None, timeout: float = DEFAULT_REQUEST_TIMEOUT
     ) -> Dict:
         opts: dict = {"headers": {}, "files": files, "timeout": timeout}
 
@@ -73,7 +66,7 @@ def _send_request(
                 json.dump(data, gzip_file, ensure_ascii=False)  # type: ignore
             opts["data"] = buffer.getvalue()
 
-        resp = self._session.request(method, "{}/{}".format(self.get_base_url(api_version), path), **opts)
+        resp = self._session.request(method, "{}/{}".format(self.get_base_url(), path), **opts)
         if 400 <= resp.status_code < 500:
             try:
                 data = resp.json()
@@ -114,5 +107,4 @@ def submit_profile(
                 "profile": profile,
             },
             timeout=self._upload_timeout,
-            api_version="v2",
         )

gprofiler/docker_client.py

@@ -14,10 +14,10 @@
 import psutil
 from psutil import Process
 
-from gprofiler.exceptions import StopEventSetException
-from gprofiler.merge import parse_one_collapsed
-from gprofiler.profiler_base import ProfilerBase
-from gprofiler.utils import (
+from .exceptions import StopEventSetException
+from .merge import parse_one_collapsed
+from .profiler_base import ProfilerBase
+from .utils import (
     TEMPORARY_STORAGE_PATH,
     is_same_ns,
     pgrep_exe,

gprofiler/java.py

@@ -20,14 +20,13 @@
 import configargparse
 from requests import RequestException, Timeout
 
-from gprofiler import __version__, merge
-from gprofiler.client import DEFAULT_UPLOAD_TIMEOUT, GRANULATE_SERVER_HOST, APIClient, APIError
-from gprofiler.docker_client import DockerClient
-from gprofiler.java import JavaProfiler
-from gprofiler.perf import SystemProfiler
-from gprofiler.profiler_base import NoopProfiler
-from gprofiler.python import get_python_profiler
-from gprofiler.utils import (
+from . import __version__, merge
+from .client import DEFAULT_UPLOAD_TIMEOUT, GRANULATE_SERVER_HOST, APIClient, APIError
+from .java import JavaProfiler
+from .perf import SystemProfiler
+from .profiler_base import NoopProfiler
+from .python import get_python_profiler
+from .utils import (
     TEMPORARY_STORAGE_PATH,
     TemporaryDirectoryWithMode,
     atomically_symlink,
@@ -77,7 +76,6 @@ def __init__(
         rotating_output: bool,
         runtimes: Dict[str, bool],
         client: APIClient,
-        include_container_names=True,
     ):
         self._frequency = frequency
         self._duration = duration
@@ -103,8 +101,6 @@ def __init__(
             self._frequency, self._duration, self._stop_event, self._temp_storage_dir.name
         )
         self.initialize_python_profiler()
-        self._docker_client = DockerClient()
-        self._include_container_names = include_container_names
 
     def __enter__(self):
         self.start()
@@ -149,7 +145,6 @@ def _generate_output_files(
         base_filename = os.path.join(self._output_dir, "profile_{}".format(end_ts))
 
         collapsed_path = base_filename + ".col"
-        collapsed_data = self._strip_container_data(collapsed_data)
         Path(collapsed_path).write_text(collapsed_data)
 
         # point last_profile.col at the new file; and possibly, delete the previous one.
@@ -177,15 +172,6 @@ def _generate_output_files(
 
             logger.info(f"Saved flamegraph to {flamegraph_path}")
 
-    @staticmethod
-    def _strip_container_data(collapsed_data):
-        lines = []
-        for line in collapsed_data.splitlines():
-            if line.startswith("#"):
-                continue
-            lines.append(line[line.find(';') + 1 :])
-        return '\n'.join(lines)
-
     def start(self):
         self._stop_event.clear()
 
@@ -227,9 +213,7 @@ def _snapshot(self):
                 logger.exception(f"{future.name} profiling failed")
 
         local_end_time = local_start_time + datetime.timedelta(seconds=(time.monotonic() - monotonic_start_time))
-        merged_result = merge.merge_perfs(
-            system_future.result(), process_perfs, self._docker_client, self._include_container_names
-        )
+        merged_result = merge.merge_perfs(system_future.result(), process_perfs)
 
         if self._output_dir:
             self._generate_output_files(merged_result, local_start_time, local_end_time)
@@ -373,13 +357,6 @@ def parse_cmd_args():
         dest="log_rotate_backup_count",
         default=DEFAULT_LOG_BACKUP_COUNT,
     )
-    parser.add_argument(
-        "--disable-container-names",
-        action="store_true",
-        dest="disable_container_names",
-        default=False,
-        help="gProfiler won't gather the container names of processes that run in containers",
-    )
 
     continuous_command_parser = parser.add_argument_group("continuous")
     continuous_command_parser.add_argument(
@@ -482,14 +459,7 @@ def main():
 
         runtimes = {"java": args.java, "python": args.python}
         gprofiler = GProfiler(
-            args.frequency,
-            args.duration,
-            args.output_dir,
-            args.flamegraph,
-            args.rotating_output,
-            runtimes,
-            client,
-            not args.disable_container_names,
+            args.frequency, args.duration, args.output_dir, args.flamegraph, args.rotating_output, runtimes, client
         )
         logger.info("gProfiler initialized and ready to start profiling")
 

gprofiler/main.py

@@ -2,15 +2,11 @@
 # Copyright (c) Granulate. All rights reserved.
 # Licensed under the AGPL3 License. See LICENSE.md in the project root for license information.
 #
-import json
 import logging
 import re
-import socket
 from collections import Counter, defaultdict
 from typing import Iterable, Mapping, MutableMapping
 
-from gprofiler.docker_client import DockerClient
-
 logger = logging.getLogger(__name__)
 
 SAMPLE_REGEX = re.compile(
@@ -67,7 +63,7 @@ def parse_many_collapsed(text: str) -> Mapping[int, Mapping[str, int]]:
     return results
 
 
-def collapse_stack(comm: str, stack: str) -> str:
+def collapse_stack(stack: str, comm: str) -> str:
     """
     Collapse a single stack from "perf".
     """
@@ -101,12 +97,7 @@ def parse_perf_script(script: str):
             logger.exception(f"Error processing sample: {sample}")
 
 
-def merge_perfs(
-    perf_all: Iterable[Mapping[str, str]],
-    process_perfs: Mapping[int, Mapping[str, int]],
-    docker_client: DockerClient,
-    should_determine_container_names: bool,
-) -> str:
+def merge_perfs(perf_all: Iterable[Mapping[str, str]], process_perfs: Mapping[int, Mapping[str, int]]) -> str:
     per_process_samples: MutableMapping[int, int] = Counter()
     new_samples: MutableMapping[str, int] = Counter()
     process_names = {}
@@ -117,10 +108,7 @@ def merge_perfs(
                 per_process_samples[pid] += 1
                 process_names[pid] = parsed["comm"]
             elif parsed["stack"] is not None:
-                container_name = _get_container_name(pid, docker_client, should_determine_container_names)
-                collapsed_stack = collapse_stack(parsed["comm"], parsed["stack"])
-                stack_line = f'{container_name};{collapsed_stack}'
-                new_samples[stack_line] += 1
+                new_samples[collapse_stack(parsed["stack"], parsed["comm"])] += 1
         except Exception:
             logger.exception(f"Error processing sample: {parsed}")
 
@@ -130,20 +118,7 @@ def merge_perfs(
         if process_perf_count > 0:
             ratio = perf_all_count / process_perf_count
             for stack, count in process_stacks.items():
-                container_name = _get_container_name(pid, docker_client, should_determine_container_names)
-                stack_line = ";".join([container_name, process_names[pid], stack])
-                new_samples[stack_line] += round(count * ratio)
-    container_names = docker_client.container_names
-    docker_client.reset_cache()
-    profile_metadata = {
-        'containers': container_names,
-        'hostname': socket.gethostname(),
-        'container_names_enabled': should_determine_container_names,
-    }
-    output = [f"#{json.dumps(profile_metadata)}"]
-    output += [f"{stack} {count}" for stack, count in new_samples.items()]
-    return "\n".join(output)
-
-
-def _get_container_name(pid: int, docker_client: DockerClient, should_determine_container_names: bool):
-    return docker_client.get_container_name(pid) if should_determine_container_names else ""
+                full_stack = ";".join([process_names[pid], stack])
+                new_samples[full_stack] += round(count * ratio)
+
+    return "\n".join((f"{stack} {count}" for stack, count in new_samples.items()))