DMS (Dunimd Middleware Service)

English | 简体中文

Help Documentation

DMS (Dunimd Middleware Service) — A high-performance Rust middleware framework that unifies backend infrastructure. Built for enterprise-scale with modular architecture, built-in observability, and distributed systems support.

🏗️ Core Architecture

📐 Modular Design

DMS adopts a highly modular architecture with 12 core modules, enabling on-demand composition and seamless extension:

🚀 Key Features

🔍 Distributed Tracing

• W3C Trace Context standard implementation
• Full-chain TraceID/SpanID propagation
• Baggage data transmission for business context
• Multi-language compatibility (Java, Go, Python)

📊 Enterprise Observability

• Native Prometheus metrics export
• Counter, Gauge, Histogram, Summary metric types
• Out-of-the-box Grafana dashboard integration
• Real-time performance statistics with quantile calculation
• Full-stack metrics (CPU, memory, I/O, network)

🤖 Intelligent Device Management

• Auto-discovery and registration
• Efficient resource pool management
• Policy-based scheduling with priority support
• Dynamic load balancing
• Complete device lifecycle management

📝 Structured Logging

• JSON and text format support
• Configurable sampling rates
• Intelligent log rotation
• Automatic tracing context inclusion
• DEBUG/INFO/WARN/ERROR log levels

⚙️ Flexible Configuration

• Multi-source loading (files, environment variables, runtime)
• Hot configuration updates
• Modular architecture for on-demand composition
• Plugin-based extension mechanism

📁 Secure File System

• Unified project root directory management
• Atomic file operations
• Categorized directory structure
• JSON data persistence
• Secure path handling

🛠️ Installation & Environment

Prerequisites

• Rust: 1.65+ (2021 Edition)
• Cargo: 1.65+
• Platforms: Linux, macOS, Windows

Quick Setup

Add DMS to your project's Cargo.toml:

[dependencies]
dms_core = { git = "https://gitee.com/dunimd/dms" }

Or use cargo add:

cargo add DMS --git https://gitee.com/dunimd/dms

⚡ Quick Start

Core API Usage

use dms_core::prelude::*;

#[tokio::main]
async fn main() -> DMSResult<()> {
    // Build service runtime
    let app = DMSAppBuilder::new()
        .with_config("config.yaml")?
        .with_logging(DMSLogConfig::default())?
        .with_observability(DMSObservabilityConfig::default())?
        .build()?;
    
    // Run business logic
    app.run(|ctx: &DMSServiceContext| async move {
        ctx.logger().info("service", "DMS service started")?;
        // Your business code here
        Ok(())
    }).await
}

Observability Example

use dms_core::observability::*;

#[traced(name = "user_service")]
async fn get_user(ctx: &DMSServiceContext, user_id: u64) -> DMSResult<User> {
    // Automatically record traces and metrics
    let user = fetch_user_from_db(user_id).await?;
    Ok(user)
}

🔧 Configuration

Configuration Example

# config.yaml
service:
  name: "my-service"
  version: "1.0.0"

logging:
  level: "info"
  format: "json"
  file_enabled: true
  console_enabled: true

observability:
  metrics_enabled: true
  tracing_enabled: true
  prometheus_port: 9090

resource:
  providers: ["cpu", "gpu", "memory"]
  scheduling_policy: "priority_based"

Configuration Sources

DMS supports multiple configuration sources in order of priority (highest to lowest):

1. Runtime parameters
2. Environment variables (prefixed with DMS_)
3. Configuration files (YAML, TOML, JSON)
4. Default values

🧪 Development & Testing

Running Tests

# Run all tests
cargo test

# Run specific test module
cargo test cache

# Run with verbose output
cargo test -- --nocapture

❓ Frequently Asked Questions

Q: How to add a new module? A: Implement the DMSModule trait and register it via DMSAppBuilder::with_module.

Q: How to configure logging level? A: Set logging.level in the configuration file, supporting DEBUG/INFO/WARN/ERROR levels.

Q: How to enable metrics export? A: Set observability.metrics_enabled: true and configure prometheus_port in the configuration file.

Q: How to extend configuration sources? A: Implement a custom configuration loader and register it with DMSConfigManager.

Q: How to handle asynchronous tasks? A: Use DMSAppBuilder::with_async_module to add async modules, the framework handles async lifecycle automatically.

🌏 Community & Citation

• Welcome to submit Issues and PRs!

• Gitee: https://gitee.com/dunimd/dms.git