Eric Allam
a999d9ea3f
New batch trigger system with larger payloads, streaming ingestion, larger batch sizes, and a fair processing system. This PR introduces a new `FairQueue` abstraction inspired by our own `RunQueue` that enables multi-tenant fair queueing with concurrency limits. The new `BatchQueue` is built on top of the `FairQueue`, and handles processing Batch triggers in a fair manner with per-environment concurrency limits defined per-org. Additionally, there is a global concurrency limit to prevent the BatchQueue system from creating too many runs too quickly, which can cause downstream issues. For this new BatchQueue system we have a completely new batch trigger creation and ingestion system. Previously this was a single endpoint with a single JSON body that defined details about the batch as well as all the items in the batch. We're introducing a two-phase batch trigger ingestion system. In the first phase, the BatchTaskRun record is created (and possibly rate limited). The second phase is another endpoint that accepts an NDJSON body with each line being a single item/run with payload and options. At ingestion time all items are added to a queue, in order, and then processed by the BatchQueue system. ## New batch trigger rate limits This PR implements a new batch trigger specific rate limit, configured on the `Organization.batchRateLimitConfig` column, and defaults using these environment variables: - `BATCH_RATE_LIMIT_REFILL_RATE` defaults to 10 - `BATCH_RATE_LIMIT_REFILL_INTERVAL` the duration interval, defaults to `"10s"` - `BATCH_RATE_LIMIT_MAX` defaults to 1200 This rate limiter is scoped to the environment ID and controls how many runs can be submitted via batch triggers per interval. The SDK handles the retrying side. ## Batch queue concurrency limits The new column `Organization.batchQueueConcurrencyConfig` now defines an org specific `processingConcurrency` value, with a backup of the env var `BATCH_CONCURRENCY_LIMIT_DEFAULT` which defaults to 10. This controls how many batch queue items are processed concurrently per environment. There is also a global rate limit for the batch queue set via the `BATCH_QUEUE_GLOBAL_RATE_LIMIT` which defaults to being disabled. If set, the entire batch queue system won't process more than `BATCH_QUEUE_GLOBAL_RATE_LIMIT` items per second. This allows controlling the maximum number of runs created per second via batch triggers. ## Batch trigger settings - `STREAMING_BATCH_MAX_ITEMS` controls the maximum number of items in a single batch - `STREAMING_BATCH_ITEM_MAXIMUM_SIZE` controls the maximum size of each item in a batch - `BATCH_CONCURRENCY_DEFAULT_CONCURRENCY` controls the default environment concurrency - `BATCH_QUEUE_DRR_QUANTUM` how many credits each environment gets each round for the DRR scheduler - `BATCH_QUEUE_MAX_DEFICIT` the maximum deficit for the DRR scheduler - `BATCH_QUEUE_CONSUMER_COUNT` how many queue consumers to run - `BATCH_QUEUE_CONSUMER_INTERVAL_MS` how frequently they poll for items in the queue ### Configuration Recommendations by Use Case **High-throughput priority (fairness acceptable at 0.98+):** ```env BATCH_QUEUE_DRR_QUANTUM=25 BATCH_QUEUE_MAX_DEFICIT=100 BATCH_QUEUE_CONSUMER_COUNT=10 BATCH_QUEUE_CONSUMER_INTERVAL_MS=50 BATCH_CONCURRENCY_DEFAULT_CONCURRENCY=25 ``` **Strict fairness priority (throughput can be lower):** ```env BATCH_QUEUE_DRR_QUANTUM=5 BATCH_QUEUE_MAX_DEFICIT=25 BATCH_QUEUE_CONSUMER_COUNT=3 BATCH_QUEUE_CONSUMER_INTERVAL_MS=100 BATCH_CONCURRENCY_DEFAULT_CONCURRENCY=5 ```
94 lines
4.0 KiB
Bash
94 lines
4.0 KiB
Bash
# YOU MIGHT LIKE TO MODIFY THESE VARIABLES
|
|
SESSION_SECRET=abcdef1234
|
|
MAGIC_LINK_SECRET=abcdef1234
|
|
ENCRYPTION_KEY=ae13021afef0819c3a307ad487071c06 # Must be a random 16 byte hex string. You can generate an encryption key by running `openssl rand -hex 16` in your terminal
|
|
LOGIN_ORIGIN=http://localhost:3030
|
|
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres?schema=public
|
|
# This sets the URL used for direct connections to the database and should only be needed in limited circumstances
|
|
# See: https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference#fields:~:text=the%20shadow%20database.-,directUrl,-No
|
|
DIRECT_URL=${DATABASE_URL}
|
|
REMIX_APP_PORT=3030
|
|
APP_ENV=development
|
|
APP_ORIGIN=http://localhost:3030
|
|
ELECTRIC_ORIGIN=http://localhost:3060
|
|
NODE_ENV=development
|
|
|
|
# Clickhouse
|
|
CLICKHOUSE_URL=http://default:password@localhost:8123
|
|
RUN_REPLICATION_CLICKHOUSE_URL=http://default:password@localhost:8123
|
|
RUN_REPLICATION_ENABLED=1
|
|
|
|
# Set this to UTC because Node.js uses the system timezone
|
|
TZ="UTC"
|
|
|
|
# Redis is used for the v3 queuing and v2 concurrency control
|
|
REDIS_HOST="localhost"
|
|
REDIS_PORT="6379"
|
|
REDIS_TLS_DISABLED="true"
|
|
|
|
DEV_OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:3030/otel"
|
|
DEV_OTEL_BATCH_PROCESSING_ENABLED="0"
|
|
|
|
# When the domain is set to `localhost` the CLI deploy command will only --load the image by default and not --push it
|
|
DEPLOY_REGISTRY_HOST=localhost:5000
|
|
|
|
# OPTIONAL VARIABLES
|
|
# This is used for validating emails that are allowed to log in. Every email that do not match this regex will be rejected.
|
|
# WHITELISTED_EMAILS="^(authorized@yahoo\.com|authorized@gmail\.com)$"
|
|
# Accounts with these emails will get global admin rights. This grants access to the admin UI.
|
|
# ADMIN_EMAILS="^(admin@example\.com|another-admin@example\.com)$"
|
|
# This is used for logging in via GitHub. You can leave these commented out if you don't want to use GitHub for authentication.
|
|
# AUTH_GITHUB_CLIENT_ID=
|
|
# AUTH_GITHUB_CLIENT_SECRET=
|
|
|
|
# Configure an email transport to allow users to sign in to Trigger.dev via a Magic Link.
|
|
# If none are configured, emails will print to the console instead.
|
|
# Uncomment one of the following blocks to allow delivery of
|
|
|
|
# Resend
|
|
### Visit https://resend.com, create an account and get your API key. Then insert it below along with your From and Reply To email addresses. Visit https://resend.com/docs for more information.
|
|
# EMAIL_TRANSPORT=resend
|
|
# FROM_EMAIL=
|
|
# REPLY_TO_EMAIL=
|
|
# RESEND_API_KEY=
|
|
|
|
# Generic SMTP
|
|
### Enter the configuration provided by your mail provider. Visit https://nodemailer.com/smtp/ for more information
|
|
### SMTP_SECURE = false will use STARTTLS when connecting to a server that supports it (usually port 587)
|
|
# EMAIL_TRANSPORT=smtp
|
|
# FROM_EMAIL=
|
|
# REPLY_TO_EMAIL=
|
|
# SMTP_HOST=
|
|
# SMTP_PORT=587
|
|
# SMTP_SECURE=false
|
|
# SMTP_USER=
|
|
# SMTP_PASSWORD=
|
|
|
|
# AWS Simple Email Service
|
|
### Authentication is configured using the default Node.JS credentials provider chain (https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/#fromnodeproviderchain)
|
|
# EMAIL_TRANSPORT=aws-ses
|
|
# FROM_EMAIL=
|
|
# REPLY_TO_EMAIL=
|
|
|
|
# CLOUD VARIABLES
|
|
POSTHOG_PROJECT_KEY=
|
|
|
|
# DEPOT_ORG_ID=<Depot org id>
|
|
# DEPOT_TOKEN=<Depot org token>
|
|
# DEV_OTEL_EXPORTER_OTLP_ENDPOINT="http://0.0.0.0:4318"
|
|
# These are needed for the object store (for handling large payloads/outputs)
|
|
# OBJECT_STORE_BASE_URL="https://{bucket}.{accountId}.r2.cloudflarestorage.com"
|
|
# OBJECT_STORE_ACCESS_KEY_ID=
|
|
# OBJECT_STORE_SECRET_ACCESS_KEY=
|
|
# CHECKPOINT_THRESHOLD_IN_MS=10000
|
|
|
|
# These control the server-side internal telemetry
|
|
# INTERNAL_OTEL_TRACE_EXPORTER_URL=<URL to send traces to>
|
|
# INTERNAL_OTEL_TRACE_LOGGING_ENABLED=1
|
|
# INTERNAL_OTEL_TRACE_INSTRUMENT_PRISMA_ENABLED=0
|
|
|
|
# Enable local observability stack (requires `pnpm run docker` to start otel-collector)
|
|
# Uncomment these to send metrics to the local Prometheus via OTEL Collector:
|
|
# INTERNAL_OTEL_METRIC_EXPORTER_ENABLED=1
|
|
# INTERNAL_OTEL_METRIC_EXPORTER_URL=http://localhost:4318/v1/metrics
|
|
# INTERNAL_OTEL_METRIC_EXPORTER_INTERVAL_MS=15000 |