system-usage-information

πŸ“Š Outputs system usage information on Linux, including processor, memory, swap space, disk, network and graphics processor usage and load average

https://github.com/tdulcet/system-usage-information

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • βœ“
    CITATION.cff file
    Found CITATION.cff file
  • βœ“
    codemeta.json file
    Found codemeta.json file
  • βœ“
    .zenodo.json file
    Found .zenodo.json file
  • β—‹
    DOI references
  • β—‹
    Academic publication links
  • βœ“
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • β—‹
    Institutional organization owner
  • β—‹
    JOSS paper metadata
  • β—‹
    Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

πŸ“Š Outputs system usage information on Linux, including processor, memory, swap space, disk, network and graphics processor usage and load average

Basic Info
  • Host: GitHub
  • Owner: tdulcet
  • License: gpl-3.0
  • Language: Shell
  • Default Branch: master
  • Homepage:
  • Size: 126 KB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 4
  • Open Issues: 0
  • Releases: 0
Created about 6 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

System Usage Information

Linux System Usage Information Script

Copyright Β© 2020 Teal Dulcet

Script to quickly output system usage information on Linux, including:

  • Processor (CPU) usage
    • CPU Sockets/Cores/Threads
    • CPU Thread usage
  • Load average (1, 5, 15 minutes)
  • ‑Pressure Stall (PSI) average (10 seconds, 1, 5 minutes)
    • PSI Some CPU
    • PSI Some RAM
    • PSI Some IO
  • *Temperature(es)
  • Memory (RAM) usage
  • Swap space usage
  • Users logged in (number of)
  • Idle time (last activity)
  • Processes/Threads
  • Disk space usage
  • Disk IO usage (read/write)
  • Network usage (receive/transmit)
  • †Graphics Processor (GPU) usage
    • GPU Memory (RAM) usage
    • GPU Temperature(es)
  • *Battery (percentage charged and status)
  • Uptime
  • Hostname (FQDN)
  • Private IP address(es)
  • ^Public IP address(es)
  • ^Weather

* If present\ ^ Optional\ † Requires Nvidia GPU(s)\ ‑ Requires Linux kernel β‰₯ 4.20

RAM, swap space, disk and network usage is output in both IEC (powers of 1024) and SI (powers of 1000) units, but with more precision then the numfmt command from GNU Coreutils. Uses terminal colors and formatting to output the information to the console. For the colors, green means good, yellow means warning and red means critical.

Requires at least Bash 4+. Compared to similar programs, this script outputs much more information. Useful for displaying a message of the day (motd) upon login on Linux. All the values are saved to variables, which makes this easy to incorporate into larger scripts.

To monitor the status of one or more servers, please see the Remote Servers Status Monitoring script.

❀️ Please visit tealdulcet.com to support this script and my other software development.

Also see the Linux System Information script.

Usage

Supports all modern Linux distributions from the last 10+ years and the Windows Subsystem for Linux (WSL).

See Help below for full usage information.

wget

bash wget -qO - https://raw.github.com/tdulcet/System-Usage-Information/master/usage.sh | bash -s --

curl

bash curl -sL https://raw.github.com/tdulcet/System-Usage-Information/master/usage.sh | bash -s --

Message of the day (motd)

  1. Download the script (usage.sh). Run: wget https://raw.github.com/tdulcet/System-Usage-Information/master/usage.sh.
  2. There are some variables at the top of the script users can set to change the output, including the thresholds for the colors.
  3. Install the script. Run: sudo mv usage.sh /usr/local/bin/usage and sudo chmod +x /usr/local/bin/usage.
  4. Create a new script in the /etc/update-motd.d/ directory that runs Linux System Usage Information script, for example called 50-sys-usage-info: ```bash #!/bin/sh

usage -sw `` 5. Execute the new script once to make sure there are no errors. For example, run:sudo chmod +x /etc/update-motd.d/50-sys-usage-infoand/etc/update-motd.d/50-sys-usage-info`.

See here for more information.

Help

``` $ usage -h Usage: usage [OPTION(S)]...

Options: -p Show Public IP addresses and hostnames Requires internet connection. -w Show current Weather Requires internet connection. -s Shorten output Do not show CPU Thread usage and PSI averages. Useful for displaying a message of the day (motd). -u Use Unicode usage bars -n No color

-h              Display this help and exit
-v              Output version information and exit

Examples: Output everything $ usage -pw

```

It respects the NO_COLOR and FORCE_COLOR environment variables.

Contributing

Pull requests welcome! Ideas for contributions:

  • Add more system usage information
    • Show Wi-Fi signal quality without using the deprecated Wireless tools or /proc/net/wireless file.
    • Show total Disk IO and Network usage.
    • Show power/energy usage.
  • Add more examples
  • Improve the performance
  • Support more GPUs
  • Port to C/C++ or Rust

Owner

  • Name: Teal Dulcet
  • Login: tdulcet
  • Kind: user
  • Location: Portland, Oregon

πŸ‘¨β€πŸ’» Computer Scientist, BS, CRTGR, MS @Thunderbird Council member

Citation (CITATION.cff)

cff-version: 1.2.0
title: Linux System Usage Information Script
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Teal
    family-names: Dulcet
    orcid: 'https://orcid.org/0009-0008-6616-2631'
repository-code: 'https://github.com/tdulcet/System-Usage-Information'
abstract: >-
  Outputs system usage information on Linux, including:
  processor usage, load average, pressure stall average,
  temperatures, memory and swap space usage, idle time,
  processes/threads, disk space and IO usage, network usage,
  graphics processor usage, battery and uptime.
license: GPL-3.0
version: '1.0'

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 11
  • Total Committers: 1
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Teal Dulcet t****t@p****u 11
Committer Domains (Top 20 + Academic)
pdx.edu: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 2
  • Total pull requests: 0
  • Average time to close issues: 2 days
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 3.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Cyber5imon (1)
  • turbopixel (1)
Pull Request Authors
Top Labels
Issue Labels
bug (1) question (1)
Pull Request Labels