https://github.com/reubenfirmin/lucifer
CLI utility to parse the output from `lsof` and provide smart analysis/reporting.
https://github.com/reubenfirmin/lucifer
linux lsof processes
Last synced: 11 days ago
JSON representation
CLI utility to parse the output from `lsof` and provide smart analysis/reporting.
- Host: GitHub
- URL: https://github.com/reubenfirmin/lucifer
- Owner: reubenfirmin
- License: bsd-2-clause
- Created: 2021-12-18T16:45:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-15T11:40:56.000Z (over 4 years ago)
- Last Synced: 2023-05-13T17:27:27.080Z (about 3 years ago)
- Topics: linux, lsof, processes
- Language: Kotlin
- Homepage:
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# lucifer 0.5
The goal of this tool is to parse **lsof** output, and to provide useful summarization. PRs welcomed.
## reports
It currently provides 3 reports:
### OPEN FILES BY PROCESS
This is a list of all processes (with associated metadata), along with the count of files opened by that process. Note that child processes may have files in common with each other.
The top 5 most common parent PIDs are highlighted so that you can quickly see groups of associated processes.
### OPEN FILES BY TYPE BY USER
A summary of the number of files, by type, by user.
### INTERNET CONNECTIONS BY USER
A list of all UDP and TCP connections, by user. Some columns may be hidden in narrow terminals.
## building
On ubuntu, install `gcc-multilib`.
```
./build.sh
```
## usage examples
Lucifer parses the output of lsof -F. Any other argument provided to lsof may result in the parsing crashing.
```
sudo lsof -F | ./lucifer
OR
sudo lsof -F > detail.txt
cat detail.txt | lucifer
cat detail.txt | lucifer --process 123 --process=5233
```
### optional arguments
```
--err : send input from stdin through to stderr
--noformat : turn off color highlighting
--process={pid} : full report on a specific process (may be repeated, e.g. --process=1 --process=2)
--process={command} : full report on processes matching a particular command (main be repeated, e.g. --process=chrome, --process=firefox)
```
## status
Beta.
## roadmap
* smart coloring
* coloring in network report by common host / open ports
* coloring in open files report by users with most open files?
* smart coloring in the reports to highlight things worth noticing
* color coding for all ranges (generalize logic)
* cohesive error handling (get rid of stderr pipe through of results)
* --parent flag to order by parent / parent tree
* improve table width detection (should be given narrow vs wide rules, maybe can pivot to psql \x style)
* network report improvements
* highlight listening ports
* somehow match colors to user terminal (right now assumes dark background)
* ncurses based UI for browsing different reports / detail view
# kotlin-native
This project is an exploration of kotlin-native, which is basically functional, but has some real warts (listed here)
that don't make it a practical choice for prime time projects yet.
* The biggest that I encountered is that readLine() does not split on newline (0xA); after spending a couple of hours trying to massage the broken output I eventually realized that I could just call C's stdio `fgets` function, which reads a line. Nice.
* Method references (e.g. ::foo) cause the compiler to crash.
* Output binary size is very large. This alone is probably enough reason to port this to Go or Rust once it's useful enough.
* I couldn't get tests to work under Intellij initially. Adding a redundant `jvm{}` target to the build got this working.
* IDE debugger doesn't work with tests, which is a bummer.
* `apply` doesn't work. These should be equivalent, but they're not.
```
split("]").apply { listOf(get(0).substring(1), get(1).substring(1)) }
val res = split("]")
listOf(res[0].substring(1), res[1].substring(1))
```
# FAQ
## What's with the name?
Bad pun. Lucifer = lsof-er.