Skip to content

Latest commit

 

History

History
95 lines (74 loc) · 2.88 KB

README.md

File metadata and controls

95 lines (74 loc) · 2.88 KB

SysCapture

Visit Nodebyte

Overview

SysCapture is a powerful system monitoring agent that provides real-time hardware metrics, system alerts, and monitoring capabilities through a RESTful API. It's designed for easy integration with existing monitoring stacks and supports multiple notification channels.

Table of Contents

Features

Core Features

  • Hardware Monitoring: Real-time CPU, memory, disk, and network metrics
  • RESTful API: Comprehensive HTTP endpoints with authentication
  • Alert System: Configurable thresholds and notifications
  • Multi-Channel Notifications: Support for Discord, Slack, and Email

Monitoring Capabilities

  • CPU usage and temperature
  • Memory utilization and swap
  • Disk usage and I/O metrics
  • Network bandwidth and connections
  • DDOS detection and prevention

Notification Channels

  • Discord webhooks with rich embeds
  • Email support (SMTP, SendGrid, Postmark, Resend)
  • Slack webhooks
  • Custom notification templates

Quick Start

Installation

# Clone the repository
git clone https://github.com/nodebytehosting/syscapture.git
cd syscapture

# Install dependencies
make install

# Start the service
make start

Basic Usage

# Get all metrics
curl http://localhost:42000/api/metrics

# Get specific metrics
curl http://localhost:42000/api/metrics/cpu
curl http://localhost:42000/api/metrics/memory
curl http://localhost:42000/api/metrics/disk

Documentation

Setup Guides

Feature Documentation

Examples

For detailed configuration options, see the Configuration Guide.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support