mirror of https://github.com/ruvnet/RuVector.git synced 2026-05-23 21:25:02 +00:00

History

rUv 4b1fd0e286 fix(ci): Fix PostgreSQL Extension CI failures - Remove invalid feature flags (hybrid-search, filtered-search) that don't exist - Replace with valid all-features flag for comprehensive testing - Add PostgreSQL apt repository for older versions on Ubuntu 24.04 - Apply cargo fmt formatting to all crates This fixes CI failures caused by: - Feature flags that were planned but not implemented - PostgreSQL 14 packages not available on Ubuntu 24.04 default repos 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>		2025-12-03 23:43:01 +00:00
..
admin-server.rs	fix(ci): Fix PostgreSQL Extension CI failures	2025-12-03 23:43:01 +00:00
full_observability.rs	fix(ci): Fix PostgreSQL Extension CI failures	2025-12-03 23:43:01 +00:00
metrics_example.rs	fix(ci): Fix PostgreSQL Extension CI failures	2025-12-03 23:43:01 +00:00
OBSERVABILITY_EXAMPLES.md	fix: Fix case sensitivity bug preventing native module from loading	2025-11-21 21:34:52 +00:00
README.md	fix: Fix case sensitivity bug preventing native module from loading	2025-11-21 21:34:52 +00:00
tracing_example.rs	fix: Resolve unresolved imports in ruvector-tiny-dancer-core examples	2025-11-26 22:48:12 +00:00
train-model.rs	fix: Resolve CI build failures	2025-11-26 15:25:47 +00:00

README.md

Tiny Dancer Examples

This directory contains example applications demonstrating how to use Tiny Dancer.

Admin Server Example

File: admin-server.rs

A production-ready admin API server with health checks, metrics, and administration endpoints.

Features

Health check endpoints (K8s liveness & readiness probes)
Prometheus metrics export
Hot model reloading
Configuration management
Circuit breaker monitoring
Optional bearer token authentication

Running

cargo run --example admin-server --features admin-api

Testing

Once running, test the endpoints:

# Health check
curl http://localhost:8080/health

# Readiness check
curl http://localhost:8080/health/ready

# Prometheus metrics
curl http://localhost:8080/metrics

# System information
curl http://localhost:8080/info

Admin Endpoints

Admin endpoints support optional authentication:

# Reload model (if auth enabled)
curl -X POST http://localhost:8080/admin/reload \
  -H "Authorization: Bearer your-token-here"

# Get configuration
curl http://localhost:8080/admin/config \
  -H "Authorization: Bearer your-token-here"

# Circuit breaker status
curl http://localhost:8080/admin/circuit-breaker \
  -H "Authorization: Bearer your-token-here"

Configuration

Edit the example to configure:

Bind address and port
Authentication token
CORS settings
Router configuration

Production Deployment

For production use:

Enable authentication:

auth_token: Some("your-secret-token".to_string())

Use environment variables:

let token = std::env::var("ADMIN_AUTH_TOKEN").ok();

Deploy behind HTTPS proxy (nginx, Envoy, etc.)

Set up Prometheus scraping:

scrape_configs:
  - job_name: 'tiny-dancer'
    static_configs:
      - targets: ['localhost:8080']

Configure Kubernetes probes:

livenessProbe:
  httpGet:
    path: /health
    port: 8080
readinessProbe:
  httpGet:
    path: /health/ready
    port: 8080