Skip to main content

RunSentry Agent - Monitor and track scheduled job executions

Project description

RunSentry Agent

The RunSentry agent automatically discovers and monitors scheduled jobs on Linux systems. It integrates seamlessly with your existing cron jobs and Kubernetes CronJobs, providing visibility into your critical scheduled operations.

Features

  • 🔍 Auto-Discovery: Automatically discovers cron jobs and Kubernetes CronJobs
  • 📊 Execution Tracking: Monitors job executions, durations, and outcomes
  • 🔒 Secure: Outbound-only HTTPS communication
  • 💾 Resilient: Local buffering ensures no data loss during network issues
  • 🚀 Easy Installation: One-line installer script

Quick Start

Installation

Install the agent with a single command:

RUNSENTRY_TOKEN=your_token_here curl -fsSL https://runsentrystorage.blob.core.windows.net/main/install.sh | bash

The installer will:

  1. Verify Python 3.10+ is installed
  2. Create an isolated virtual environment
  3. Install the RunSentry agent package
  4. Register the agent with your RunSentry backend (if token provided)
  5. Set up and start the systemd service

Installation without token:

curl -fsSL https://runsentrystorage.blob.core.windows.net/main/install.sh | bash

# Register manually later
RUNSENTRY_TOKEN=xxx /opt/runsentry/venv/bin/runsentry register --backend-url https://api.runsentry.io
systemctl start runsentry-agent

Usage

Service Management

The agent runs automatically as a systemd service:

# Check status
systemctl status runsentry-agent

# View logs
journalctl -u runsentry-agent -f

# Restart
systemctl restart runsentry-agent

Optional: Wrap Cron Jobs

You can optionally wrap your cron jobs for enhanced tracking:

# Instead of:
0 * * * * /path/to/script.sh

# Use:
0 * * * * /opt/runsentry/venv/bin/runsentry exec /path/to/script.sh

This provides execution-level tracking and ensures events are captured even if the backend is temporarily unavailable.

Configuration

Configuration is automatically created at /etc/runsentry/config.yaml during registration. The agent requires minimal configuration and works out of the box after registration.

What Gets Discovered

The agent automatically discovers:

  • Linux Cron: User crontabs, system crontab, and /etc/cron.d/ files
  • Kubernetes CronJobs: All CronJobs across all namespaces (requires Kubernetes Python client)

Requirements

  • Python 3.10 or higher
  • Linux operating system
  • Network access to RunSentry backend
  • Root or sudo access for installation

Upgrading

Upgrade the agent with:

source /opt/runsentry/venv/bin/activate
pip install --upgrade runsentry-agent
systemctl restart runsentry-agent

Configuration is preserved during upgrades.

Troubleshooting

Agent not starting:

journalctl -u runsentry-agent -f

Check agent status:

systemctl status runsentry-agent

Verify configuration:

cat /etc/runsentry/config.yaml

Support

For help and questions:

License

MIT License

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

runsentry_agent-1.1.0.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runsentry_agent-1.1.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file runsentry_agent-1.1.0.tar.gz.

File metadata

  • Download URL: runsentry_agent-1.1.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for runsentry_agent-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e2cada103f448404723bbb808c774f6b1495938108aaf2a0dfafb861d78dea0a
MD5 6553d2588abea73f24d9b5fb64c0657f
BLAKE2b-256 5f7dae9fac5d67b4d152135f6033ac7b6ef06784130408fbb6fabe5e90fe0c85

See more details on using hashes here.

File details

Details for the file runsentry_agent-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for runsentry_agent-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1437aaea721e98cdfb7f5044ee85403c601372950fb10e7cea8772fffdf955a9
MD5 2d4445ca431377b3cde1b725ce64e68d
BLAKE2b-256 26df607cbe65d70e82ee81966f56676e102f23cef346008a924419eb7a5f1fc1

See more details on using hashes here.

Supported by

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