Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noborus/psutilsql

Use the gopsutil library to retrieve information and process it with SQL
https://github.com/noborus/psutilsql

go golang gopsutil sql system-information tbln trdsql

Last synced: 14 days ago
JSON representation

Use the gopsutil library to retrieve information and process it with SQL

Host: GitHub
URL: https://github.com/noborus/psutilsql
Owner: noborus
License: mit
Created: 2019-07-03T06:14:02.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-07-15T11:56:14.000Z (4 months ago)
Last Synced: 2024-10-04T15:38:19.316Z (about 1 month ago)
Topics: go, golang, gopsutil, sql, system-information, tbln, trdsql
Language: Go
Homepage:
Size: 506 KB
Stars: 15
Watchers: 4
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # psutilsql

[![PkgGoDev](https://pkg.go.dev/badge/github.com/noborus/psutilsql)](https://pkg.go.dev/github.com/noborus/psutilsql)

CLI tool that can be processed by SQL using  [gopsutil](https://github.com/shirou/gopsutil) library.

SQL input/output is handled by [trdsql](https://github.com/noborus/trdsql).

Therefore, CSV, JSON, LTSV, MarkDown, Raw, Vertical, and TBLN can be selected as the output format.

![psutilsql.gif](doc/psutilsql.gif)

## install

```console

go get -u github.com/noborus/psutilsql...

```

psutilsql depends on [go-sqlite3](https://github.com/mattn/go-sqlite3).

Therefore, gcc is required to build.

## Usage

```console

psutilsql command

```

### SQL

The query command(\ can be omitted) can execute SQL.

```console

$ psutilsql query "SELECT Total,Used,Free FROM virtualmemory"

or     

$ psutilsql "SELECT Total,Used,Free FROM virtualmemory"       

+-------------+------------+------------+

|    Total    |    Used    |    Free    |

+-------------+------------+------------+

| 16687091712 | 6468083712 | 2399399936 |

+-------------+------------+------------+

```

#### Table list

List of table names that can be used.

Displayed with the following command:

```console

psutilsql table

```

|      name       |

|-----------------|

| cpuinfo         |

| cpupercent      |

| cputime         |

| diskpartition   |

| diskusage       |

| docker          |

| hostinfo        |

| hosttemperature |

| hostuser        |

| loadavg         |

| loadmisc        |

| net             |

| process         |

| processex       |

| swapmemory      |

| virtualmemory   |

### Command

Display values using command and options without using SQL.

```console

$ psutilsql host --users

+---------+----------+------+------------+

|  User   | Terminal | Host |  Started   |

+---------+----------+------+------------+

| noborus | tty7     | :0   | 1564096509 |

+---------+----------+------+------------+

```

```console

$ psutilsql --help

SQL for running processes and system utilization.

SQL can be executed on the information acquired using gopsutil library.

Default SQL is provided, so you can omit SQL if you select a command.

Usage:

  psutilsql [flags]

  psutilsql [command]

Available Commands:

  completion  Generates bash/zsh completion scripts

  cpu         CPU information

  disk        DISK information

  docker      docker information

  help        Help about any command

  host        host information

  load        load information

  mem         memory information

  net         net information

  process     process information

  query       SQL query command

  table       table list

  version     Print the version number of psutilsql

Flags:

  -d, --Delimiter string   output delimiter (CSV only) (default ",")

  -O, --Header             output header (CSV only)

  -o, --OutFormat string   output format=[AT|CSV|LTSV|JSON|JSONL|TBLN|RAW|MD|VF|YAML] (default "AT")

  -q, --Query string       query

  -h, --help               help for psutilsql

  -t, --toggle             Help message for toggle

Use "psutilsql [command] --help" for more information about a command.

```

### cpu

--time: cpu time(default)

| CPU | User | System | Idle | Nice | Iowait | Irq | Softirq | Steal | Guest | GuestNice |

|-----|------|--------|------|------|--------|-----|---------|-------|-------|-----------|

--info, -i: cpu info

| CPU | VendorID | Family | Model | Stepping | PhysicalID | CoreID | Cores | ModelName | Mhz | CacheSize | Flags | Microcode |

|-----|----------|--------|-------|----------|------------|--------|-------|-----------|-----|-----------|-------|-----------|

--percent,-p: cpu percent

### disk

--partition: disk partition(default)

| Device | Mountpoint | Fstype | Opts |

|--------|------------|--------|------|

--usage [disk]: disk usage

| Path | Fstype | Total | Free | Used | UsedPercent | InodesTotal | InodesUsed | InodesFree | InodesUsedPercent |

|------|--------|-------|------|------|-------------|-------------|------------|------------|-------------------|

### docker

| ContainerID | Name | Image | Status | Running |

|-------------|------|-------|--------|---------|

### host

--info: host information(default)

| Hostname | Uptime | BootTime | Procs | OS | Platform | PlatformFamily | PlatformVersion | KernelVersion | VirtualizationSystem | VirtualizationRole | HostID |

|----------|--------|----------|-------|----|----------|----------------|-----------------|---------------|----------------------|--------------------|--------|

--user,-u: user information

| User | Terminal | Host | Started |

|------|----------|------|---------|

--temperatures, -t: SensorsTemperatures

| SensorKey | Temperature |

|-----------|-------------|

### load

| Load1 | Load5 | Load15 |

|-------|-------|--------|

--misc,-m: miscellaneous host-wide statistics

| ProcsTotal | ProcsRunning | ProcsBlocked | Ctxt |

|------------|--------------|--------------|------|

### mem

VirtualMemory(default)

| Total | Available | Used | UsedPercent | Free | Active | Inactive | Wired | Laundry | Buffers | Cached | Writeback | Dirty | WritebackTmp | Shared | Slab | SReclaimable | SUnreclaim | PageTables | SwapCached | CommitLimit | CommittedAS | HighTotal | HighFree | LowTotal | LowFree | SwapTotal | SwapFree | Mapped | VMallocTotal | VMallocUsed | VMallocChunk | HugePagesTotal | HugePagesFree | HugePageSize |

|-------|-----------|------|-------------|------|--------|----------|-------|---------|---------|--------|-----------|-------|--------------|--------|------|--------------|------------|------------|------------|-------------|-------------|-----------|----------|----------|---------|-----------|----------|--------|--------------|-------------|--------------|----------------|---------------|--------------|

--swap, -s: SwapMemory

| Total | Used | Free | UsedPercent | Sin | Sout | PgIn | PgOut | PgFault |

|-------|------|------|-------------|-----|------|------|-------|---------|

### net

| Fd | Family | Type | LaddrIP | LaddrPort | RaddrIP | RaddrPort | status | Uids | Pid |

|----|--------|------|---------|-----------|---------|-----------|--------|------|-----|

### process

| pid | name | CPU | MEM | STATUS | START | USER | RSS | VMS | Data | Stack | locked | Swap | COMMAND |

|-----|------|-----|-----|--------|-------|------|-----|-----|------|-------|--------|------|---------|

--ex: memory info ex

| pid | name | CPU | MEM | STATUS | START | USER | RSS | VMS | Shared | Text | Lib | Data | Dirty | COMMAND |

|-----|------|-----|-----|--------|-------|------|-----|-----|--------|------|-----|------|-------|---------|