Arav/httpprocprobed
1
0
Fork 0
Code Releases 6 Activity

Updated README.

Browse Source
This commit is contained in:
Alexander Andreev 2022-01-02 21:56:53 +04:00
parent 2e81cf3950
commit e1b8fbf280
Signed by: Arav
GPG Key ID: 1327FE8A374CC86F
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,17 +1,22 @@
# httpprocwatchd Ver 1.3 # httpprocwatchd Ver 1.3.2
License: MIT+NIGGER. License: MIT+NIGGER.
This utility provides a HTTP `/processes` GET endpoint that returns a list of This utility provides a HTTP `/processes` GET endpoint that returns a list of
processes and if they are currently running or not. processes, and if they are currently running or not.
A list of processes could be in JSON or XML format, By default JSON being returned. There are currently three output formats available: JSON, XML, plain text.
To get XML you need to provide a `Accept: application/xml` header in GET reqest.
A JSON object looks like this: `{ "process": true|false, ... }`. JSON is a default format if `Accept` header didn't provided, or did do with
value `application/json`. Its form is `{"process":true|false, ...}`.
And XML `<ProcessList><Process name="process">true|false</Process>...</ProcessList>`. XML is provided if `Accept: application/xml` header was given. Its form is
`<ProcessList><Process name="process">true|false</Process>...</ProcessList>`.
Plain text is provided if `Accept: text/plain` header was given. Its form is a
comma separated list of ONLY running process' names.
Configuration file is a simple JSON object consisting of `listen_address` string field Configuration file is a simple key = value storage consisting of `listen_address` string
in form `"[<ip|host>]:<port>"`. And `processes` array of process names. field in form `"[<ip|host>]:<port>"`. `indented_output` bool in form `true|false`, to
enable indentation of JSON and XML output. And `processes` is a space separated array
of process names.