Export individual processes stats nicolargo#794

Author: nicolargo

Diff for: conf/glances.conf

@@ -357,6 +357,10 @@ nice_warning=-20,-19,-18,-17,-16,-15,-14,-13,-12,-11,-10,-9,-8,-7,-6,-5,-4,-3,-2
 #nice_careful=1,2,3,4,5,6,7,8,9
 #nice_warning=10,11,12,13,14
 #nice_critical=15,16,17,18,19
+#
+# Define the list of processes to export using:
+# a comma-separated list of Glances filter
+#export=.*firefox.*,pid:1234
 
 [ports]
 disable=False

Diff for: docker-compose/glances.conf

@@ -357,6 +357,12 @@ nice_warning=-20,-19,-18,-17,-16,-15,-14,-13,-12,-11,-10,-9,-8,-7,-6,-5,-4,-3,-2
 #nice_careful=1,2,3,4,5,6,7,8,9
 #nice_warning=10,11,12,13,14
 #nice_critical=15,16,17,18,19
+#
+# Define the list of processes to export using:
+# a comma-separated list of regular expression (apply on name and cmdline)
+#export=.*firefox.*
+# or an uniq key:value filter
+#export=pid:1234
 
 [ports]
 disable=False

Diff for: docs/aoa/ps.rst

@@ -199,4 +199,67 @@ Accumulated per program — key 'j'
 When activated ('j' hotkey or --programs option in the command line), processes are merged
 to display which programs are active. The columns show the accumulated cpu consumption, the
 accumulated virtual and resident memory consumption, the accumulated transferred data I/O.
-The PID columns is replaced by a NPROCS column which is the number of processes.
+The PID columns is replaced by a NPROCS column which is the number of processes.
+
+Export process
+--------------
+
+Glances version 4 introduces a new feature to export specifics processes. In order to use this
+feature, you need to use the export option in the processlist section of the Glances configuration
+file or the --export-process-filter option in the command line.
+
+The export option is a list of Glances filters.
+
+Example number one, export all processes named 'python' (or with a command line containing 'python'):
+
+.. code-block:: ini
+
+    [processlist]
+    export=.*python.*
+
+Note: or the --export-process-filter ".*python.*" option in the command line.
+
+Example number two, export all processes with the name 'python' or 'bash':
+
+.. code-block:: ini
+
+    [processlist]
+    export=.*python.*,.*bash.*
+
+Note: or the --export-process-filter ".*python.*,.*bash.*" option in the command line.
+
+Example number three, export all processes belong to 'nicolargo' user:
+
+.. code-block:: ini
+
+    [processlist]
+    export=username:nicolargo
+
+Note: or the --export-process-filter "username:nicolargo" option in the command line.
+
+The output of the export use the PID as the key (for example if you want to export firefox process
+to a CSV file):
+
+Configuration file (glances.conf):
+
+.. code-block:: ini
+
+    [processlist]
+    export=.*firefox.*
+
+Note: or the --export-process-filter ".*firefox.*" option in the command line.
+
+Command line example:
+
+.. code-block:: bash
+
+    glances -C ./conf/glances.conf --export csv --export-csv-file /tmp/glances.csv --disable-plugin all --enable-plugin processlist --quiet
+
+the result will be:
+
+.. code-block:: csv
+
+    timestamp,845992.memory_percent,845992.status,845992.num_threads,845992.cpu_timesuser,845992.cpu_timessystem,845992.cpu_timeschildren_user,845992.cpu_timeschildren_system,845992.cpu_timesiowait,845992.memory_inforss,845992.memory_infovms,845992.memory_infoshared,845992.memory_infotext,845992.memory_infolib,845992.memory_infodata,845992.memory_infodirty,845992.name,845992.io_counters,845992.nice,845992.cpu_percent,845992.pid,845992.gidsreal,845992.gidseffective,845992.gidssaved,845992.key,845992.time_since_update,845992.cmdline,845992.username,total,running,sleeping,thread,pid_max
+    2024-04-03 18:39:55,3.692938041968513,S,138,1702.88,567.89,1752.79,244.18,0.0,288919552,12871561216,95182848,856064,0,984535040,0,firefox,1863281664,0,0.5,845992,1000,1000,1000,pid,2.2084147930145264,/snap/firefox/3836/usr/lib/firefox/firefox,nicolargo,403,1,333,1511,0
+    2024-04-03 18:39:57,3.692938041968513,S,138,1702.88,567.89,1752.79,244.18,0.0,288919552,12871561216,95182848,856064,0,984535040,0,firefox,1863281664,0,0.5,845992,1000,1000,1000,pid,2.2084147930145264,/snap/firefox/3836/usr/lib/firefox/firefox,nicolargo,403,1,333,1511,0
+