ObservaKit/.env.example at main · willowvibe/ObservaKit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# =============================================================================
# ObservaKit — Environment Configuration
# Copy this file: cp .env.example .env
# =============================================================================

# --- API Security ---
# Set to enable API key authentication (leave blank to disable in dev)
OBSERVAKIT_API_KEY=

# --- CORS Origins ---
# Comma-separated list of allowed origins
CORS_ORIGINS=http://localhost:3000,http://localhost:8000

# --- Metadata Store (internal Postgres for ObservaKit) ---
METADATA_DB_HOST=postgres
METADATA_DB_PORT=5432
METADATA_DB_USER=observakit
METADATA_DB_PASSWORD=your_secure_password_here
METADATA_DB_NAME=observakit

# --- Target Warehouse (the warehouse you're monitoring) ---
# Supported: postgres, bigquery, snowflake
WAREHOUSE_TYPE=postgres
WAREHOUSE_HOST=host.docker.internal
WAREHOUSE_PORT=5432
WAREHOUSE_USER=your_user
WAREHOUSE_PASSWORD=your_warehouse_password
WAREHOUSE_DB=your_database
WAREHOUSE_SCHEMA=public

# BigQuery (uncomment if using BigQuery)
# BIGQUERY_PROJECT=your-gcp-project
# BIGQUERY_DATASET=your_dataset
# BIGQUERY_CREDENTIALS_PATH=/app/config/bigquery-credentials.json

# Snowflake (uncomment if using Snowflake)
# SNOWFLAKE_ACCOUNT=your_account
# SNOWFLAKE_USER=your_user
# SNOWFLAKE_PASSWORD=your_password
# SNOWFLAKE_WAREHOUSE=your_warehouse
# SNOWFLAKE_DATABASE=your_database
# SNOWFLAKE_SCHEMA=public

# --- Airflow ---
AIRFLOW_BASE_URL=http://localhost:8080
AIRFLOW_USERNAME=admin
AIRFLOW_PASSWORD=your_airflow_password

# --- Prefect (uncomment if using Prefect) ---
# PREFECT_API_URL=http://localhost:4200/api

# --- Alerting: Slack ---
SLACK_WEBHOOK_URL=<your-slack-webhook-url>
SLACK_CHANNEL=#data-alerts

# --- Alerting: Email (SMTP) ---
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your_email@gmail.com
SMTP_PASSWORD=your_app_password
ALERT_EMAIL_FROM=observakit@yourcompany.com
ALERT_EMAIL_TO=data-team@yourcompany.com

# --- Service Ports ---
BACKEND_PORT=8000
GRAFANA_PORT=3000
PROMETHEUS_PORT=9090

# --- Scheduler ---
# Intervals in minutes
FRESHNESS_CHECK_INTERVAL=15
VOLUME_CHECK_INTERVAL=60
SCHEMA_CHECK_INTERVAL=360
QUALITY_CHECK_INTERVAL=60