Skip to content

README.md

Latest commit

 

History

History
107 lines (84 loc) · 3.25 KB

README.md

File metadata and controls

107 lines (84 loc) · 3.25 KB

Tiled Load Testing with Locust

Load testing for Tiled using Locust. Two test files are available:

  • reader.py - Tests HTTP read operations and search endpoints
  • streaming.py - Tests streaming data writes and WebSocket delivery latency

Quick Start

# Install dependencies (locust should already be available in the environment)
# If not installed, add it to your requirements or install with:
# uv add locust

Starting Test Server

Before running locust tests, start a Tiled server:

# Basic server (works for most tests)
uv run tiled serve catalog \
  --host 0.0.0.0 \
  --port 8000 \
  --api-key secret \
  --temp \
  --init

For streaming tests with Redis cache (optional):

# Start Redis first
redis-server

# Start Tiled server with Redis cache
uv run tiled serve catalog \
  --host 0.0.0.0 \
  --port 8000 \
  --api-key secret \
  --cache-uri "redis://localhost:6379" \
  --cache-ttl 60 \
  --temp \
  --init

This creates a temporary catalog with:

  • API key authentication (key: "secret")
  • Temporary writable storage (automatically cleaned up)
  • Optional Redis cache for enhanced streaming performance
  • Server running on http://localhost:8000

Reading Performance Tests (reader.py)

Tests various HTTP endpoints for reading data, metadata, and search operations.

Examples

Run with default localhost server (uses default API key 'secret'):

uv run locust -f reader.py --headless -u 100 -r 10 -t 60s --host http://localhost:8000

Run with custom API key:

uv run locust -f reader.py --headless -u 100 -r 10 -t 60s --host http://localhost:8000 --api-key your-api-key

Run with custom container name (defaults to locust_testing):

uv run locust -f reader.py --headless -u 100 -r 10 -t 60s --host http://localhost:8000 --container-name my_test_container

Streaming Performance Tests (streaming.py)

Tests streaming data writes and WebSocket delivery with end-to-end latency measurement.

Note: The --node-name parameter is required for streaming tests to avoid conflicts when multiple test runs create nodes with the same name.

Examples

Run with required node name:

uv run locust -f streaming.py --headless -u 10 -r 2 -t 120s --host http://localhost:8000 --node-name my_test_stream

Run with custom API key:

uv run locust -f streaming.py --headless -u 10 -r 2 -t 120s --host http://localhost:8000 --api-key your-api-key --node-name my_test_stream

Control user types with environment variables:

# 2 writers for every 1 streaming reader
WRITER_WEIGHT=2 STREAMING_WEIGHT=1 uv run locust -f streaming.py --headless -u 10 -r 2 -t 120s --host http://localhost:8000 --node-name my_test_stream

Streaming Test Components

  • WriterUser: Writes timestamped array data to streaming nodes
  • StreamingUser: Connects via WebSocket to measure write-to-delivery latency

Parameters

  • -u N: N concurrent users
  • -r N: Spawn N users per second
  • -t Ns: Run for N seconds
  • --headless: Run without web interface (required for automation)

Notes

  • All examples use --headless mode for reliable automation
  • For streaming tests, --node-name is required to avoid conflicts
  • Use environment variables WRITER_WEIGHT and STREAMING_WEIGHT to control user distribution