Skip to content

README.md

Latest commit

 

History

History
83 lines (62 loc) · 2.18 KB

README.md

File metadata and controls

83 lines (62 loc) · 2.18 KB

Uptrace

Uptrace receives, stores, and displays application observability data. It depends on PostgreSQL, ClickHouse, and Redis.

Build Variables

Set these in the build variables:

DPANEL_DOCKER_NETWORK=production-dpanel-network
DPANEL_DOCKER_IMAGE_TAG=2.0.3

Runtime Variables

Set these in the runtime variables:

DPANEL_DOCKER_NETWORK=production-dpanel-network
DPANEL_DOCKER_IMAGE_TAG=2.0.3
DPANEL_DOCKER_NETWORK_ALIAS=uptrace

PORT=14318
UPTRACE_GRPC_PORT=14317
DPANEL_UPTRACE_HOST_BIND=127.0.0.1

UPTRACE_SERVICE_ENV=production
UPTRACE_SECRET=dummy-uptrace-service-secret
UPTRACE_SITE_URL=https://mandhor.example.com
UPTRACE_INGEST_URL=https://mandhor.example.com?grpc=443

UPTRACE_ADMIN_NAME=Admin
UPTRACE_ADMIN_EMAIL=admin@example.com
UPTRACE_ADMIN_PASSWORD=dummy-uptrace-admin-password
UPTRACE_API_TOKEN=dummy-uptrace-api-token
UPTRACE_PROJECT_TOKEN=dummy-uptrace-project-token
UPTRACE_ORG_NAME=Example Organization
UPTRACE_PROJECT_NAME=Example Project

UPTRACE_CLICKHOUSE_ADDR=clickhouse:9000
UPTRACE_CLICKHOUSE_DATABASE=uptrace
UPTRACE_CLICKHOUSE_USER=uptrace
UPTRACE_CLICKHOUSE_PASSWORD=dummy-clickhouse-password
UPTRACE_CLICKHOUSE_MAX_EXECUTION_TIME=15s

UPTRACE_POSTGRES_ADDR=postgres:5432
UPTRACE_POSTGRES_USER=uptrace
UPTRACE_POSTGRES_PASSWORD=dummy-uptrace-postgres-password
UPTRACE_POSTGRES_DATABASE=uptrace

UPTRACE_REDIS_ADDR=redis:6379
UPTRACE_REDIS_DB=0

Connection

From the Docker host or host-run Caddy:

127.0.0.1:14318
127.0.0.1:14317

From another container on the same Docker network:

uptrace:80
uptrace:4317

Notes

PORT is the standard host-exposed port variable. It maps to Uptrace HTTP port 80 inside the container. UPTRACE_GRPC_PORT maps to Uptrace gRPC port 4317 inside the container. Both ports bind to DPANEL_UPTRACE_HOST_BIND, which defaults to 127.0.0.1.

The uptrace PostgreSQL database, PostgreSQL user, ClickHouse database, and ClickHouse user must already exist before first start. The script generates /etc/uptrace/config.yml under .dpanel-generated/ from runtime variables. The generated directory is private on the host, while the mounted config file is readable by the container and mounted read-only.