Bỏ qua

Config Module (hierachain/config/*)

Tổng quan

Module Config là trung tâm điều khiển của HieraChain, chịu trách nhiệm quản lý hàng trăm tham số vận hành, đảm bảo tính bảo mật của các khóa bí mật và cung cấp cơ chế ghi log chuẩn hóa cho cả môi trường phát triển và vận hành thực tế.

Các thành phần cốt lõi

  • Settings Management

    File: settings.py

    • Hệ thống cấu hình dựa trên môi trường (HRC_ENV).
    • Tự động kiểm chứng (validation) tính hợp lệ của tham số.
    • Phân tách cấu hình theo nhóm: Blockchain, Consensus, Storage, P2P, v.v.

  • Secret Manager

    File: secret_manager.py

    • Truy xuất bí mật (secrets) độc lập với hạ tầng.
    • Hỗ trợ backends: Environment, HashiCorp Vault, AWS Secrets Manager.
    • Tự động fallback linh hoạt.

  • Structured Logging

    File: logging.py

    • Định dạng Text cho lập trình viên (màu sắc, dễ đọc).
    • Định dạng JSON cho môi trường Production (phù hợp với ELK, Cloud Logging).
    • Hỗ trợ nhúng Request ID để truy vết lỗi.

Quản lý cấu hình theo môi trường

HieraChain sử dụng biến môi trường HRC_ENV để tự động chuyển đổi giữa các cấu hình tối ưu:

Môi trường Giá trị HRC_ENV Đặc điểm chính
Development dev (Mặc định) Log level DEBUG, lưu trữ SQLite/Memory, cho phép CORS từ mọi nơi.
Production product Ép buộc xác thực (Auth), HSTS, P2P Strict Trust, log định dạng JSON.
Testing test Cấu hình cực nhanh, block size nhỏ, mặc định lưu trữ Memory.

Secret Manager (Quản lý Bí mật)

Đây là thành phần quan trọng để bảo vệ các khóa nhạy cảm như HRC_CLUSTER_SECRET hoặc IPFS_ENCRYPTION_KEY.

Ví dụ sử dụng trong mã nguồn:

from hierachain.config.secret_manager import SecretManager

sm = SecretManager()
# Tự động lấy từ Vault, AWS hoặc Env tùy theo cấu hình
cluster_key = sm.get_secret("HRC_CLUSTER_SECRET")

Backends hỗ trợ:

  1. Environment (env): Mặc định, đọc trực tiếp từ biến môi trường.
  2. Vault (vault): Kết nối tới HashiCorp Vault KV v2.
  3. AWS (aws): Kết nối tới AWS Secrets Manager.

Ghi log chuẩn hóa (Observability)

Bạn có thể thay đổi định dạng log thông qua biến môi trường HRC_LOG_FORMAT:

  • Dành cho Dev (text): 

    INFO  hierachain.api.server  Starting HieraChain Node on localhost:2661...

  • Dành cho Ops (json): 

    {"timestamp": "2024-03-20T10:00:00", "level": "INFO", "logger": "hierachain.api", "message": "Node started", "request_id": "abc-123"}

Kiểm chứng cấu hình (Validation)

HieraChain thực hiện kiểm tra cấu hình ngay khi khởi động để tránh các lỗi vận hành tiềm ẩn:

  • validate_config(): Kiểm tra các giá trị logic (ví dụ: Port phải từ 1-65535, Block size > 0).
  • check_security_config(): Cảnh báo nếu các thiết lập bảo mật trong môi trường Production không đủ an toàn (ví dụ: Tắt Auth hoặc bật CORS-all).

Liên quan