summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..113a38e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+##AGL-task-manager
+
+Task Manager service queries the system folder /proc to collect data on
+the processes currently running on the machine. Information such as
+process name, process ID, user, system CPU usage, user CPU usage, resident memory and state.
+
+
+## Verbs
+
+| Name | Description |
+|:-------------------|:------------------------------------------|
+| get_process_list | retrieves the current processes from /proc|
+
+
+## JSON response is an array of process entries each containing the values described below
+
+| Name | Description |
+|:------------|-------------------------------------------------|
+| cmd | name of each process |
+| tid | unique process ID |
+| euid | process user |
+| scpu | % of CPU time used by process in kernel mode |
+| ucpu | % of CPU time used by process in user time |
+| resident_mem| amount of resident memory used |
+| state | state of process |
+