.env.example

#================================================================================================
# TelemetryFlow Python SDK - ENVIRONMENT CONFIGURATION
#================================================================================================
#
# Copy this file to .env and update the values.
# Compatible with TFO-Collector v1.2.1 (OCB-native).
#
# SECURITY NOTICE:
#   This file contains DEFAULT VALUES suitable for DEVELOPMENT ONLY.
#   DO NOT use these values in production environments.
#
# Quick Start: README.md
# Documentation: docs/
#
#================================================================================================


#================================================================================================
# [1] APPLICATION CONFIGURATION
#================================================================================================
APP_NAME=TelemetryFlow Python SDK

# Timezone
TZ=UTC

# Log level: debug | info | warn | error
LOG_LEVEL=info

# Log format: json | pretty
LOG_FORMAT=json

# Docker Image Version
VERSION=1.2.0
GIT_COMMIT=
GIT_BRANCH=main
BUILD_TIME=

# Docker Image
IMAGE_NAME=telemetryflow/telemetryflow-python-sdk
IMAGE_TAG=1.2.0


#================================================================================================
# [2] SDK — CORE SETTINGS
#================================================================================================
# API Keys (obtain from TFO-Platform backend)
TELEMETRYFLOW_API_KEY_ID=tfk_your_key_id
TELEMETRYFLOW_API_KEY_SECRET=tfs_your_key_secret

# OTLP Exporter endpoint (gRPC by default)
# Local:          localhost:4317
# Docker:         otel-collector:4317
# Host from Docker: host.docker.internal:4317
TELEMETRYFLOW_ENDPOINT=localhost:4317

# Service Identity
TELEMETRYFLOW_SERVICE_NAME=my-service
TELEMETRYFLOW_SERVICE_VERSION=1.2.0
TELEMETRYFLOW_SERVICE_NAMESPACE=telemetryflow
TELEMETRYFLOW_ENVIRONMENT=development
# SECURITY WARNING: TELEMETRYFLOW_INSECURE=true disables TLS — ONLY for development
TELEMETRYFLOW_INSECURE=false


#================================================================================================
# [3] SDK — TFO v2 API SETTINGS (aligned with tfoexporter)
#================================================================================================
# Enable TFO v2 API (default: true)
TELEMETRYFLOW_USE_V2_API=true

# Enable v2-only mode — disables v1 endpoints (default: false)
TELEMETRYFLOW_V2_ONLY=false

# Custom endpoint paths (defaults to v2 when USE_V2_API=true)
# TELEMETRYFLOW_TRACES_ENDPOINT=/v2/traces
# TELEMETRYFLOW_METRICS_ENDPOINT=/v2/metrics
# TELEMETRYFLOW_LOGS_ENDPOINT=/v2/logs


#================================================================================================
# [4] SDK — COLLECTOR IDENTITY (aligned with tfoidentityextension)
#================================================================================================
TELEMETRYFLOW_COLLECTOR_ID=
TELEMETRYFLOW_COLLECTOR_NAME=TelemetryFlow Python SDK
TELEMETRYFLOW_COLLECTOR_HOSTNAME=
TELEMETRYFLOW_DATACENTER=default

# Enable resource enrichment (default: true)
TELEMETRYFLOW_ENRICH_RESOURCES=true


#================================================================================================
# [5] SDK — PROTOCOL SETTINGS
#================================================================================================
# Protocol: grpc | http (default: grpc)
TELEMETRYFLOW_PROTOCOL=grpc

# Enable compression (default: false)
TELEMETRYFLOW_COMPRESSION=false

# Timeout in seconds (default: 10)
TELEMETRYFLOW_TIMEOUT=10


#================================================================================================
# [6] SDK — RETRY SETTINGS
#================================================================================================
# Enable retry (default: true)
TELEMETRYFLOW_RETRY_ENABLED=true

# Max retries (default: 3)
TELEMETRYFLOW_MAX_RETRIES=3

# Retry backoff in milliseconds (default: 500)
TELEMETRYFLOW_RETRY_BACKOFF=500


