Reference

LiveVerification Required

LogDB Configuration And BYOC Reference

Source-backed reference for LogDB runtime environment variables, S3 query-read selection, WAL durability settings, optional gRPC bind configuration, and AWS BYOC Terraform-to-Helm handoff values.

Current availability

Private Beta. Public beta is scheduled for .

Reference Snapshot

Runtime env vars
13
BYOC Helm values
11
BYOC Terraform inputs
7

Maturity Status

Runtime Configuration

Live

Local bind, data directory, optional gRPC listener, and OTLP backpressure settings are read by the current executable at startup.

BYOC Handoff

Verification Required

The AWS package is a Terraform-to-Helm bootstrap with offline preflight validation. It does not approve full VPC/EKS bootstrap, image publishing, S3-backed publication, support, or GA readiness.

Reference Summary

IDTypeNameMethodKey or pathMaturityEvidence
ldb-config-http-bindconfigurationHTTP bind address
Selects the Actix HTTP listener address for health, endpoint, OTLP HTTP, and query routes.
n/aLOGDB_BIND_ADDRESSLiveLDB-EVID-009, config.rs, main.rs
ldb-config-data-dirconfigurationData directory
Root for local WAL, segment publication, replay checkpoints, audit evidence, and local query reads.
n/aLOGDB_DATA_DIRLiveLDB-EVID-009, config.rs, durable_gateway.rs
ldb-config-grpc-bindconfigurationOptional OTLP/gRPC bind address
Starts the optional Tonic OTLP logs and traces listener when set to a socket address.
n/aLOGDB_OTLP_GRPC_BIND_ADDRESSLiveLDB-EVID-009, config.rs, main.rs
ldb-config-otlp-backpressureconfigurationOTLP gateway backpressure
Overrides shared in-flight request, record, and byte budgets for HTTP and gRPC OTLP ingest.
n/aLOGDB_OTLP_MAX_IN_FLIGHT_*LiveLDB-EVID-009, backpressure.rs, config.rs
ldb-config-s3-query-readconfigurationS3 query-read store
Switches POST /v1/query from local segment bundles to a configured S3 read path.
n/aLOGDB_QUERY_STORE, LOGDB_QUERY_S3_*Verification RequiredLDB-EVID-004, LDB-EVID-009, main.rs
ldb-config-wal-durabilityconfigurationWAL durability mode
Keeps the default local WAL or opts into replicated-local quorum writes before segment publication.
n/aLOGDB_WAL_DURABILITY_MODE, LOGDB_WAL_REPLICA_PATHS, LOGDB_WAL_WRITE_QUORUMVerification RequiredLDB-EVID-005, LDB-EVID-009, config.rs
ldb-byoc-terraform-bootstrapconfigurationAWS BYOC Terraform bootstrap
Creates customer-owned S3, KMS, and IAM handoff resources with retained-data guardrails.
terraform applydeploy/aws/byoc/terraformVerification RequiredLDB-EVID-009, terraform/main.tf, terraform/outputs.tf
ldb-byoc-helm-valuesconfigurationAWS BYOC Helm values
Maps chart values into runtime env vars and BYOC handoff metadata for the Kubernetes workload.
helm installdeploy/aws/byoc/helm/service-logdbVerification RequiredLDB-EVID-009, values.yaml, configmap.yaml
ldb-byoc-handoff-preflightconfigurationBYOC handoff preflight
Validates Terraform output JSON against expected Helm values, retained resources, and uninstall notes before install automation runs Helm.
preflight_byoc_handoffLogDB/src/control/byoc_preflight.rsVerification RequiredLDB-EVID-009, byoc_preflight.rs

Local Runtime Settings

Core startup environment variables
KeyDefaultAccepted valueRead atRestartEvidence
LOGDB_BIND_ADDRESS127.0.0.1:80Host and port string accepted by Actix HttpServer::bind, such as 127.0.0.1:4318.Service startupYesLogDB/src/config.rs, LogDB/src/main.rs
LOGDB_DATA_DIRD:/Data/DBNon-empty filesystem path. Blank values use the default.Service startupYesLogDB/src/config.rs
LOGDB_OTLP_GRPC_BIND_ADDRESSunsetSocket address such as 127.0.0.1:4317 or 0.0.0.0:4317. Blank values disable the listener.Service startupYesLogDB/src/config.rs, LogDB/src/main.rs
LOGDB_OTLP_MAX_IN_FLIGHT_REQUESTS64Positive u32. Zero, blank, or malformed values use the default.Service startupYesLogDB/src/config.rs, LogDB/src/ingestion/backpressure.rs
LOGDB_OTLP_MAX_IN_FLIGHT_RECORDS8192Positive integer. Zero, blank, or malformed values use the default.Service startupYesLogDB/src/config.rs, LogDB/src/ingestion/backpressure.rs
LOGDB_OTLP_MAX_IN_FLIGHT_BYTES33554432Positive integer byte count. Zero, blank, or malformed values use the default.Service startupYesLogDB/src/config.rs, LogDB/src/ingestion/backpressure.rs
export LOGDB_BIND_ADDRESS=127.0.0.1:4318
export LOGDB_DATA_DIR="${TMPDIR:-/tmp}/logdb-docs-034"
export LOGDB_OTLP_GRPC_BIND_ADDRESS=127.0.0.1:4317

