mirror of https://github.com/rustfs/rustfs.git synced 2026-07-26 16:28:15 +00:00

Files

T

houseme 27468ebfa9 feat(get): consolidate GET performance optimization (#3972 )

* feat(get): consolidate GET performance optimization

Consolidated implementation of all GET performance optimizations into
a single, well-organized commit replacing the previous patch-on-patch
approach.

## Changes

### Configuration (set_disk/mod.rs)
- Consolidated all GET optimization flags into a single organized section
- Enabled by default: codec streaming, metadata early-stop, page cache reclaim
- Added codec streaming multipart flag (default: disabled)
- Added version-aware early-stop flag (default: disabled)
- Added adaptive duplex buffer sizing based on object size
- All flags use OnceLock caching with rollout percentage support

### Metadata Early-Stop (set_disk/read.rs)
- Delete marker early-stop when quorum agrees
- Version-aware early-stop for versioned GET requests
- MetadataQuorumAccumulator enhanced with:
  - delete_marker_votes tracking
  - requested_version_id and matching_version_votes tracking
  - version_early_stop_decision() method
- 6 new tests for version early-stop scenarios

### Codec Streaming (erasure/coding/decode_reader.rs)
- DualInFlight (2-stripe lookahead) enabled by default

### Decode Pipeline (erasure/coding/decode.rs)
- Stripe prefetch count configuration
- Bitrot-decode overlap configuration

### Disk Layer (disk/local.rs)
- O_DIRECT read configuration constants (preparation)

### Metrics (io-metrics/lib.rs)
- BytesPool acquisition/return metrics
- Metadata phase duration with early-stop label
- Total duration with reader_path label

### Diagnostics (diagnostics/)
- Early-stop reason constants
- Pool tier/outcome label constants

### Observability (.docker/observability/)
- 3 Grafana dashboards for GET optimization monitoring
- Prometheus alert rules (6 alerts: 3 critical, 3 warning)
- Updated README.md and README_ZH.md with usage docs

### Config (config/src/constants/runtime.rs)
- Page cache reclaim read enabled by default

## Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| RUSTFS_GET_CODEC_STREAMING_ENABLE | true | Codec streaming base flag |
| RUSTFS_GET_CODEC_STREAMING_ROLLOUT_PCT | 100 | Codec streaming rollout % |
| RUSTFS_GET_CODEC_STREAMING_MULTIPART_ENABLE | false | Multipart codec streaming |
| RUSTFS_GET_METADATA_EARLY_STOP_ENABLE | true | Early-stop base flag |
| RUSTFS_GET_METADATA_EARLY_STOP_ROLLOUT_PCT | 100 | Early-stop rollout % |
| RUSTFS_GET_METADATA_VERSION_EARLY_STOP_ENABLE | false | Version-aware early-stop |
| RUSTFS_OBJECT_FILE_CACHE_RECLAIM_READ_ENABLE | true | Page cache reclaim |
| RUSTFS_OBJECT_DIRECT_IO_READ_ENABLE | false | O_DIRECT (preparation) |
| RUSTFS_GET_DECODE_STRIPE_PREFETCH_COUNT | 1 | Stripe prefetch |
| RUSTFS_GET_BITROT_DECODE_OVERLAP_ENABLE | false | Bitrot-decode overlap |
| RUSTFS_GET_CODEC_STREAMING_MAX_INFLIGHT | 2 | DualInFlight stripes |

## Rollback

All optimizations can be disabled via environment variables:
RUSTFS_GET_CODEC_STREAMING_ENABLE=false
RUSTFS_GET_METADATA_EARLY_STOP_ENABLE=false
RUSTFS_OBJECT_FILE_CACHE_RECLAIM_READ_ENABLE=false

Co-Authored-By: heihutu <heihutu@gmail.com>

* test(get): add stress test scripts for GET optimization validation

- quick-validate-get-optimization.sh: Quick 5-minute validation
- stress-test-get-optimization.sh: Full 30+ minute stress test
- README-stress-test.md: Usage documentation

Co-Authored-By: heihutu <heihutu@gmail.com>

* test(ecstore): align file cache reclaim defaults

* chore(deps): update redis and erasure codec

* test(ecstore): align decode fill policy default

* test(ecstore): align metadata early-stop default

* fix(ecstore): keep metadata early stop opt-in

---------

Co-authored-by: heihutu <heihutu@gmail.com>

2026-06-28 07:14:07 +08:00

3.3 KiB

Raw Blame History

GET Optimization Stress Test Scripts

Quick Start

Prerequisites

warp installed (https://github.com/minio/warp)
mc configured with access to the RustFS server
RustFS server running with GET optimizations enabled

Quick Validation (5 minutes)

./scripts/quick-validate-get-optimization.sh localhost:9000

This runs basic functional tests:

Data integrity verification
Concurrent GET stability
Early-stop behavior validation

Full Stress Test (30+ minutes)

./scripts/stress-test-get-optimization.sh localhost:9000 ./stress-results

This runs comprehensive tests:

Data correctness validation (1KB, 1MB, 10MB objects)
Concurrent GET stress test (16, 64, 256 concurrency)
Mixed read/write workload
Early-stop behavior under load

Environment Variables

Variable	Default	Description
`WARP_ACCESS_KEY`	rustfsadmin	S3 access key
`WARP_SECRET_KEY`	rustfsadmin	S3 secret key
`MC_ALIAS`	rustfs	mc alias for the server
`TEST_BUCKET`	auto-generated	Test bucket name
`TEST_DURATION`	300s	Duration for stress tests
`CONCURRENCY`	64	Default concurrency level

Test Scenarios

1. Data Correctness Validation

Verifies that GET returns correct data with early-stop enabled:

Uploads random data
Downloads and compares MD5 hash
Tests different object sizes (1KB, 1MB, 10MB)

2. Concurrent GET Stress Test

Tests performance under high concurrency:

Object sizes: 1KiB, 1MiB, 4MiB, 10MiB
Concurrency levels: 16, 64, 256
Duration: configurable (default 300s)

3. Mixed Read/Write Stress Test

Tests stability under concurrent read/write:

50% reads, 50% writes
1MB objects
64 concurrent operations

4. Early-Stop Behavior Validation

Verifies early-stop works correctly:

100 sequential reads of the same object
Verifies data size matches expected
Checks for any download failures

Expected Results

Success Criteria

Data Correctness: 100% pass rate (no data corruption)
Concurrent GET: No errors, consistent latency
Mixed Workload: No deadlocks or data corruption
Early-Stop: All reads return correct data size

Performance Baselines

Object Size	Expected Throughput	Expected p95 Latency
1KiB	> 5 MiB/s	< 10ms
1MiB	> 500 MiB/s	< 20ms
4MiB	> 1000 MiB/s	< 30ms
10MiB	> 2000 MiB/s	< 50ms

Troubleshooting

Common Issues

warp not found: Install with go install github.com/minio/warp@latest
mc not configured: Run mc alias set rustfs http://localhost:9000 admin password
Connection refused: Verify RustFS is running and accessible
Permission denied: Check S3 credentials

Debug Mode

Enable debug logging:

RUST_LOG=rustfs_ecstore::bucket::lifecycle=debug ./scripts/stress-test-get-optimization.sh

Output Files

File	Description
`test-config.txt`	Test configuration
`correctness-results.txt`	Data correctness results
`early-stop-results.txt`	Early-stop validation results
`get-*.json`	Concurrent GET performance (warp JSON)
`mixed-*.json`	Mixed workload performance (warp JSON)
`correctness-errors.log`	Data correctness errors (if any)
`early-stop-errors.log`	Early-stop errors (if any)

3.3 KiB Raw Blame History