Mirrored_Repos/ctop
1
0
Fork 0
mirror of https://github.com/bcicen/ctop.git synced 2024-08-30 18:23:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

add debug section to docs

Browse Source
This commit is contained in:
Bradley Cicenas 2017-03-19 05:09:21 +00:00
parent 8aa932b29f
commit 60213f1551
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
_docs/debug.md Normal file
View File

@ -0,0 +1,24 @@
# Debug Mode
`ctop` comes with a built-in logging facility and local socket server to simplify debugging at run time. Debug mode can be enabled via the `CTOP_DEBUG` environment variable:
```bash
CTOP_DEBUG=1 ./ctop
```
While `ctop` is running, you can connect to the logging socket via socat or similar tools:
```bash
socat unix-connect:/tmp/ctop.sock stdio
```
example output:
```
15:06:43.881 ▶ NOTI 002 logger initialized
15:06:43.881 ▶ INFO 003 loaded config param: "filterStr": ""
15:06:43.881 ▶ INFO 004 loaded config param: "sortField": "state"
15:06:43.881 ▶ INFO 005 loaded config switch: "sortReversed": false
15:06:43.881 ▶ INFO 006 loaded config switch: "allContainers": true
15:06:43.881 ▶ INFO 007 loaded config switch: "enableHeader": true
15:06:43.883 ▶ INFO 008 collector started for container: 7120f83ca...
...
```