pytbox 0.0.2__tar.gz → 0.0.3__tar.gz

{pytbox-0.0.2 → pytbox-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.0.2
+Version: 0.0.3
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
 License: MIT

{pytbox-0.0.2 → pytbox-0.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytbox"
-version = "0.0.2"
+version = "0.0.3"
 description = "A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)"
 authors = [{ name = "mingming hou", email = "houm01@foxmail.com" }]
 license = { text = "MIT" }

pytbox-0.0.3/src/pytbox/alert/alert_handler.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python3
+
+
+import uuid
+from typing import Literal
+from ..database.mongo import Mongo
+from ..base import MongoClient
+from ..feishu.client import Client as FeishuClient
+from ..dida365 import Dida365
+from ..utils.timeutils import TimeUtils
+
+
+class AlertHandler:
+    
+    def __init__(self, 
+                 config: dict=None,
+                 mongo_client: Mongo=MongoClient(collection='alert'),
+                 feishu_client: FeishuClient=None,
+                 dida_client: Dida365=None
+            ):
+        self.config = config
+        self.mongo = mongo_client
+        self.feishu = feishu_client
+        self.dida = dida_client
+
+    def send_alert(self, 
+                 event_id: str=None,
+                 event_type: Literal['trigger', 'resolved'] ='trigger',
+                 event_time: str=None,
+                 event_name: str=None,
+                 event_content: str=None,
+                 entity_name: str=None,
+                 priority: Literal['critical', 'high', 'warning']='high',
+                 resolved_expr: str=None,
+                 suggestion: str='',
+                 troubleshot: str='暂无',
+                 mongo_id: str=None
+                ):
+        
+        if not event_id:
+            event_id = str(uuid.uuid4())
+        if not event_time:
+            event_time = TimeUtils.get_now_time_mongo()
+    
+        if self.mongo.check_alarm_exist(event_type=event_type, event_content=event_content):
+            if event_type == "trigger":
+                self.mongo.collection.insert_one(
+                    {
+                        'event_id': event_id,
+                        'event_type': event_type,
+                        'event_name': event_name,
+                        'event_time': event_time,
+                        'event_content': event_content,
+                        'entity_name': entity_name,
+                        'priority': priority,
+                        'resolved_expr': resolved_expr,
+                        'suggestion': suggestion,
+                        'troubleshot': troubleshot,
+                    }
+                )
+            elif event_type == "resolved":
+                filter_doc = {"_id": mongo_id}
+                update = {"$set": { "resolved_time": event_time}}
+                self.mongo.collection.update_one(filter_doc, update)
+                alarm_time = self.mongo.collection.find_one(filter_doc, {'event_time': 1})['event_time']
+    
+            content = [
+                f'**事件名称**: {event_name}',
+                f'**告警时间**: {TimeUtils.convert_timeobj_to_str(timeobj=event_time, timezone_offset=0) if event_type == "trigger" else TimeUtils.convert_timeobj_to_str(timeobj=alarm_time, timezone_offset=8)}',
+                f'**事件内容**: {event_content}',
+                f'**告警实例**: {entity_name}',
+                f'**建议**: {suggestion}',
+                f'**故障排查**: {troubleshot}'
+            ]
+            
+            if event_type == "resolved":
+                content.insert(2, f'**恢复时间**: {TimeUtils.convert_timeobj_to_str(event_time, timezone_offset=0)}')
+    
+            if self.config['feishu']['enable_alert']:
+                self.feishu.extensions.send_message_notify(
+                    color='red' if event_type == "trigger" else 'green',
+                    title=event_content,
+                    priority=priority,
+                    sub_title="",
+                    content='\n'.join(content)
+                )
+            
+            if self.config['dida']['enable_alert']:
+                if event_type == "trigger":
+                    res = self.dida.task_create(
+                        
+                        project_id=self.config['dida']['alert_project_id'],
+                        title=event_content,
+                        content='\n'.join(content),
+                        tags=['L-监控告警', priority]
+                    )
+                    dida_task_id = res.data.get("id")
+                    self.mongo.collection.update_one(
+                        {
+                            "event_id": event_id
+                        },
+                        {
+                            "$set": {
+                                "dida_task_id": dida_task_id
+                            }
+                        }
+                    )
+                else:
+                    task_id = self.mongo.collection.find_one(filter_doc, {'dida_task_id': 1})['dida_task_id']
+                    self.dida.task_update(
+                        task_id=task_id,
+                        project_id=self.config['dida']['alert_project_id'], 
+                        content=f'\n**恢复时间**: {TimeUtils.convert_timeobj_to_str(timeobj=event_time, timezone_offset=0)}'
+                    )
+                    self.dida.task_complete(task_id=task_id, project_id=self.config['dida']['alert_project_id'])
+                    
+                
+            if self.config['wecom']['enable']:
+                pass

pytbox-0.0.3/src/pytbox/alert/ping.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+
+
+from ..database.victoriametrics import VictoriaMetrics
+from ..lib.load_config import load_config
+
+
+def ping(config, target):
+    vm = VictoriaMetrics(url=config['victoriametrics']['url'])
+    ping_status = vm.query_ping_status(target=target, last_minutes=config['alert']['ping']['last_minutes'])
+    if ping_status == '不通':
+        insert_alert(
+            event_name=config['alert']['ping']['event_name'],
+            event_content=f"{target} {config['alert']['ping']['event_name']}",
+            entity_name=target,
+            priority=config['alert']['ping']['priority'],
+            resolved_query={
+                "target": target
+            }
+        )
+
+
+if __name__ == "__main__":
+    config = load_config()
+    ping(config, "10.30.35.38")

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox/alicloud/sls.py

@@ -20,14 +20,6 @@ class AliCloudSls:
         self.logstore = logstore
 
     def get_logs(self, project_name, logstore_name, query, from_time, to_time): 
-        # Project名称。
-        # project_name = "sh-prod-network-devices-log"
-        # Logstore名称
-        # logstore_name = "sh-prod-network-devices-log"
-        # 查询语句。
-        # query = "*| select dev,id from " + logstore_name
-        # query = "*"
-        # 索引。
         logstore_index = {'line': {
             'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t',
                     '\r'], 'caseSensitive': False, 'chn': False}, 'keys': {'dev': {'type': 'text',

pytbox-0.0.3/src/pytbox/base.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+
+
+from pytbox.database.mongo import Mongo
+from pytbox.utils.load_config import load_config_by_file
+from pytbox.database.victoriametrics import VictoriaMetrics
+from pytbox.feishu.client import Client as FeishuClient
+from pytbox.dida365 import Dida365
+
+
+def MongoClient(collection, config_path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=None):
+    config = load_config_by_file(path=config_path, oc_vault_id=oc_vault_id)
+    return Mongo(
+        host=config['mongo']['host'],
+        port=config['mongo']['port'],
+        username=config['mongo']['username'],
+        password=config['mongo']['password'],
+        auto_source=config['mongo']['auto_source'],
+        db_name=config['mongo']['db_name'],
+        collection=collection
+    )
+
+def vm_client(config_path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=None):
+    config = load_config_by_file(path=config_path, oc_vault_id=oc_vault_id)
+    return VictoriaMetrics(
+        url=config['victoriametrics']['url']
+    )
+
+def feishu_client(config_path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=None):
+    config = load_config_by_file(path=config_path, oc_vault_id=oc_vault_id)
+    return FeishuClient(
+        app_id=config['feishu']['app_id'],
+        app_secret=config['feishu']['app_secret']
+    )
+
+def dida_client(config_path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=None):
+    config = load_config_by_file(path=config_path, oc_vault_id=oc_vault_id)
+    return Dida365(
+        cookie=config['dida']['cookie'],
+        access_token=config['dida']['access_token']
+    )

pytbox-0.0.3/src/pytbox/database/mongo.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+
+import pymongo
+
+
+class Mongo:
+    '''
+    当前主要使用的类
+    '''
+    def __init__(self, host, port, username, password, auto_source, db_name: str='automate', collection: str=None):
+        self.client = self._create_client(host, port, username, password, auto_source)
+        self.collection = self.client[db_name][collection]
+    
+    def _create_client(self, host, port, username, password, auto_source):
+        '''
+        创建客户端
+        '''
+        return pymongo.MongoClient(host=host,
+                    port=port,
+                    username=username,
+                    password=password,
+                    authSource=auto_source)
+    
+    
+    def check_alarm_exist(self, event_type, event_content) -> bool:
+        '''
+        _summary_
+
+        Args:
+            event_content (_type_): 告警内容
+
+        Returns:
+            bool: 如果为 True, 表示允许插入告警
+        '''
+        if event_type == 'trigger':
+            query = { "event_content": event_content }
+            fields = {"event_name": 1, "event_time": 1, "resolved_time": 1}
+            result = self.collection.find(query, fields).sort({ "_id": pymongo.DESCENDING }).limit(1)
+            if self.collection.count_documents(query) == 0:
+                return True
+            else:
+                for doc in result:
+                    if 'resolved_time' in doc:
+                        # 当前没有告警, 可以插入数据
+                        return True
+        elif event_type == 'resolved':
+            return True
+
+    def query_alert_not_resolved(self, event_name: str=None):
+        query = {
+            "$or": [
+                {"resolved_time": { "$exists": False }}
+            ]
+        }
+        if event_name:
+            query['event_name'] = event_name
+        return self.collection.find(query)
+

pytbox-0.0.3/src/pytbox/database/victoriametrics.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+
+import requests
+from ..utils.response import ReturnResponse
+
+
+class VictoriaMetrics:
+    
+    def __init__(self, url: str='', timeout: int=3) -> None:
+        self.url = url
+        self.timeout = timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        })
+        
+    def query(self, query: str) -> ReturnResponse:
+        '''
+        查询指标数据
+        
+        Args:
+            query (str): 查询语句
+            
+        Returns:
+            dict: 查询结果
+        '''
+        url = f"{self.url}/prometheus/api/v1/query"
+        r = requests.get(
+            url, 
+            timeout=self.timeout,
+            params={"query": query}
+        )
+        if r.json().get("status") == "success":
+            if r.json()['data']['result']:
+                return ReturnResponse(code=0, msg=f"[{query}] 查询成功!", data=r.json()['data']['result'])
+            else:
+                return ReturnResponse(code=2, msg=f"[{query}] 没有查询到结果", data=r.json())
+        else:
+            return ReturnResponse(code=1, msg=f"[{query}] 查询失败: {r.json().get('error')}", data=r.json())
+    
+    def check_ping_result(self, target: str, last_minute: int=10) -> ReturnResponse:
+        '''
+        检查ping结果
+        '''
+        if target:
+            # 这里需要在字符串中保留 {}，同时插入 target，可以用双大括号转义
+            query = f"ping_result_code{{target='{target}'}}"
+        else:
+            query = "ping_result_code"
+        
+        if last_minute:
+            query = query + f"[{last_minute}m]"
+        
+        r = self.query(query=query)
+        if r.code == 0:
+            values = r.data[0]['values']
+            if len(values) == 2 and values[1] == "0":
+                code = 0
+                msg = f"已检查 {target} 最近 {last_minute} 分钟是正常的!"
+            else:
+                if all(str(item[1]) == "1" for item in values):
+                    code = 2
+                    msg = f"已检查 {target} 最近 {last_minute} 分钟是异常的!"
+                else:
+                    code = 0
+                    msg = f"已检查 {target} 最近 {last_minute} 分钟是正常的!"
+        elif r.code == 2:
+            code = 2
+            msg = f"没有查询到 {target} 最近 {last_minute} 分钟的ping结果!"
+        
+        try:
+            data = r.data[0]
+        except KeyError:
+            data = r.data
+        
+        return ReturnResponse(code=code, msg=msg, data=data)

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox/dida365.py

@@ -28,14 +28,8 @@ class Task:
     completed_time: str
     assignee: int
 
-@dataclass
-class DidaResponse:
-    code: int
-    message: str
-    data: dict
-
 
-class ProcessDidaResponse:    
+class ProcessReturnResponse:    
     @staticmethod
     def status(status):
         if status == 0:
@@ -89,7 +83,7 @@ class Dida365:
         }
         self.timeout = 10
 
-    def request(self, api_url: str=None, method: str='GET', payload: dict={}):
+    def request(self, api_url: str=None, method: str='GET', payload: dict={}) -> ReturnResponse:
         """发送请求。
         
         Args:
@@ -108,14 +102,14 @@ class Dida365:
         
         if response.status_code == 200:
             if 'complete' in api_url:
-                return DidaResponse(code=0, msg='success', data=None)
+                return ReturnResponse(code=0, msg='success', data=None)
             else:
                 try:
-                    return DidaResponse(code=0, msg='success', data=response.json())
-                except Exception as e:
-                    return DidaResponse(code=1, msg='warning', data=response)
+                    return ReturnResponse(code=0, msg='success', data=response.json())
+                except Exception:
+                    return ReturnResponse(code=1, msg='warning', data=response)
         else:
-            return DidaResponse(code=1, msg='error', data=response.json())
+            return ReturnResponse(code=1, msg='error', data=response.json())
 
     def task_list(self, project_id: str, enhancement: bool=True):
         """获取任务列表。
@@ -142,8 +136,8 @@ class Dida365:
                         desc=task.get('desc'),
                         start_date=task.get('startDate'),
                         due_date=task.get('dueDate'),
-                        priority=ProcessDidaResponse.priority(task.get('priority')),
-                        status=ProcessDidaResponse.status(task.get('status')),
+                        priority=ProcessReturnResponse.priority(task.get('priority')),
+                        status=ProcessReturnResponse.status(task.get('status')),
                         tags=task.get('tags'),
                         completed_time=task.get('completedTime'),
                         assignee=task.get('assignee'))