#================================================================================================
# [7] SDK — BATCH SETTINGS
#================================================================================================
# Batch timeout in milliseconds (default: 5000)
TELEMETRYFLOW_BATCH_TIMEOUT=5000

# Max batch size (default: 512)
TELEMETRYFLOW_BATCH_MAX_SIZE=512


#================================================================================================
# [8] SDK — SIGNALS
#================================================================================================
# Enable specific signals (all enabled by default)
TELEMETRYFLOW_ENABLE_TRACES=true
TELEMETRYFLOW_ENABLE_METRICS=true
TELEMETRYFLOW_ENABLE_LOGS=true

# Enable exemplars for metrics-to-traces correlation (default: true)
TELEMETRYFLOW_ENABLE_EXEMPLARS=true


#================================================================================================
# [9] SDK — RATE LIMITING
#================================================================================================
# Maximum requests per second (0 = unlimited)
TELEMETRYFLOW_RATE_LIMIT=0


#================================================================================================
# [10] TFO-COLLECTOR
#================================================================================================
# TFO-Collector version (OCB-native build with tfoexporter)
TFO_COLLECTOR_VERSION=1.2.1

# OTEL Collector Community version (alternative — standard OCB build)
OTEL_VERSION=0.142.0

# TFO Backend endpoint — where TFO-Collector forwards telemetry via tfo exporter
# Local:   http://localhost:3000
# Docker:  http://host.docker.internal:3000
# K8s:     http://tfo-backend.telemetryflow.svc.cluster.local:3100
TELEMETRYFLOW_BACKEND_ENDPOINT=http://localhost:3000


#================================================================================================
# [11] PROMETHEUS (Metrics Visualization)
#================================================================================================
PROMETHEUS_VERSION=v3.4.0
PORT_PROMETHEUS=9090


#================================================================================================
# [12] TFO-PLATFORM SERVICES (Profile: platform)
#================================================================================================
# TFO-Platform version (backend + frontend images)
TFO_PLATFORM_VERSION=1.4.0

# PostgreSQL
POSTGRES_VERSION=16-alpine
POSTGRES_DB=telemetryflow_db
POSTGRES_USERNAME=tfo_admin
POSTGRES_PASSWORD=
PORT_POSTGRES=5432

# ClickHouse
CLICKHOUSE_VERSION=latest
CLICKHOUSE_DB=telemetryflow_db
CLICKHOUSE_USER=tfo_admin
CLICKHOUSE_PASSWORD=
PORT_CLICKHOUSE_HTTP=8123
PORT_CLICKHOUSE_NATIVE=9000

# Redis
REDIS_VERSION=7-alpine
REDIS_PASSWORD=
REDIS_MAX_MEMORY=512mb
PORT_REDIS=6379

# NATS
NATS_VERSION=2-alpine
NATS_URL=nats://localhost:4222
NATS_CLUSTER_ID=telemetryflow-cluster
PORT_NATS_CLIENT=4222
PORT_NATS_MONITOR=8222

# TFO-Backend (NestJS API)
NODE_ENV=development
PORT_BACKEND=3000
ENABLE_BULLMQ=true
JWT_SECRET=
JWT_EXPIRES_IN=24h
SESSION_SECRET=
CORS_ORIGIN=http://localhost:8080
LOGGER_TYPE=winston
LOG_PRETTY_PRINT=false
OTEL_SERVICE_NAME=telemetryflow-platform

# TFO-Viz (Frontend)
PORT_FRONTEND=8080


#================================================================================================
# [13] DOCKER COMPOSE / VOLUMES
#================================================================================================
VOLUMES_BASE_PATH=/opt/data/docker/telemetryflow-sdk
VOLUMES_DRIVER=local


#================================================================================================
# [14] SERVICE VERSIONS
#================================================================================================
PYTHON_VERSION=3.12
OTEL_PYTHON_SDK_VERSION=1.42.1
OTEL_PYTHON_INSTRUMENTATION_VERSION=0.63b1


#================================================================================================
# [15] CONTAINER NAMES
#================================================================================================
# SDK Services
CONTAINER_NAME=telemetryflow_sdk_gen
CONTAINER_NAME_RESTAPI=telemetryflow_sdk_restapi
CONTAINER_NAME_DEV=telemetryflow_sdk_dev

# Monitoring Services
CONTAINER_OTEL=telemetryflow_sdk_tfo_collector
CONTAINER_PROMETHEUS=telemetryflow_sdk_prometheus

# Platform Services
CONTAINER_POSTGRES=telemetryflow_sdk_postgres
CONTAINER_CLICKHOUSE=telemetryflow_sdk_clickhouse
CONTAINER_REDIS=telemetryflow_sdk_redis
CONTAINER_NATS=telemetryflow_sdk_nats
CONTAINER_BACKEND=telemetryflow_sdk_backend
CONTAINER_FRONTEND=telemetryflow_sdk_frontend


#================================================================================================
# [16] PORT MAPPINGS
#================================================================================================
# TFO-Collector (OTLP)
PORT_OTEL_GRPC=4317
PORT_OTEL_HTTP=4318
PORT_OTEL_METRICS=8889
PORT_OTEL_HEALTH=13133
PORT_OTEL_ZPAGES=55679
PORT_OTEL_PPROF=1777


#================================================================================================
# [17] STATIC IP ADDRESSES (Docker internal networking)
#================================================================================================
# Network Subnet: 172.153.0.0/16 (Python SDK uses 172.153.x.x, Go SDK uses 172.152.x.x, Platform uses 172.151.x.x)

# SDK Services
CONTAINER_IP_SDK_GEN=172.153.152.10
CONTAINER_IP_SDK_DEV=172.153.152.11

# Monitoring Services
CONTAINER_IP_OTEL=172.153.152.30
CONTAINER_IP_PROMETHEUS=172.153.152.70

# Platform Services
CONTAINER_IP_POSTGRES=172.153.153.20
CONTAINER_IP_CLICKHOUSE=172.153.153.40
CONTAINER_IP_REDIS=172.153.153.50
CONTAINER_IP_NATS=172.153.153.55
CONTAINER_IP_BACKEND=172.153.153.10
CONTAINER_IP_FRONTEND=172.153.153.15


#================================================================================================
# [18] APP SETTINGS (for SDK examples)
#================================================================================================
APP_PORT=8080
APP_DEBUG=false


#================================================================================================
# [19] DATABASE (for RESTful API generator)
#================================================================================================
DB_DRIVER=postgresql
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=


#================================================================================================
# [20] SECURITY (for RESTful API generator)
#================================================================================================
SECRET_KEY=
JWT_SECRET_KEY=
JWT_EXPIRES=3600


#================================================================================================
# [21] RESOURCE LIMITS (for Docker deployments)
#================================================================================================
MEMORY_LIMIT=512M
CPU_LIMIT=1.0


#================================================================================================
# PRODUCTION DEPLOYMENT CHECKLIST
#================================================================================================
#
# [ ] TELEMETRYFLOW_API_KEY_ID / TELEMETRYFLOW_API_KEY_SECRET set to valid platform keys
# [ ] TELEMETRYFLOW_ENVIRONMENT set to production
# [ ] TELEMETRYFLOW_INSECURE set to false (enable TLS)
# [ ] SECRET_KEY / JWT_SECRET_KEY changed from defaults
# [ ] JWT_SECRET / SESSION_SECRET changed from development defaults
# [ ] POSTGRES_PASSWORD / CLICKHOUSE_PASSWORD changed from defaults
# [ ] TELEMETRYFLOW_ENDPOINT points to production collector
# [ ] TELEMETRYFLOW_BACKEND_ENDPOINT points to production backend
# [ ] HTTPS/TLS enabled at reverse proxy (nginx/traefik)
# [ ] CORS_ORIGIN set to specific trusted domains (no wildcard)
# [ ] Resource limits configured appropriately
#
#================================================================================================