Includes improvements related to containerized workflows. (#250)

* Updates * Updates * Updates * Updates * Updates * Updates * Address PR feedback
microsoft · May 28, 2024 · e7ddf08 · e7ddf08
1 parent 03aa1b1
commit e7ddf08
Show file tree

Hide file tree

Showing 41 changed files with 602 additions and 205 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -39,12 +39,6 @@ endif()
 set(PROJECT_VERSION_TWEAK 0)
 file(READ "dist/changelog" CHANGE_LOG)
 
-#
-# enable Debug while pre-release; disable Debug in post-release
-#
-#set(CMAKE_BUILD_TYPE Debug)
-#option(DEBUG_K "Enter debug mode" On)
-
 #
 # package name
 #

diff --git a/INSTALL.md b/INSTALL.md
@@ -5,7 +5,7 @@
 sudo yum install procdump
 ```
 
-## Ubuntu 20.04, 22.04, 23.04
+## Ubuntu 20.04, 22.04, 24.04
 #### 1. Register Microsoft key and feed
 ```sh
 wget -q https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
@@ -48,21 +48,32 @@ sudo apt-get update
 sudo apt-get install procdump
 ```
 
-## Fedora 37
+## Fedora 38
 #### 1. Register Microsoft key and feed
 ```sh
-sudo rpm -Uvh https://packages.microsoft.com/config/fedora/37/packages-microsoft-prod.rpm
+sudo rpm -Uvh https://packages.microsoft.com/config/fedora/38/packages-microsoft-prod.rpm
 ```
 
 #### 2. Install Procdump
 ```sh
 sudo dnf install procdump
 ```
 
-## Fedora 38
+## Fedora 39
 #### 1. Register Microsoft key and feed
 ```sh
-sudo rpm -Uvh https://packages.microsoft.com/config/fedora/38/packages-microsoft-prod.rpm
+sudo rpm -Uvh https://packages.microsoft.com/config/fedora/39/packages-microsoft-prod.rpm
+```
+
+#### 2. Install Procdump
+```sh
+sudo dnf install procdump
+```
+
+## Fedora 40
+#### 1. Register Microsoft key and feed
+```sh
+sudo rpm -Uvh https://packages.microsoft.com/config/fedora/40/packages-microsoft-prod.rpm
 ```
 
 #### 2. Install Procdump

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Capture Usage:
             [-m|-ml Commit_Usage1[,Commit_Usage2...]]
             [-gcm [<GCGeneration>: | LOH: | POH:]Memory_Usage1[,Memory_Usage2...]]
             [-gcgen Generation]
-            [-restrack]
+            [-restrack [nodump]]
             [-sr Sample_Rate]
             [-tc Thread_Threshold]
             [-fc FileDescriptor_Threshold]
@@ -39,7 +39,7 @@ Capture Usage:
             [-mc Custom_Dump_Mask]
             [-pf Polling_Frequency]
             [-o]
-            [-log]
+            [-log syslog|stdout]
             {
              {{[-w] Process_Name | [-pgid] PID} [Dump_File | Dump_Folder]}
             }
@@ -53,7 +53,7 @@ Options:
    -ml     Memory commit threshold(s) (MB) below which to create dumps.
    -gcm    [.NET] GC memory threshold(s) (MB) above which to create dumps for the specified generation or heap (default is total .NET memory usage).
    -gcgen  [.NET] Create dump when the garbage collection of the specified generation starts and finishes.
-   -restrack Enable memory leak tracking (malloc family of APIs).
+   -restrack Enable memory leak tracking (malloc family of APIs). Use the nodump option to prevent dump generation and only produce restrack report(s).
    -sr     Sample rate when using -restrack.
    -tc     Thread count threshold above which to create a dump of the process.
    -fc     File descriptor count threshold above which to create a dump of the process.
@@ -64,7 +64,7 @@ Options:
    -mc     Custom core dump mask (in hex) indicating what memory should be included in the core dump. Please see 'man core' (/proc/[pid]/coredump_filter) for available options.
    -pf     Polling frequency.
    -o      Overwrite existing dump file.
-   -log    Writes extended ProcDump tracing to syslog.
+   -log    Writes extended ProcDump tracing to the specified output stream (syslog or stdout).
    -w      Wait for the specified process to launch if it's not running.
    -pgid   Process ID specified refers to a process group ID.
 ```
@@ -121,6 +121,10 @@ The following will create a core dump and a memory leak report when memory usage
 ```
 sudo procdump -m 100 -restrack 1234
 ```
+The following will create a memory leak report (no dumps) when memory usage is >= 100 MB
+```
+sudo procdump -m 100 -restrack nodump 1234
+```
 The following will create a core dump and a memory leak report when memory usage is >= 100 MB by sampling every 10th memory allocation.
 ```
 sudo procdump -m 100 -restrack -sr 10 1234

diff --git a/dist/changelog b/dist/changelog
@@ -1,3 +1,6 @@
+* Sat May 25 2024 Mario Hewardt <marioh@microsoft.com> - 3.3
+- Adds improvements related to containerized workflows
+
 * Mon Feb 5 2024 Mario Hewardt <marioh@microsoft.com> - 3.2
 - Adds mmap/munmap to resource tracking