oxi-pulse

---

What is OxiPulse?

OxiPulse is an ultralight, open source server monitoring agent written in Rust. It collects your server's vital signs — CPU, RAM, disk, and network — and ships them to any OpenTelemetry-compatible backend using the OTLP protocol.

OxiPulse is designed to be the monitoring agent you actually want to run:

• No bloat. A single static binary with near-zero CPU and memory overhead.
• No lock-in. Send metrics to SecuryBlack Cloud, your own self-hosted collector, Grafana Cloud, Datadog, or any OTLP endpoint — your choice.
• No downtime on updates. The agent updates itself daily from GitHub Releases and restarts cleanly through your service manager.
• No data loss. An offline buffer survives network outages and flushes automatically when the connection is restored.

OxiPulse is maintained by SecuryBlack's engineering team as a fully open source project under the Apache 2.0 license.

Principles

• Ultralight — Built in Rust. Designed to run invisibly on every server, from a Raspberry Pi to a 256-core bare metal machine.
• Standard protocol — Uses OpenTelemetry OTLP, the industry standard for telemetry. No proprietary wire formats.
• Vendor-neutral — The agent has no hardcoded backend. Point it anywhere.
• Resilient — Exponential backoff and an in-memory ring buffer ensure no data is dropped during outages, up to 24 hours of buffering by default.
• Self-updating — Automatically pulls the correct binary for your platform from GitHub Releases once per day.

Use cases

• Monitor bare-metal servers, VMs, and cloud instances from a single pane of glass.
• Send metrics to your existing OpenTelemetry stack (Grafana, Jaeger, Datadog, etc.).
• Use SecuryBlack Cloud for a zero-config hosted monitoring experience.
• Embed OxiPulse into your own product as a lightweight telemetry foundation.

---

Quickstart

Linux — one command

curl -fsSL https://install.oxipulse.io | bash

The script will ask for your OTLP endpoint and auth token, then install the agent as a systemd service with automatic restart.

Windows — one command (PowerShell as Administrator)

irm https://install.oxipulse.io/windows | iex

The script installs the agent as a Windows Service with automatic restart on failure.

Using SecuryBlack Cloud

Sign in to securyblack.com, add a server, and copy the pre-filled install command — your endpoint and token are already included:

# Linux
curl -fsSL https://install.oxipulse.io | sudo bash -s -- \

# Windows
irm https://install.oxipulse.io/windows | iex -Endpoint ingest.securyblack.com -Token <YOUR_TOKEN>

---

Installation

Pre-built binaries

Download the latest binary for your platform from the Releases page.

Platform	Asset
Linux x86_64	oxipulse-x86_64-unknown-linux-gnu.tar.gz
Linux arm64	oxipulse-aarch64-unknown-linux-gnu.tar.gz
Windows x86_64	oxipulse-x86_64-pc-windows-msvc.zip

Build from source

git clone https://github.com/securyblack/oxi-pulse
cd oxi-pulse
cargo build --release

Requires Rust 1.70+.

---

Configuration

OxiPulse is configured via /etc/oxipulse/config.toml (Linux) or C:\ProgramData\oxipulse\config.toml (Windows), with environment variables as overrides.

# Required
endpoint = "https://ingest.example.com:4317"   # Any OTLP/gRPC endpoint
token    = "your-auth-token"                    # Sent as Authorization: Bearer header

# Optional
interval_secs   = 10    # Collection and export interval (default: 10s)
buffer_max_size = 8640  # Max buffered snapshots when offline (default: 8640 = 24h at 10s)

Environment variable overrides

Variable	Description
OXIPULSE_ENDPOINT	OTLP collector endpoint URL
OXIPULSE_TOKEN	Auth token
OXIPULSE_INTERVAL_SECS	Collection interval in seconds
OXIPULSE_BUFFER_MAX	Max offline buffer size

Logging

Control log verbosity via the RUST_LOG environment variable:

RUST_LOG=debug oxipulse        # Verbose
RUST_LOG=warn  oxipulse        # Warnings and errors only

---

Metrics collected

Metric	OTel Instrument	Unit
system.cpu.usage	Gauge	%
system.memory.used	Gauge	By
system.memory.total	Gauge	By
system.disk.used	Gauge	By
system.disk.total	Gauge	By
system.network.received	Counter (delta)	By
system.network.transmitted	Counter (delta)	By

All metrics use standard OpenTelemetry semantic conventions.

---

Comparison

Feature	OxiPulse	Telegraf	Prometheus Node Exporter	Datadog Agent	New Relic Agent
Written in Rust	✓
Single static binary	✓	✓	✓
OpenTelemetry OTLP native	✓	⚠		⚠
Vendor-neutral	✓	✓	✓
Self-updating	✓			✓	✓
Offline buffer	✓	⚠		✓	✓
Memory-safe	✓
Open source (Apache 2.0)	✓	✓	✓
<10 MB binary	✓		✓

⚠ = Partial or requires additional configuration

---

Service management

Linux (systemd)

# Status
systemctl status oxipulse

# Live logs
journalctl -fu oxipulse

# Restart
systemctl restart oxipulse

# Uninstall
systemctl disable --now oxipulse && rm /usr/local/bin/oxipulse /etc/systemd/system/oxipulse.service

Windows (PowerShell)

# Status
Get-Service OxiPulse

# Logs (Event Viewer)
Get-EventLog -LogName Application -Source OxiPulse -Newest 50

# Restart
Restart-Service OxiPulse

# Uninstall
Stop-Service OxiPulse; sc.exe delete OxiPulse

---

Contributing

OxiPulse is open source and contributions are welcome.

1. Fork the repository
2. Create a feature branch: git checkout -b feat/my-feature
3. Commit your changes following Conventional Commits
4. Open a pull request

Please read our Code of Conduct before contributing.

Development

# Run with a local OTLP collector (e.g. otelcol)
OXIPULSE_ENDPOINT=http://localhost:4317 OXIPULSE_TOKEN=dev cargo run

# Build for all platforms (requires WSL2 on Windows for Linux targets)
cargo build --release --target x86_64-unknown-linux-gnu
cargo build --release --target x86_64-pc-windows-msvc

---

Releases

OxiPulse follows Semantic Versioning. Every push to a v* tag triggers the CI/CD pipeline, which cross-compiles binaries for all supported platforms and publishes them to GitHub Releases with SHA256 checksums.

The agent's self-update mechanism checks for new releases every 24 hours and applies updates automatically. No manual intervention required.

---

Security

If you discover a security vulnerability, please follow our Security Policy and report it privately. Do not open a public GitHub issue for security vulnerabilities.

---

License

OxiPulse is licensed under the Apache License, Version 2.0.

All dependencies are compatible with Apache 2.0 (MIT, Apache-2.0, or BSD licensed).

---