cargo run

S3 Query-Read Selection

Query store environment variables
KeyDefaultAccepted valueRead atRestartEvidence
LOGDB_QUERY_STORElocals3 selects the S3 async object-store read path. Any other value uses the local segment store.Service startupYesLogDB/src/config.rs, LogDB/src/main.rs
LOGDB_QUERY_S3_BUCKETempty unless LOGDB_QUERY_STORE=s3S3 bucket name for retained segment bundle reads.Service startupYesLogDB/src/config.rs, LogDB/src/main.rs
LOGDB_QUERY_S3_PREFIXunsetSegment publication prefix containing bundle directories and manifest.json objects.Service startupYesdocs/query/http-query-api.md, LogDB/src/main.rs
LOGDB_QUERY_S3_REGIONAWS SDK default chainNon-empty AWS region string such as us-east-1.Service startupYesLogDB/src/config.rs, LogDB/src/main.rs

LOGDB_QUERY_STORE=s3 changes the query read path for POST /v1/query. It does not make endpoint, OTLP HTTP, or OTLP/gRPC ingest publish to S3.

export LOGDB_QUERY_STORE=s3
export LOGDB_QUERY_S3_BUCKET=logdb-alpha
export LOGDB_QUERY_S3_PREFIX=tenant-a/segments
export LOGDB_QUERY_S3_REGION=us-east-1

WAL Durability Settings

Direct-ingest WAL environment variables
KeyDefaultAccepted valueRead atRestartEvidence
LOGDB_WAL_DURABILITY_MODElocalreplicated-local or replicated_local opts into replica quorum.Service startupYesLogDB/src/config.rs
LOGDB_WAL_REPLICA_PATHSLOGDB_DATA_DIR/wal/replicas/replica-{1,2,3}.walComma-separated local WAL replica paths used only in replicated-local mode.Service startupYesLogDB/src/config.rs, README.md
LOGDB_WAL_WRITE_QUORUMmajority quorumPositive integer write quorum for replicated-local mode. Zero or malformed values use the default.Service startupYesLogDB/src/config.rs, README.md

Direct ingest defaults to one local live WAL at wal/live-ingest.wal below LOGDB_DATA_DIR. Replicated-local mode requires a local replica quorum before endpoint, OTLP HTTP/protobuf, OTLP/gRPC, or OTLP JSON compatibility ingestion publishes segment bundles.

AWS BYOC Terraform Bootstrap

Terraform module inputs
KeyDefaultPurposeEvidence
aws_regionnoneAWS region where customer-owned telemetry resources are created.terraform/variables.tf
name_prefix, environmentnoneLowercase resource-name inputs used to derive names and retained-resource IDs.terraform/variables.tf, terraform/main.tf
tenant_id, dataset_idnoneTags customer-owned data-plane resources and default object scope.terraform/variables.tf, terraform/main.tf
telemetry_prefixtelemetryS3 object prefix that the LogDB data-plane IAM policy can list, read, and write.terraform/variables.tf, terraform/main.tf
telemetry_bucket_namederived from name_prefix, environment, and regionOptional globally unique S3 bucket name; otherwise Terraform derives one.terraform/variables.tf, terraform/main.tf
eks_oidc_provider_arn, eks_oidc_provider_urlnoneEKS OIDC provider inputs for the Kubernetes service-account IAM role trust policy.terraform/variables.tf, terraform/main.tf
kubernetes_namespace, service_account_nameservice-logdbKubernetes identity that can assume the LogDB data-plane role.terraform/variables.tf, terraform/main.tf

The Terraform module creates one customer-owned telemetry S3 bucket, one customer-owned KMS key and alias, one EKS service-account IAM role, and one scoped IAM policy. The bucket and KMS key use Terraform prevent_destroy; the default IAM policy omits s3:DeleteObject.

AWS BYOC Helm Values

