简体中文 | English

LMeterX

📋 Project Overview

LMeterX is a professional large language model performance testing platform that supports comprehensive load testing for any LLM service compatible with the OpenAI API format. Through an intuitive Web interface, users can easily create and manage test tasks, monitor testing processes in real-time, and obtain detailed performance analysis reports, providing reliable data support for model deployment and performance optimization.

✨ Core Features

• Universal compatibility: Applicable to any openai format API such as GPT, Claude, Llama, etc (language/multimodal/CoT)
• Smart load testing: Precise concurrency control & Real user simulation
• Professional metrics: TTFT, TPS, RPS, success/error rate, etc
• Multi-scenario support: Text conversations & Multimodal (image+text)
• Visualize the results: Performance reports & Model arena
• Real-time monitoring: Hierarchical monitoring of tasks and services
• Enterprise ready: Docker deployment & Web management console & Scalable architecture

🏗️ System Architecture

LMeterX adopts a microservices architecture design, consisting of four core components:

1. Backend API Service: FastAPI-based REST API service responsible for task management and result storage
2. Load Testing Engine: Locust-based load testing engine that executes actual performance testing tasks
3. Frontend Interface: Modern Web interface based on React + TypeScript + Ant Design
4. MySQL Database: Stores test tasks, result data, and configuration information

🚀 Quick Start

Environment Requirements

• Docker 20.10.0+
• Docker Compose 2.0.0+
• At least 4GB available memory
• At least 5GB available disk space

One-Click Deployment (Recommended)

Complete Deployment Guide: See Complete Deployment Guide for detailed instructions on all deployment methods

Use pre-built Docker images to start all services with one click:

# Download and run one-click deployment script
curl -fsSL https://raw.githubusercontent.com/MigoXLab/LMeterX/main/quick-start.sh | bash

Usage Guide

1. Access Web Interface: http://localhost:8080
2. Create Test Task:
   • Configure target API address and model parameters
   • Select test type (text conversation/image-text conversation)
   • Set concurrent user count and test duration
   • Configure other advanced parameters (optional)
3. Monitor Test Process: Real-time view of test logs and performance metrics
4. Analyze Test Results: View detailed performance analysis reports and export data

🔧 Configuration

Environment Variable Configuration

General Configuration

SECRET_KEY=your_secret_key_here        # Application security key
FLASK_DEBUG=false                      # Debug mode switch

Database Configuration

DB_HOST=mysql                          # Database host address
DB_PORT=3306                           # Database port
DB_USER=lmeterx                        # Database username
DB_PASSWORD=lmeterx_password           # Database password
DB_NAME=lmeterx                        # Database name

Frontend Configuration

VITE_API_BASE_URL=/api                # API base path

🤝 Development Guide

We welcome all forms of contributions! Please read our Contributing Guide for details.

Technology Stack

LMeterX adopts a modern technology stack to ensure system reliability and maintainability:

• Backend Service: Python + FastAPI + SQLAlchemy + MySQL
• Load Testing Engine: Python + Locust + Custom Extensions
• Frontend Interface: React + TypeScript + Ant Design + Vite
• Deployment & Operations: Docker + Docker Compose + Nginx

Project Structure

LMeterX/
├── backend/                  # Backend service
├── st_engine/                # Load testing engine service
├── frontend/                 # Frontend service
├── docs/                     # Documentation directory
├── docker-compose.yml        # Docker Compose configuration
├── Makefile                  # Run complete code checks
├── README.md                 # English README
└── README_CN.md              # Chinese README

Development Environment Setup

1. Fork the Project to your GitHub account
2. Clone Your Fork, create a development branch for development
3. Follow Code Standards, use clear commit messages (follow conventional commit standards)
4. Run Code Checks: Before submitting PR, ensure code checks, formatting, and tests all pass, you can run make all
5. Write Clear Documentation: Write corresponding documentation for new features or changes
6. Actively Participate in Review: Actively respond to feedback during the review process

🗺️ Development Roadmap

In Development

• Support for custom API paths and performance metrics collection
• Support for user-defined load test datasets
• Support for client resource monitoring

Planned

• User system support
• CLI command-line tool

📚 Related Documentation

• Deployment Guide - Detailed deployment instructions and configuration guide
• Contributing Guide - How to participate in project development and contribute code

🤝 Contributors

Thanks to all developers who have contributed to the LMeterX project:

• @LuckyYC - Project maintainer & Core developer
• @del-zhenwu - Core developer

📄 Open Source License

This project is licensed under the Apache 2.0 License.

---

⭐ If this project helps you, please give us a Star! Your support is our motivation for continuous improvement.