启动api时检查配置项

Author: sunminghui

api.py

@@ -18,9 +18,12 @@
 from biz.utils.queue import handle_queue
 from biz.utils.reporter import Reporter
 
+from biz.utils.config_checker import check_config
 load_dotenv("conf/.env")
 api_app = Flask(__name__)
 
+
+
 PUSH_REVIEW_ENABLED = os.environ.get('PUSH_REVIEW_ENABLED', '0') == '1'
 
 
@@ -196,6 +199,7 @@ def handle_gitlab_webhook(data):
         return jsonify(error_message), 400
 
 if __name__ == '__main__':
+    check_config()
     # 启动定时任务调度器
     setup_scheduler()
 

biz/llm/client/base.py

@@ -2,11 +2,21 @@
 from typing import List, Dict, Optional
 
 from biz.llm.types import NotGiven, NOT_GIVEN
+from biz.utils.log import logger
 
 
 class BaseClient:
     """ Base class for chat models client. """
 
+    def ping(self) -> bool:
+        """Ping the model to check connectivity."""
+        try:
+            result = self.completions(messages=[{"role": "user", "content": '请仅返回 "ok"。'}])
+            return result and result == 'ok'
+        except Exception:
+            logger.error("尝试连接LLM失败， {e}")
+            return False
+
     @abstractmethod
     def completions(self,
                     messages: List[Dict[str, str]],

biz/llm/factory.py

@@ -21,7 +21,6 @@ def getClient(provider: str = None) -> BaseClient:
 
         provider_func = chat_model_providers.get(provider)
         if provider_func:
-            logger.info(f"Successfully loaded LLM provider: {provider}")
             return provider_func()
         else:
             raise Exception(f'Unknown chat model provider: {provider}')

biz/utils/config_checker.py

@@ -0,0 +1,72 @@
+import os
+
+from dotenv import load_dotenv
+
+from biz.llm.factory import Factory
+from biz.utils.log import logger
+
+# 指定环境变量文件路径
+ENV_FILE_PATH = "conf/.env"
+load_dotenv(ENV_FILE_PATH)
+
+
+REQUIRED_ENV_VARS = [
+    "LLM_PROVIDER",
+]
+
+# 允许的 LLM 供应商
+LLM_PROVIDERS = {"zhipuai", "openai", "deepseek", "ollama"}
+
+# 每种供应商必须配置的键
+LLM_REQUIRED_KEYS = {
+    "zhipuai": ["ZHIPUAI_API_KEY", "ZHIPUAI_API_MODEL"],
+    "openai": ["OPENAI_API_KEY", "OPENAI_API_MODEL"],
+    "deepseek": ["DEEPSEEK_API_KEY", "DEEPSEEK_API_MODEL"],
+    "ollama": ["OLLAMA_API_BASE_URL", "OLLAMA_API_MODEL"],
+}
+
+
+def check_env_vars():
+    """检查环境变量"""
+    missing_vars = [var for var in REQUIRED_ENV_VARS if var not in os.environ]
+    if missing_vars:
+        logger.warning(f"缺少环境变量: {', '.join(missing_vars)}")
+    else:
+        logger.info("所有必要的环境变量均已设置。")
+
+
+def check_llm_provider():
+    """检查 LLM 供应商的配置"""
+    llm_provider = os.getenv("LLM_PROVIDER")
+
+    if not llm_provider:
+        logger.error("LLM_PROVIDER 未设置！")
+        return
+
+    if llm_provider not in LLM_PROVIDERS:
+        logger.error(f"LLM_PROVIDER 值错误，应为 {LLM_PROVIDERS} 之一。")
+        return
+
+    required_keys = LLM_REQUIRED_KEYS.get(llm_provider, [])
+    missing_keys = [key for key in required_keys if not os.getenv(key)]
+
+    if missing_keys:
+        logger.error(f"当前 LLM 供应商为 {llm_provider}，但缺少必要的环境变量: {', '.join(missing_keys)}")
+    else:
+        logger.info(f"LLM 供应商 {llm_provider} 的配置项已设置。")
+
+def check_llm_connectivity():
+    client = Factory().getClient()
+    logger.info(f"正在检查 LLM 供应商的连接...")
+    if client.ping():
+        logger.info("LLM 可以连接成功。")
+    else:
+        logger.error("LLM连接可能有问题，请检查配置项。")
+
+def check_config():
+    """主检查入口"""
+    logger.info("开始检查配置项...")
+    check_env_vars()
+    check_llm_provider()
+    check_llm_connectivity()
+    logger.info("配置项检查完成。")