Peek

Take a peek at your server's usage statistics.

What is Peek?

Peek is a simple and insanely fast utility tool designed for Linux servers that allows quick monitoring of server usage statistics.

This application is designed to be used on a linux server, however it may also be used on a (Linux-based) personal computer.

Features (stats are accurate for Fedora Linux on Peek version 0.8.4-beta)

• Insanely fast (approximately 4.5ms per request for every stat enabled.)
• Crazy small (Only 7.3MB for the config folder (without a log file) and 11.6MB for the executable)
• Simple to use
• Easy to configure (It's just a yaml file in your config directory)

Installation

To install Peek, you will need to have Go installed on your system. If you do not have Go installed, you can download it from here (https://golang.org/dl).

Once installed, if you are reading this on GitHub, please look to the right of your screen and look at the name of the latest release. If you are not reading this on GitHub, please go to the releases page and copy the name of the latest release. If you are confused, please see the below image:

In the case of the above image, the latest release is titled "v0.8.8-alpha". When you have this, you can run the following commands to install Peek. Replace "RELEASE_NAME" with the name of the latest release.

git clone --branch RELEASE_NAME https://github.com/fwuffyboi/peek.git # Clone the repo
cd peek/src                                     # Go into the necessary directories
go build -o peek .                              # Build the application, (should only take a minute at most)
sudo chmod +x peek                              # Make sure that the file is executable
sudo mv peek /usr/local/bin/peek                # Move the file to /usr/local/bin, for local user installation
cd ../..                                        # Leave both directories
sudo rm -rf peek                                # Delete the now-unnecessary repo

Then just run the command peek in your terminal to start. You can now access the server at its default port of http://0.0.0.0:42649.

How to configure

To configure Peek, you must first run the application after moving it to /usr/local/bin/peek. This will create a default configuration in /home/{YOUR_USERNAME}/.config/peek called peek.config.yaml. It is recommended to stop the Peek application before editing this, as that can lead to unsaved changes. Once edited, start Peek again and it will load your new configuration. If there is an issue with it not working, please feel free to create a GitHub issue.

Log file

The name of the log file in the Peek configuration file is what the log file will be called. The log file's location will remain in /home/YOUR_USERNAME/.config/peek/. This only changes the file's name. Nothing else. The default log file value is "peek.log".

Logging level

Peek allows you to choose what level of logging you would prefer. The default is INFO, this shows most information that users would care about, and is very helpful if something goes wrong. This is the recommended option.

There are also the other options: WARN, ERR and FATA.

WARN only shows warnings in the program, and isn't very helpful. ERR only shows errors, and FATA only shows what caused a program to stop running. It is highly recommended to stick to the default. As this shows information that is critically helpful during debugging.

How to uninstall

Run these commands after stopping the Peek application:

sudo rm -rf /usr/local/bin/peek

# Only if you would like to delete the config directory too
# The config directory stores the configuration file, log file and the IP to country database
sudo rm -rf /home/{YOUR_USERNAME}/.config/peek

Screenshots (From v0.10.0-alpha)

Some screenshots of the API in action.

Since the last update, the API has been completely rewritten to be more user-friendly and easier to understand. A basic authentication system has also been put into place.

URL: /api/v1/stats/all

The above screenshot shows what this endpoint responds with, under authenticated users. Below is what unauthenticated users would see.

When I request the /api/v1/stats/all/ endpoint from my cell phone, Peek on my server reports a varying response time of between 4ms to 6.5ms

Peek has a new endpoint that allows you to see "alerts" for your installation. Currently, alerts only consist of update reminders. This is a screenshot of the alerts endpoint.

Recently, the API has been updated to allow the use of a built-in rate limiter. As well as a swagger UI for the API.

URL: /swagger/index.html

The rate limiter is, by default, set to 5 requests per second, but this is easily customizable in the config file. This is the response when the rate limit is exceeded.

URL: Any! (Except swagger/*)

Credits/Contributors

• fwuffyboi(Эшли Карамель) - Creator, Documentation, API
• db-ip.com - IP-to-country geolocation database

API TODO for V1:

• Streamline the installation process to a single command.
• Add support for a yaml config
• Be able to get the server's country from the IP
• Allow viewing every disk's usage
• Allow seeing RAID array information (cached, done every half-hour at most) (?might be removed?)
• Allow seeing the logs of Peek to a basic level
• Allow (at least) seeing the config from api
• Seeing the live system time and timezone
• Ram usage
• Swap usage
• RAM information (speed in MHz, idk what else)
• User friendly uptime
• User unfriendly uptime
• See hostname
• Be able to shut down server
• Custom rate limit to all API endpoints
• Be able to stop Peek
• CPU usage
• CPU temperature
• CPU information
• System information (What should this include?)
• Alerts endpoint (Info like new updates, etc.) (Improved.)
• Be able to see if updates are available for peek
• Be able to see if your os has updates available (support debian and fedora first)
• IP whitelist and blacklist for API endpoint access

TODO (Not in order of importance):

• Migrate logger to use a database file, which would allow for finer control over the logs

• Add screenshots to README

• Add authentication on API

• Add support for a yaml config

• Be able to get the server's country from the IP

• Allow viewing disk storage

• Allow seeing RAID array information

• Ram usage

• CPU usage

• User friendly uptime

• User unfriendly uptime

• See hostname

• Be able to shut down server

• Custom rate limit to all API endpoints

• Be able to stop Peek - Note: Kinda works. It shuts down but does not tell the client. It just closes connection on them.

• CPU temperature

• GPU temperature

• GPU Usage

• Auto-updating option

• Allow selecting specific flag type (twitter, equal height, equal width, etc.)

• Make the API easier to parse

• System time and timezone

• Change where the config is stored

• Add a fallback if ipinfo.io doesn't work

• Create a better way to get the server's IP

• See open sessions (ssh, etc.) and who/where they are from

• Be able to log in and run commands as a certain system user

• Email if a certain stat gets to certain level

• Telegram bot integration for alerts

• Be able to see if a certain port on the local network is responsive (ping)

• Be able to see the logs of Peek

• Improve viewing the logs of Peek

• Be able to see the config from api

• Be able to edit the config from the api

• Be able to upload a config to the api

• Be able to see the logs of systemd processes

• Be able to remotely update peek

• Only ever return JSON from the whole API, no HTML

• Be able to download the IP database if not present (from GitHub)

• Be able to update the IP database if it is outdated

• Be able to manually override the server's country

• Support IPV6 (IMPORTANT! ONE OF TOP PRIORITIES)

• Release V1.0.0 once api is done (Without auth)

Security

If security vulnerabilities are discovered, please see the Peek security policy.