@@ -157,8 +151,8 @@ class Dida365:
                         desc=task.get('desc'),
                         start_date=task.get('startDate'),
                         due_date=task.get('dueDate'),
-                        priority=ProcessDidaResponse.priority(task.get('priority')),
-                        status=ProcessDidaResponse.status(task.get('status')),
+                        priority=ProcessReturnResponse.priority(task.get('priority')),
+                        status=ProcessReturnResponse.status(task.get('status')),
                         tags=task.get('tags'),
                         completed_time=task.get('completedTime'),
                         assignee=task.get('assignee'))

pytbox-0.0.3/src/pytbox/utils/load_config.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+
+
+try:
+    import toml
+except ImportError:
+    import tomllib as toml  # Python 3.11+ fallback
+from pytbox.onepassword_connect import OnePasswordConnect
+
+
+def _replace_1password_values(data, oc):
+    """
+    递归处理配置数据，替换 1password 和 password 开头的值
+    
+    Args:
+        data: 配置数据（dict, list, str 等）
+        oc: OnePasswordConnect 实例
+    
+    Returns:
+        处理后的数据
+    """
+    if isinstance(data, dict):
+        result = {}
+        for k, v in data.items():
+            result[k] = _replace_1password_values(v, oc)
+        return result
+    elif isinstance(data, list):
+        return [_replace_1password_values(item, oc) for item in data]
+    elif isinstance(data, str):
+        # 处理 1password,item_id,field_name 格式
+        if data.startswith("1password,"):
+            parts = data.split(",")
+            if len(parts) >= 3:
+                item_id = parts[1]
+                field_name = parts[2]
+                # 通过 item_id 获取项目，然后从字段中提取对应值
+                item = oc.get_item(item_id)
+                for field in item.fields:
+                    if field.label == field_name:
+                        return field.value
+                return data  # 如果找不到字段，返回原始值
+        # 处理 password,item_id,field_name 格式  
+        elif data.startswith("password,"):
+            parts = data.split(",")
+            if len(parts) >= 3:
+                item_id = parts[1]
+                field_name = parts[2]
+                # 通过 item_id 获取项目，然后从字段中提取对应值
+                item = oc.get_item(item_id)
+                for field in item.fields:
+                    if field.label == field_name:
+                        return field.value
+                return data  # 如果找不到字段，返回原始值
+        return data
+    else:
+        return data
+
+
+def load_config_by_file(path: str='/workspaces/pytbox/src/pytbox/alert/config/config.toml', oc_vault_id: str=None) -> dict:
+    '''
+    从文件加载配置，支持 1password 集成
+    
+    Args:
+        path (str, optional): 配置文件路径. Defaults to '/workspaces/pytbox/src/pytbox/alert/config/config.toml'.
+        oc_vault_id (str, optional): OnePassword vault ID，如果提供则启用 1password 集成
+        
+    Returns:
+        dict: 配置字典
+    '''
+    with open(path, 'r', encoding='utf-8') as f:
+        if path.endswith('.toml'):
+            config = toml.load(f)
+        else:
+            # 如果不是 toml 文件，假设是其他格式，这里可以扩展
+            import json
+            config = json.load(f)
+            
+        if oc_vault_id:
+            oc = OnePasswordConnect(vault_id=oc_vault_id)
+            config = _replace_1password_values(config, oc)
+            
+        return config
+
+
+if __name__ == "__main__":
+    print(load_config_by_file(path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id="hcls5uxuq5dmxorw6rfewefdsa"))

pytbox-0.0.3/src/pytbox/utils/ping_checker.py

@@ -0,0 +1 @@
+ 

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox/utils/response.py

@@ -21,7 +21,7 @@ class ReturnResponse:
             8 - 服务不可用 (SERVICE_UNAVAILABLE)
             9 - 数据库错误 (DATABASE_ERROR)
             10 - 网络错误 (NETWORK_ERROR)
-        message: 响应消息描述
+        msg: 响应消息描述
         data: 响应数据，可以是任意类型
     """
     code: int = 0

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox/utils/timeutils.py

@@ -4,6 +4,7 @@
 import time
 import pytz
 import datetime
+from typing import Literal
 
 
 class TimeUtils:
@@ -37,4 +38,16 @@ class TimeUtils:
     
     @staticmethod
     def get_utc_time():
-        return datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+        return datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+    
+    @staticmethod
+    def get_now_time_mongo():
+        return datetime.datetime.now(pytz.timezone('Asia/Shanghai'))
+
+    @staticmethod
+    def convert_timeobj_to_str(timeobj: str=None, timezone_offset: int=8, time_format: Literal['%Y-%m-%d %H:%M:%S', '%Y-%m-%dT%H:%M:%SZ']='%Y-%m-%d %H:%M:%S'):
+        time_obj_with_offset = timeobj + datetime.timedelta(hours=timezone_offset)
+        if time_format == '%Y-%m-%d %H:%M:%S':
+            return time_obj_with_offset.strftime("%Y-%m-%d %H:%M:%S")
+        elif time_format == '%Y-%m-%dT%H:%M:%SZ':
+            return time_obj_with_offset.strftime("%Y-%m-%dT%H:%M:%SZ")

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.0.2
+Version: 0.0.3
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
 License: MIT

{pytbox-0.0.2 → pytbox-0.0.3}/src/pytbox.egg-info/SOURCES.txt

@@ -1,25 +1,31 @@
 README.md
 pyproject.toml
+src/pytbox/base.py
 src/pytbox/dida365.py
-src/pytbox/logger.py
 src/pytbox/onepassword_connect.py
 src/pytbox/onepassword_sa.py
-src/pytbox/victorialog.py
-src/pytbox/victoriametrics.py
 src/pytbox.egg-info/PKG-INFO
 src/pytbox.egg-info/SOURCES.txt
 src/pytbox.egg-info/dependency_links.txt
 src/pytbox.egg-info/requires.txt
 src/pytbox.egg-info/top_level.txt
+src/pytbox/alert/alert_handler.py
+src/pytbox/alert/ping.py
 src/pytbox/alicloud/sls.py
 src/pytbox/common/__init__.py
 src/pytbox/common/base.py
+src/pytbox/database/mongo.py
+src/pytbox/database/victoriametrics.py
 src/pytbox/feishu/client.py
 src/pytbox/feishu/endpoints.py
 src/pytbox/feishu/errors.py
 src/pytbox/feishu/helpers.py
 src/pytbox/feishu/typing.py
+src/pytbox/log/logger.py
+src/pytbox/log/victorialog.py
 src/pytbox/utils/env.py
+src/pytbox/utils/load_config.py
+src/pytbox/utils/ping_checker.py
 src/pytbox/utils/response.py
 src/pytbox/utils/timeutils.py
 tests/test_feishu.py

pytbox-0.0.2/src/pytbox/victoriametrics.py

@@ -1,37 +0,0 @@
-#!/usr/bin/env python3
-
-import requests
-from .utils.response import ReturnResponse
-
-
-class VictoriaMetrics:
-    
-    def __init__(self, url: str='', timeout: int=3) -> None:
-        self.url = url
-        self.timeout = timeout
-        self.session = requests.Session()
-        self.session.headers.update({
-            'Content-Type': 'application/json',
-            'Accept': 'application/json'
-        })
-        
-    def query(self, query: str) -> ReturnResponse:
-        '''
-        查询指标数据
-        
-        Args:
-            query (str): 查询语句
-            
-        Returns:
-            dict: 查询结果
-        '''
-        url = f"{self.url}/prometheus/api/v1/query"
-        r = requests.get(
-            url, 
-            timeout=self.timeout,
-            params={"query": query}
-        )
-        if r.json().get("status") == "success":
-            return ReturnResponse(code=0, msg=f"[{query}] 查询成功!", data=r.json()['data']['result'])
-        else:
-            return ReturnResponse(code=1, msg=f"[{query}] 查询失败: {r.json().get('error')}", data=r.json())