Curadise monitoring agent - async metrics collection, heartbeats, and remediation
Project description
curadise-agent
Async monitoring agent for Curadise - collects system metrics, sends heartbeats, and executes remote commands with security-first design.
Features
- Async-first architecture - Built on
anyiofor high-performance concurrent operations - System metrics collection - CPU, memory, disk, network via
psutil - HTTP health checks - Monitor endpoints with customizable checks
- Buffered transport - In-memory buffer with optional persistence for reliability
- Heartbeat service - Regular health reporting with automatic reconnection
- Remote command execution - Secure sandboxed execution with allowlist/denylist
- mTLS support - Mutual TLS authentication for secure communication
- JWT authentication - Token-based auth with automatic refresh
- Hot-reload configuration - Watch config files for changes without restart
- Structured logging - JSON logging via
structlogfor easy parsing
Requirements
- Python 3.12+
- Linux or macOS
Installation
# Using pip
pip install curadise-agent
# Using uv (recommended)
uv pip install curadise-agent
# From source
git clone https://github.com/pysingh09/curadise-agent.git
cd curadise-agent
uv pip install -e .
Quick Start
- Create a configuration file:
cp examples/agent.yaml /etc/curadise/agent.yaml
- Set your enrollment token:
export CURADISE_ENROLLMENT_TOKEN="your-token-here"
- Run the agent:
curadise-agent run --config /etc/curadise/agent.yaml
CLI Commands
# Run the agent
curadise-agent run --config agent.yaml
# Check agent version
curadise-agent version
# Validate configuration
curadise-agent config validate --config agent.yaml
# Show effective configuration
curadise-agent config show --config agent.yaml
Configuration
The agent is configured via YAML files with Jinja2 templating support for environment variables.
Minimal Configuration
server:
url: "https://curadise.example.com"
auth:
enrollment_token: "{{ env('CURADISE_ENROLLMENT_TOKEN') }}"
Key Configuration Sections
| Section | Description |
|---|---|
server |
Server URL, timeout, SSL settings |
auth |
Enrollment token, mTLS certificates |
buffer |
Memory buffer size, persistence, batching |
retry |
Retry attempts, backoff, circuit breaker |
heartbeat |
Heartbeat interval and health metrics |
collectors |
System metrics and HTTP check configuration |
executor |
Command execution settings and allowlist |
logging |
Log level, format, and file rotation |
state |
Persistent state directory |
tags |
Custom tags for metrics and heartbeats |
See examples/agent.yaml for a complete configuration reference.
Environment Variables
Configuration values can reference environment variables:
auth:
enrollment_token: "{{ env('CURADISE_ENROLLMENT_TOKEN') }}"
http_checks:
- url: "https://api.example.com/health"
headers:
Authorization: "Bearer {{ env('API_TOKEN') }}"
Architecture
curadise-agent/
├── src/curadise_agent/
│ ├── auth/ # JWT tokens, mTLS, registration
│ ├── collectors/ # Metrics collectors (system, HTTP)
│ ├── config/ # Configuration loading, schema, watcher
│ ├── executor/ # Command execution with sandbox
│ ├── heartbeat/ # Heartbeat service and health checks
│ ├── models/ # Pydantic models (domain, API)
│ ├── state/ # Persistent state management
│ ├── transport/ # HTTP client, buffering, batching
│ └── utils/ # Logging, retry, shutdown handling
└── tests/
├── unit/ # Unit tests
└── integration/ # Integration tests
Development
Setup
# Clone the repository
git clone https://github.com/pysingh09/curadise-agent.git
cd curadise-agent
# Create virtual environment
uv venv
source .venv/bin/activate
# Install with dev dependencies
uv pip install -e ".[dev]"
# Install pre-commit hooks
pre-commit install
Running Tests
# Run all tests
pytest
# Run with coverage
pytest --cov=curadise_agent --cov-report=html
# Run only unit tests
pytest tests/unit/
# Run integration tests
pytest tests/integration/ -m integration
Code Quality
# Linting
ruff check src/ tests/
# Type checking
mypy src/
# Format code
ruff format src/ tests/
Security
The agent implements several security measures:
- Command allowlist/denylist - Control which commands can be executed
- Signature verification - Optionally require server signatures on commands
- Sandboxed execution - Commands run in isolated subprocesses
- mTLS support - Mutual TLS for server authentication
- JWT with refresh - Short-lived tokens with automatic refresh
- No secrets in config - Use environment variables for sensitive data
License
MIT License - see LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file curadise_agent-0.1.0.tar.gz.
File metadata
- Download URL: curadise_agent-0.1.0.tar.gz
- Upload date:
- Size: 66.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6cb31bb9b0f503f1d871172d64374b401f88e2768ffc068d985ad2949d32d5d7
|
|
| MD5 |
cbe4618e1992eae4d4732b5ad5751fe8
|
|
| BLAKE2b-256 |
671794f1cb0eb459a21e34577cd8f21ed315da1f957b4104ba77a720610dd431
|
Provenance
The following attestation bundles were made for curadise_agent-0.1.0.tar.gz:
Publisher:
publish.yml on pysingh09/curadise-agent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
curadise_agent-0.1.0.tar.gz -
Subject digest:
6cb31bb9b0f503f1d871172d64374b401f88e2768ffc068d985ad2949d32d5d7 - Sigstore transparency entry: 844909078
- Sigstore integration time:
-
Permalink:
pysingh09/curadise-agent@a131ddc82a75da3a8f28fbb86fec5ce4220e58b7 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pysingh09
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a131ddc82a75da3a8f28fbb86fec5ce4220e58b7 -
Trigger Event:
release
-
Statement type:
File details
Details for the file curadise_agent-0.1.0-py3-none-any.whl.
File metadata
- Download URL: curadise_agent-0.1.0-py3-none-any.whl
- Upload date:
- Size: 78.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96d8fc73084fdaff3ff8423f90c05a11d15cec3bfcb2cd0014869e98fe620401
|
|
| MD5 |
f714dee9e926c125979dfe2b12147935
|
|
| BLAKE2b-256 |
39910fb6873b693a3957e1ef5dccd69f79257f44086ad4bbaa54635111443fb8
|
Provenance
The following attestation bundles were made for curadise_agent-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on pysingh09/curadise-agent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
curadise_agent-0.1.0-py3-none-any.whl -
Subject digest:
96d8fc73084fdaff3ff8423f90c05a11d15cec3bfcb2cd0014869e98fe620401 - Sigstore transparency entry: 844909081
- Sigstore integration time:
-
Permalink:
pysingh09/curadise-agent@a131ddc82a75da3a8f28fbb86fec5ce4220e58b7 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pysingh09
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a131ddc82a75da3a8f28fbb86fec5ce4220e58b7 -
Trigger Event:
release
-
Statement type: