@kabran-tecnologia/kabran-config 1.6.0 → 1.7.0

package/templates/telemetry/.env.telemetry.example

@@ -0,0 +1,118 @@
+# =============================================================================
+# Kabran Telemetry Configuration
+# =============================================================================
+# All variables are optional. Defaults are shown in comments.
+# Copy this file to your project and rename to .env or .env.local
+#
+# Documentation: https://github.com/kabran-owner/kabran-config#telemetry
+
+# =============================================================================
+# Core Configuration
+# =============================================================================
+
+# Enable/disable telemetry (default: true in production, false otherwise)
+# OTEL_ENABLED=true
+
+# Service name (REQUIRED for telemetry to work)
+# SERVICE_NAME=my-service
+
+# Service version (default: 1.0.0)
+# SERVICE_VERSION=1.0.0
+
+# Environment name (default: from NODE_ENV)
+# ENVIRONMENT=production
+
+# Service namespace for grouping (default: kabran)
+# OTEL_NAMESPACE=kabran
+# SERVICE_NAMESPACE=kabran
+
+# =============================================================================
+# OTLP Exporter Configuration
+# =============================================================================
+
+# OTLP collector endpoint (default: https://otel.kabran.com.br)
+# OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.kabran.com.br
+# OTEL_ENDPOINT=https://otel.kabran.com.br
+
+# Traces endpoint path (default: /v1/traces)
+# OTEL_EXPORTER_OTLP_TRACES_PATH=/v1/traces
+
+# Export timeout in milliseconds
+# Node.js (default: 10000)
+# OTEL_EXPORTER_OTLP_TIMEOUT=10000
+# Edge/Serverless (default: 5000)
+# OTEL_EXPORTER_OTLP_TIMEOUT_EDGE=5000
+
+# Sampling rate 0.0-1.0 (default: 0.1 = 10%)
+# OTEL_SAMPLE_RATE=0.1
+
+# =============================================================================
+# BatchSpanProcessor - Node.js
+# =============================================================================
+# Used for long-running processes (servers, workers)
+
+# Maximum spans in queue before dropping (default: 2048)
+# OTEL_BSP_MAX_QUEUE_SIZE=2048
+
+# Maximum spans per export batch (default: 512)
+# OTEL_BSP_MAX_EXPORT_BATCH_SIZE=512
+
+# Delay between exports in milliseconds (default: 5000)
+# OTEL_BSP_SCHEDULE_DELAY=5000
+
+# =============================================================================
+# BatchSpanProcessor - Frontend
+# =============================================================================
+# Optimized for browser environments (smaller batches, faster flush)
+
+# Maximum spans in queue (default: 100)
+# OTEL_BSP_MAX_QUEUE_SIZE_FRONTEND=100
+
+# Maximum spans per export batch (default: 10)
+# OTEL_BSP_MAX_EXPORT_BATCH_SIZE_FRONTEND=10
+
+# Delay between exports in milliseconds (default: 500)
+# OTEL_BSP_SCHEDULE_DELAY_FRONTEND=500
+
+# =============================================================================
+# Frontend Instrumentation
+# =============================================================================
+
+# CORS URLs for trace header propagation (comma-separated regex patterns)
+# Default: .*\.supabase\.co,.*\.kabran\.com\.br,localhost
+# OTEL_PROPAGATE_TRACE_HEADER_CORS_URLS=.*\.supabase\.co,.*\.kabran\.com\.br,localhost
+
+# User interaction events to trace (comma-separated)
+# Default: click,submit
+# OTEL_USER_INTERACTION_EVENTS=click,submit
+
+# =============================================================================
+# Middleware Configuration (Node.js)
+# =============================================================================
+
+# Paths to ignore in telemetry middleware (comma-separated)
+# Default: /health,/ready,/metrics
+# OTEL_IGNORE_PATHS=/health,/ready,/metrics
+
+# =============================================================================
+# Error Response Configuration (Edge)
+# =============================================================================
+
+# Error message for unhandled errors (default: Internal server error)
+# OTEL_ERROR_MESSAGE=Internal server error
+
+# Error code for unhandled errors (default: INTERNAL_ERROR)
+# OTEL_ERROR_CODE=INTERNAL_ERROR
+
+# =============================================================================
+# Logger Configuration
+# =============================================================================
+
+# Trace ID display length in logs (default: 8)
+# OTEL_LOG_TRACE_ID_LENGTH=8
+
+# Disable ANSI colors in logs (set to any value to disable)
+# NO_COLOR=1
+
+# Force enable/disable colors (overrides NO_COLOR)
+# FORCE_COLOR=true