Skip to main content

Service serves savvy server stats.

Project description

Service Stats

Service serves savvy server stats.

Build Status Coverage Status PyPi Licence

Showcase

Service Stats is completely configurable, allowing you to request data about boot time, CPU usage, disk usage, memory usage, network usage, and system information. You can send all this right to Slack. Great for a daily/weekly server snapshot of what's going on. Build custom logic to warn you about high CPU/memory usage or low available disk space.

Install

# Install Service Stats
pip3 install service-stats

# Install locally
make install

# Setup Slack ENV variables (optional)
cp .env.example .env

# Get Makefile help
make help

Usage

Grab all server data and send it to Slack.

Usage:
    service-stats --boot --cpu --disk --memory --network --system --slack

Options:
    -h, --help     show this help message and exit
    -b, --boot     Show boot time stats.
    -c, --cpu      Show CPU stats.
    -d, --disk     Show disk stats.
    -m, --memory   Show memory stats.
    -n, --network  Show network stats.
    -s, --system   Show system stats.
    -sl, --slack   Send Service report to Slack.

Environment Variables (optional):
    SLACK_BOT_TOKEN     The Slackbot token to use for authentication
    SLACK_CHANNEL       The channel to post a message to

Development

# Lint the project
make lint

# Run tests
make test

# Run test coverage
make coverage

# Run the scripts locally
venv/bin/python service_stats/app.py --help

Attribution

Based on this article.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

service-stats-2.1.0.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

service_stats-2.1.0-py3-none-any.whl (12.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page