refactored and kept some debug-toolkit utils

Author: Avi-Robusta

build_on_apple_m1.sh

@@ -0,0 +1,5 @@
+docker buildx build \
+  --platform linux/amd64 \
+  --tag $IMAGE \
+  --push \
+  $BUILD_CONTEXT

cloudbuild.yaml

@@ -1,6 +1,6 @@
 steps:
 - name: 'gcr.io/cloud-builders/docker'
-  args: ['build', '-t', 'gcr.io/genuine-flight-317411/java-toolkit-aux/jtk-11', '.']
+  args: ['build', '-t', 'gcr.io/genuine-flight-317411/java-toolkit/jtk-11', '.']
 - name: 'gcr.io/cloud-builders/docker'
-  args: ['push', 'gcr.io/genuine-flight-317411/java-toolkit-aux/jtk-11']
-images: ['gcr.io/genuine-flight-317411/java-toolkit-aux/jtk-11']
+  args: ['push', 'gcr.io/genuine-flight-317411/java-toolkit/jtk-11']
+images: ['gcr.io/genuine-flight-317411/java-toolkit/jtk-11']

configs.json

@@ -24,7 +24,7 @@ spec:
             type: Directory
       containers:
         - name: java-tk-11
-          image: gcr.io/genuine-flight-317411/java-toolkit-aux/jtk-11
+          image: gcr.io/genuine-flight-317411/java-toolkit/jtk-11
           imagePullPolicy: Always
           volumeMounts:
             - name: host-disk

debugger-pod.yaml

@@ -1,12 +1,21 @@
 FROM adoptopenjdk/openjdk11-openj9:jdk-11.0.13_8_openj9-0.29.0-debian
