Tool to log system stats to stdout or a file

Install using Homebrew.

brew install atkinchris/tools/statslogger

After running the tool, the first emitted result will only appear after the set frequency has passed. Note, at short frequencies, CPU stats may not be accurate, as enough time may not have passed to determine an average percentage.

$ statslogger --help
statslogger 0.8.2
Tool to log system stats to stdout or a file

USAGE:
    statslogger [FLAGS] [OPTIONS]

FLAGS:
        --debug         Show debug messages
    -h, --help          Prints help information
        --no-hashing    Disable hashing of username
    -V, --version       Prints version information

OPTIONS:
    -f, --format <format>          Output format [default: JSON]  [possible values: Plain, JSON]
    -o, --output <output>          Output logs to a folder, in files grouped by current date and hour
    -p, --processes <processes>    Maximum number of processes to log [default: 10]
    -t, --time <time>              Set frequency time in seconds [default: 5]
    -u, --url <url>                Post logs to a URL, in JSON format [env: STATSLOGGER_URL]

In addition to logging to stdout and a folder, this tool can also send log lines over http/https to a remote service. Logs will be sent as soon as they are generated, in JSON format, via a POST method. To enable this option, set the --url option.

The URL can be set by command line argument (-u, --url), or an environment variable (STATSLOGGER_URL). Additionally, if a .statslogger file is present in the home directory of the executing user, it will also be loaded into the environment. This file is optional, and should be in the standard dotenv format, for example:

STATSLOGGER_URL=http://example.com

All formats log to a single line, for easy piping into other tools like jq.

Below is the information that is logged from this tool. For plain text output, the comma delimited columns are in the same order as this table. If data is formatted for plain text output, it's format is shown separately.

To release a version of this tool, run ./release.sh. This will build a production copy of the binary, package it, and produce a Homebrew formula. Then, do the following steps outside of this repo:

• Paste the contents of the new formula at ./releases/statslogger.rb into the relevant file in atkinchris/homebrew-tools repo.
• Create a GitHub release for the newly created version tag (which was pushed by release.sh) and attach the compiled binary package to it, found at ./releases/statslogger-<version>.tar.gz.

This tool can be run as a persistent service on macOS. After installing, run brew services start statslogger to start the service. This will run the tool on a time of 15 seconds, outputting to Homebrew's default var/log directory, usually /usr/local/var/log/statslogger_<hostname>_<date>_<hour>.

After updating or reinstalling, you will need to run brew services restart statslogger.

If running as a service, error logs will be written to Homebrew's default var/log directory, usually /usr/local/var/log/statslogger_err.log.