Helm chart values
KeyDefaultPurposeEvidence
config.bindAddress0.0.0.0:8080Sets LOGDB_BIND_ADDRESS in the chart ConfigMap.values.yaml, templates/configmap.yaml
config.otlpGrpcBindAddress0.0.0.0:4317Sets LOGDB_OTLP_GRPC_BIND_ADDRESS and enables the gRPC container port.values.yaml, templates/configmap.yaml
config.otlpMaxInFlightRequests64Sets LOGDB_OTLP_MAX_IN_FLIGHT_REQUESTS.values.yaml, templates/configmap.yaml
config.otlpMaxInFlightRecords8192Sets LOGDB_OTLP_MAX_IN_FLIGHT_RECORDS.values.yaml, templates/configmap.yaml
config.otlpMaxInFlightBytes33554432Sets LOGDB_OTLP_MAX_IN_FLIGHT_BYTES.values.yaml, templates/configmap.yaml
config.dataDir/var/lib/logdbSets LOGDB_DATA_DIR and mounts an emptyDir local-data volume there.values.yaml, templates/deployment.yaml
config.awsRegionemptySets LOGDB_AWS_REGION as BYOC handoff metadata.values.yaml, templates/configmap.yaml
config.telemetryBucketemptySets LOGDB_TELEMETRY_BUCKET as BYOC handoff metadata.values.yaml, templates/configmap.yaml
config.telemetryPrefixtelemetrySets LOGDB_TELEMETRY_PREFIX as BYOC handoff metadata.values.yaml, templates/configmap.yaml
config.kmsKeyArnemptySets LOGDB_KMS_KEY_ARN as BYOC handoff metadata.values.yaml, templates/configmap.yaml
service.grpc.port4317Exposes the OTLP/gRPC service port.values.yaml, templates/service.yaml

The current chart maps runtime settings into a ConfigMap and exposes HTTP on port 80 to container port 8080 plus OTLP/gRPC on service port 4317. LOGDB_AWS_REGION, LOGDB_TELEMETRY_BUCKET, LOGDB_TELEMETRY_PREFIX, and LOGDB_KMS_KEY_ARN are BYOC handoff metadata in this package; runtime S3 query reads still use the LOGDB_QUERY_* settings above.

Handoff Preflight

preflight_byoc_handoff parses terraform output -json content, validates exact Helm handoff values, checks normalized telemetry prefixes, verifies retained S3 and KMS resources, and returns deterministic Helm --set arguments.

terraform output -json > /tmp/logdb-byoc-output.json

# Current validation entry points live in LogDB:
cargo test control::byoc_preflight
./scripts/validate-byoc-layout.sh

Errors

ErrorApplies toMeaningRecovery
Startup bind failureLOGDB_BIND_ADDRESSThe HTTP bind address is invalid, privileged, unavailable, or already in use.Use an unprivileged loopback or container bind address and restart.
Invalid gRPC bind addressLOGDB_OTLP_GRPC_BIND_ADDRESSThe optional gRPC listener value cannot parse as a socket address.Use a host:port value such as 127.0.0.1:4317 or unset the variable.
Invalid S3 query store configurationLOGDB_QUERY_STORE=s3 and LOGDB_QUERY_S3_*Bucket, prefix, or region validation failed before the service started.Use a non-empty bucket, a safe relative prefix, and a non-empty region when overriding the AWS SDK chain.
WAL durability startup failureLOGDB_WAL_DURABILITY_MODE=replicated-localReplica paths or write quorum cannot satisfy replicated-local startup validation.Use reachable local replica paths and a quorum no larger than the available replica set.
BYOC preflight failureTerraform output JSON and Helm valuesRequired Terraform outputs are missing, mismatched, unnormalized, or do not identify retained resources.Rerun terraform output -json, pass the exact Helm handoff values, and keep retained S3/KMS uninstall notes visible.

Boundaries

Local, S3 Query Read, BYOC

Local runtime settings control the service process. LOGDB_QUERY_STORE=s3 controls only retained segment reads for query. BYOC chart values are the install handoff for an existing Kubernetes cluster.

Future Deployment Work

Full VPC/EKS bootstrap, image publishing, live S3 publication, replay from customer-owned S3, security approvals, support posture, and GA commitments require follow-up evidence.

Safe Next Steps

  • Available: DOCS-033

    Read OTLP and query reference

    Route, header, query filter, limit, and error details for the configured runtime.

  • Available now

    Review LogDB evidence

    Check source records before strengthening configuration, BYOC, S3, WAL, or deployment wording.

  • Available: DOCS-039

    Compare OTLP and S3 query scope

    Distinguish live ingest, optional gRPC, local query, S3 query reads, metrics/profile exclusions, and future publication work.