+RUN mkdir /app
+RUN cp -R /opt/java/openjdk /app
+
+FROM python:3.8-slim-buster
 
 RUN apt-get update \
   && apt-get install -y --no-install-recommends procps gdb git curl inotify-tools \
   && apt-get purge -y --auto-remove \
   && rm -rf /var/lib/apt/lists/*
 
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python -
+RUN /root/.local/bin/poetry config virtualenvs.create false
+COPY poetry.lock pyproject.toml /app/
 WORKDIR /app/
-COPY ../../src /app/src
-CMD exec /bin/bash -c "trap : TERM INT; sleep infinity & wait"
+RUN /root/.local/bin/poetry install --no-interaction --no-root
+
+COPY src /app/src
+RUN /root/.local/bin/poetry install
 
 #run on jenkens

dockerfile

@@ -1,11 +1,20 @@
 [tool.poetry]
-name = "java-toolkit"
+name = "java_toolkit"
 version = "0.1.0"
 description = ""
 authors = ["Avi <[email protected]>"]
+packages = [
+    { include = "java_toolkit", from = "src" },
+]
+
+[tool.poetry.scripts]
+java-toolkit = "java_toolkit.main:app"
 
 [tool.poetry.dependencies]
 python = "^3.8"
+typer = "^0.4.0"
+psutil = "^5.9.0"
+pydantic = "^1.9.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"

poetry.lock

@@ -1 +0,0 @@
-__version__ = '0.1.0'

pyproject.toml

@@ -0,0 +1,11 @@
+{
+  "JDK_PATH": "/app/openjdk",
+  "MKDIR_POD_CMD": "mkdir {DST_MOUNT_PATH}",
+  "RMDIR_POD_CMD": "rm -R {DST_MOUNT_PATH}",
+  "DST_MOUNT_PATH": "/proc/{PID}/cwd/mnt/robusta",
+  "COPY_CMD": "cp -R {JDK_PATH} {DST_MOUNT_PATH}",
+  "JDK_NAME": "openjdk",
+  "JMAP_CMD": "{JDK_PATH}/bin/jmap -J-Xshareclasses:nonfatal -histo {LOCAL_PID}",
+  "JSTACK_CMD": "{JDK_PATH}/bin/jstack -J-Xshareclasses:nonfatal -l {LOCAL_PID}",
+  "NSENTER_CMD": "nsenter -t {PID} -p -m {CMD}"
+}

src/java_toolkit/__init__.py

@@ -0,0 +1,71 @@
+#!/usr/local/bin/python3
+import subprocess
+import typer
+from .utils.pod_ps import get_pod_processes
+import json
+from os.path import join
+
+app = typer.Typer()
+app_configs = {}
+
+
+class JDKMounter:
+    mnt_path =""
+    verbose = False
+
+    def __init__(self, pid: str, verbose: bool):
+        self.verbose = verbose
+        self.mnt_path = app_configs['DST_MOUNT_PATH'].format(PID=pid)
+        mkdir_cmd = app_configs['MKDIR_POD_CMD'].format(self.mnt_path)
+        run_command(mkdir_cmd, verbose)
+
+    def get_mounted_jdk_dir(self):
+            return join(self.mnt_path, app_configs['JDK_NAME'] )
+
+    def __del__(self):
+        rm_dir_cmd = app_configs['RMDIR_POD_CMD'].format(self.mnt_path)
+        run_command(rm_dir_cmd, self.verbose)
+
+def run_cmd_in_proc_namespace(pid, command_to_run, verbose):
+    nsenter_cmd_formatted = app_configs['NSENTER_CMD'].format(pid, command_to_run)
+    run_command(nsenter_cmd_formatted, verbose)
+
+def run_command(cmd: str, verbose: bool):
+    if verbose:
+        typer.echo(f"running {cmd}")
+    output = subprocess.check_output(
+        cmd, shell=True, stdin=subprocess.PIPE, stderr=subprocess.STDOUT
+    )
+    if verbose:
+        typer.echo(output.decode())
+
+def get_java_toolkit_configs():
+    with open ('configs.json', "r") as json_file:
+        return json.loads(json_file.read())
+
+@app.command()
+def pod_ps(pod_uid: str):
+    typer.echo(get_pod_processes(pod_uid).json())
+
+@app.command()
+def find_pid(pod_uid: str, cmdline: str, exe: str):
+    for proc in get_pod_processes(pod_uid).processes:
+        if cmdline in " ".join(proc.cmdline) and exe in proc.exe:
+            typer.echo(proc.pid)
+
+@app.command()
+def jmap(pid: int, verbose: bool = False):
+    with JDKMounter(pid, verbose) as jdk_mounter:
+        jstack_cmd = app_configs['JMAP_CMD'].format(JDK_PATH=jdk_mounter.get_mounted_jdk_dir(), LOCAL_PID=1)
+        run_cmd_in_proc_namespace(pid, jstack_cmd, verbose)
+
+
+@app.command()
+def jstack(pid: int, verbose: bool = False):
+    with JDKMounter(pid, verbose) as jdk_mounter:
+        jstack_cmd = app_configs['JSTACK_CMD'].format(JDK_PATH=jdk_mounter.get_mounted_jdk_dir(), LOCAL_PID=1)
+        run_cmd_in_proc_namespace(pid, jstack_cmd, verbose)
+
+if __name__ == "__main__":
+    app_configs = get_java_toolkit_configs()
+    app()

src/java_toolkit/configs.json

@@ -0,0 +1,63 @@
+#!/usr/local/bin/python3
+import re
+from typing import List
+
+import psutil
+import typer
+from pydantic import BaseModel
+
+kube_regex = re.compile(r"\d+:.+:/kubepods/[^/]+/pod([^/]+)/([0-9a-f]{64})")
+docker_regex = re.compile(r"\d+:.+:/docker/pod([^/]+)/([0-9a-f]{64})")
+other_regex = re.compile(r"\d+:.+:/docker/.*/pod([^/]+)/([0-9a-f]{64})")
+other_regex2 = re.compile(r"\d+:.+:/kubepods/.*/pod([^/]+)/([0-9a-f]{64})")
+other_regex3 = re.compile(
+    r"\d+:.+:/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice/docker-([0-9a-f]{64})"
+)
+
+app = typer.Typer()
+
+
+# TODO: split to pod and python subcommands
+
+
+class Process(BaseModel):
+    pid: int
+    exe: str
+    cmdline: List[str]
+
+
+class ProcessList(BaseModel):
+    processes: List[Process]
+
+
+def get_process_details(pid: int):
+    # see https://man7.org/linux/man-pages/man7/cgroups.7.html
+    try:
+        path = "/proc/%d/cgroup" % (pid,)
+        with open(path, "r") as f:
+            lines = f.readlines()
+            for line in lines:
+                match = (
+                        kube_regex.match(line)
+                        or docker_regex.match(line)
+                        or other_regex.match(line)
+                        or other_regex2.match(line)
+                        or other_regex3.match(line)
+                )
+                if match is not None:
+                    # pod, container
+                    return match.group(1).replace("_", "-"), match.group(2)
+    except Exception as e:
+        print("exception:", e)
+    return None, None
+
+
+def get_pod_processes(pod_uid: str) -> ProcessList:
+    processes = []
+    for pid in psutil.pids():
+        this_pod_uid, container_uid = get_process_details(pid)
+        if this_pod_uid is not None and this_pod_uid.lower() == pod_uid.lower():
+            proc = psutil.Process(pid)
+            processes.append(Process(pid=pid, exe=proc.exe(), cmdline=proc.cmdline()))
+    return ProcessList(processes=processes)
+