pytbox 0.0.1__py3-none-any.whl → 0.3.1__py3-none-any.whl

pytbox/cli/formatters/output.py

@@ -0,0 +1,155 @@
+"""
+输出格式化器 - 支持多种格式和 rich 美化
+"""
+
+import json
+from typing import Any, Dict, Union
+from ..common.utils import logger
+
+
+class OutputFormatter:
+    """输出格式化器"""
+    
+    @staticmethod
+    def format_data(data: Union[Dict[str, Any], list], format_type: str = 'toml') -> str:
+        """格式化数据
+        
+        Args:
+            data: 要格式化的数据
+            format_type: 输出格式 ('toml', 'json', 'yaml')
+            
+        Returns:
+            str: 格式化后的字符串
+            
+        Raises:
+            ImportError: 缺少必要的依赖
+            ValueError: 不支持的格式
+        """
+        logger.debug(f"格式化数据为 {format_type} 格式")
+        
+        if format_type == 'json':
+            return OutputFormatter._format_json(data)
+        elif format_type == 'yaml':
+            return OutputFormatter._format_yaml(data)
+        elif format_type == 'toml':
+            return OutputFormatter._format_toml(data)
+        else:
+            raise ValueError(f"不支持的格式: {format_type}")
+    
+    @staticmethod
+    def _format_json(data: Any) -> str:
+        """格式化为 JSON"""
+        try:
+            result = json.dumps(data, indent=2, ensure_ascii=False)
+            logger.debug(f"JSON 格式化完成，长度: {len(result)} 字符")
+            return result
+        except Exception as e:
+            logger.error(f"JSON 格式化失败: {e}")
+            raise
+    
+    @staticmethod
+    def _format_yaml(data: Any) -> str:
+        """格式化为 YAML"""
+        try:
+            import yaml
+            result = yaml.dump(
+                data, 
+                default_flow_style=False, 
+                allow_unicode=True,
+                sort_keys=False,
+                indent=2
+            )
+            logger.debug(f"YAML 格式化完成，长度: {len(result)} 字符")
+            return result
+        except ImportError:
+            error_msg = "需要安装 pyyaml: pip install pyyaml"
+            logger.error(error_msg)
+            raise ImportError(error_msg)
+        except Exception as e:
+            logger.error(f"YAML 格式化失败: {e}")
+            raise
+    
+    @staticmethod
+    def _format_toml(data: Any) -> str:
+        """格式化为 TOML"""
+        try:
+            import toml
+            result = toml.dumps(data)
+            logger.debug(f"TOML 格式化完成，长度: {len(result)} 字符")
+            return result
+        except ImportError:
+            try:
+                # Python 3.11+ 的 tomllib 只能读取，不能写入
+                import tomllib
+                error_msg = "需要安装 toml 库来支持 TOML 输出: pip install toml"
+                logger.error(error_msg)
+                raise ImportError(error_msg)
+            except ImportError:
+                error_msg = "需要安装 toml: pip install toml"
+                logger.error(error_msg)
+                raise ImportError(error_msg)
+        except Exception as e:
+            logger.error(f"TOML 格式化失败: {e}")
+            raise
+    
+    @staticmethod
+    def format_template_list(templates: list) -> str:
+        """格式化模板列表"""
+        if not templates:
+            return "未找到模板文件"
+        
+        logger.debug(f"格式化 {len(templates)} 个模板")
+        
+        # 按文件类型分组
+        groups = {}
+        for template in templates:
+            if '.' in template:
+                ext = template.split('.')[-1]
+                if ext not in groups:
+                    groups[ext] = []
+                groups[ext].append(template)
+            else:
+                if 'other' not in groups:
+                    groups['other'] = []
+                groups['other'].append(template)
+        
+        result = []
+        result.append("可用模板:")
+        
+        for ext, files in sorted(groups.items()):
+            result.append(f"\n{ext.upper()} 模板:")
+            for template in sorted(files):
+                result.append(f"  - {template}")
+        
+        return "\n".join(result)
+    
+    @staticmethod
+    def format_config_summary(config: Dict[str, Any]) -> str:
+        """格式化配置摘要"""
+        logger.debug("生成配置摘要")
+        
+        result = []
+        result.append("配置摘要:")
+        
+        for service, service_config in config.items():
+            result.append(f"\n📊 {service.upper()} 服务:")
+            
+            if isinstance(service_config, dict):
+                for key, value in service_config.items():
+                    if isinstance(value, list):
+                        result.append(f"  {key}: {len(value)} 项")
+                        # 显示前几个项目
+                        for i, item in enumerate(value[:3]):
+                            if isinstance(item, dict):
+                                item_keys = list(item.keys())[:2]  # 只显示前两个键
+                                result.append(f"    - 项目 {i+1}: {item_keys}")
+                            else:
+                                result.append(f"    - {item}")
+                        if len(value) > 3:
+                            result.append(f"    ... 还有 {len(value) - 3} 项")
+                    else:
+                        result.append(f"  {key}: {value}")
+            else:
+                result.append(f"  值: {service_config}")
+        
+        return "\n".join(result)

pytbox/cli/main.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+"""
+Pytbox 主命令行入口
+"""
+
+import click
+from .categraf import categraf_group
+from .commands.vm import vm_group
+
+
+@click.group()
+@click.version_option()
+def main():
+    """Pytbox 命令行工具集合"""
+    pass
+
+
+# 注册子命令组
+main.add_command(categraf_group, name='categraf')
+main.add_command(vm_group, name='vm')
+
+
+if __name__ == "__main__":
+    main()

pytbox/cli.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+"""
+Pytbox 命令行工具 - 入口文件（保持向后兼容）
+"""
+
+from pytbox.cli import main
+
+if __name__ == "__main__":
+    main()

pytbox/database/mongo.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+import pymongo
+from ..utils.timeutils import TimeUtils
+from pytbox.utils import timeutils
+
+class Mongo:
+    '''
+    当前主要使用的类
+    '''
+    def __init__(self, host: str=None, port: int=27017, username: str=None, password: str=None, auto_source: str=None, 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)
+
+    def recent_alerts(self, event_content: str) -> str:
+        '''
+        获取最近 10 次告警
+
+        Args:
+            alarm_content (str): _description_
+
+        Returns:
+            str: _description_
+        '''
+
+        query = {
+            "event_content": event_content,
+            'resolved_time': {
+                '$exists': True,  # 字段必须存在
+            }
+        }
+        fields = {"_id": 0, 'event_time': 1, 'resolved_time': 1}
+        results = self.collection.find(query, fields).sort('event_time', -1)
+        
+        alarm_list = []
+        for result in results:
+            duration_minute = '持续 ' + str(int((result['resolved_time'] - result['event_time']).total_seconds() / 60)) + ' 分钟'
+            alarm_list.append('触发时间: ' + TimeUtils.convert_timeobj_to_str(timeobj=result['event_time']) + ' ' + duration_minute)
+
+        alarm_str = '\n'.join(alarm_list)
+        
+        alarm_str_display_threshold = 10
+        
+        if len(alarm_list) > alarm_str_display_threshold:
+            # 如果告警超过 10 个
+            alarm_counter = alarm_str_display_threshold
+            alarm_str = '\n'.join(alarm_list[:alarm_str_display_threshold])
+        else:
+            # 如果不超过 10 个
+            alarm_counter = len(alarm_list)
+            alarm_str = '\n'.join(alarm_list)
+            
+        return '该告警出现过' + str(len(alarm_list)) + f'次\n最近 {alarm_counter} 次告警如下: \n' + alarm_str
+    

pytbox/database/victoriametrics.py

@@ -0,0 +1,404 @@
+#!/usr/bin/env python3
+
+import time
+import json
+from typing import Literal, Optional, Dict, List
+import requests
+from ..utils.response import ReturnResponse
+from ..utils.load_vm_devfile import load_dev_file
+
+
+class VictoriaMetrics:
+    
+    def __init__(self, url: str='', timeout: int=3, env: str='prod') -> None:
+        self.url = url
+        self.timeout = timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        })
+        self.env = env
+
+    def insert(self, metric_name: str = '', labels: Dict[str, str] = None, 
+               value: List[float] = None, timestamp: int = None) -> ReturnResponse:
+        """插入指标数据。
+        
+        Args:
+            metric_name: 指标名称
+            labels: 标签字典
+            value: 值列表
+            timestamp: 时间戳（毫秒），默认为当前时间
+            
+        Raises:
+            requests.RequestException: 当请求失败时抛出
+        """
+        if labels is None:
+            labels = {}
+        if value is None:
+            value = 1
+        if timestamp is None:
+            timestamp = int(time.time() * 1000)
+            
+        url = f"{self.url}/api/v1/import"
+        data = {
+            "metric": {
+                "__name__": metric_name,
+                **labels
+            },
+            "values": [value],
+            "timestamps": [timestamp]
+        }
+        
+        try:
+            response = requests.post(url, json=data, timeout=self.timeout)
+            return ReturnResponse(code=0, msg=f"数据插入成功，状态码: {response.status_code}, metric_name: {metric_name}, labels: {labels}, value: {value}, timestamp: {timestamp}")
+        except requests.RequestException as e:
+            return ReturnResponse(code=1, msg=f"数据插入失败: {e}")
+
+    def query(self, query: str=None, output_format: Literal['json']=None) -> ReturnResponse:
+        '''
+        查询指标数据
+
+        Args:
+            query (str): 查询语句
+
+        Returns:
+            dict: 查询结果
+        '''
+        url = f"{self.url}/prometheus/api/v1/query"
+        r = requests.get(
+            url, 
+            timeout=self.timeout,
+            params={"query": query}
+        )
+        res_json = r.json()
+        status = res_json.get("status")
+        result = res_json.get("data", {}).get("result", [])
+        is_json = output_format == 'json'
+
+        if status == "success":
+            if result:
+                code = 0
+                msg = f"[{query}] 查询成功!"
+                data = result
+            else:
+                code = 2
+                msg = f"[{query}] 没有查询到结果"
+                data = res_json
+        else:
+            code = 1
+            msg = f"[{query}] 查询失败: {res_json.get('error')}"
+            data = res_json
+
+        resp = ReturnResponse(code=code, msg=msg, data=data)
+
+        if is_json:
+            json_result = json.dumps(resp.__dict__, ensure_ascii=False)
+            return json_result
+        else:
+            return resp
+
+    def query_range(self, query):
+        '''
+        查询指标数据
+
+        Args:
+            query (str): 查询语句
+
+        Returns:
+            dict: 查询结果
+        '''
+        url = f"{self.url}/prometheus/api/v1/query_range"
+
+        data = {
+            'query': query,
+            'start': '-1d',
+            'step': '1h'
+        }
+
+        r = requests.post(url, data=data, timeout=self.timeout)
+        res_json = r.json()
+        print(res_json)
+        # status = res_json.get("status")
+        # result = res_json.get("data", {}).get("result", [])
+        # is_json = output_format == 'json'
+
+        # if status == "success":
+        #     if result:
+        #         code = 0
+        #         msg = f"[{query}] 查询成功!"
+        #         data = result
+        #     else:
+        #         code = 2
+        #         msg = f"[{query}] 没有查询到结果"
+        #         data = res_json
+        # else:
+        #     code = 1
+        #     msg = f"[{query}] 查询失败: {res_json.get('error')}"
+        #     data = res_json
+
+        # resp = ReturnResponse(code=code, msg=msg, data=data)
+
+        # if is_json:
+        #     json_result = json.dumps(resp.__dict__, ensure_ascii=False)
+        #     return json_result
+        # else:
+        #     return resp
+    def get_labels(self, metric_name: str) -> ReturnResponse:
+        url = f"{self.url}/api/v1/series?match[]={metric_name}"
+        response = requests.get(url, timeout=self.timeout)
+        results = response.json()
+        if results['status'] == 'success':
+            return ReturnResponse(code=0, msg=f"metric name: {metric_name} 获取到 {len(results['data'])} 条数据", data=results['data'])
+        else:
+            return ReturnResponse(code=1, msg=f"metric name: {metric_name} 查询失败")
+
+    def check_ping_result(self, target: str, last_minute: int=10, env: str='prod', dev_file: str='') -> ReturnResponse:
+        '''
+        检查ping结果
+
+        Args:
+            target (str): 目标地址
+            last_minute (int, optional): 最近多少分钟. Defaults to 10.
+            env (str, optional): 环境. Defaults to 'prod'.
+            dev_file (str, optional): 开发文件. Defaults to ''.
+
+        Returns:
+            ReturnResponse: 
+                code = 0 正常, code = 1 异常, code = 2 没有查询到数据, 建议将其判断为正常
+        '''
+        query = f'min_over_time(ping_result_code{{target="{target}"}}[{last_minute}m])'
+        # query = f'avg_over_time((ping_result_code{{target="{target}"}})[{last_minute}m])'
+        if self.env == 'dev':
+            r = load_dev_file(dev_file)
+        else:
+            r = self.query(query=query)
+        if r.code == 0:
+            value = r.data[0]['value'][1]
+            if value == '0':
+                return ReturnResponse(code=0, msg=f"已检查 {target} 最近 {last_minute} 分钟是正常的!", data=r.data)
+            else:
+                return ReturnResponse(code=1, msg=f"已检查 {target} 最近 {last_minute} 分钟是异常的!", data=r.data)
+        else:
+            return r
+
+    def check_unreachable_ping_result(self, dev_file: str='') -> ReturnResponse:
+        '''
+        检查ping结果
+
+        Args:
+            target (str): 目标地址
+            last_minute (int, optional): 最近多少分钟. Defaults to 10.
+            env (str, optional): 环境. Defaults to 'prod'.
+            dev_file (str, optional): 开发文件. Defaults to ''.
+
+        Returns:
+            ReturnResponse: 
+                code = 0 正常, code = 1 异常, code = 2 没有查询到数据, 建议将其判断为正常
+        '''
+        query = "ping_result_code == 1"
+        
+        if self.env == 'dev':
+            r = load_dev_file(dev_file)
+        else:
+            r = self.query(query=query)
+        return r
+
+    def check_interface_rate(self,
+                             direction: Literal['in', 'out'],
+                             sysName: str, 
+                             ifName:str, 
+                             last_minutes: Optional[int] = None
+                            ) -> ReturnResponse:
+        """查询指定设备的入方向总流量速率（bps）。
+
+        使用 PromQL 对 `snmp_interface_ifHCInOctets` 进行速率计算并聚合到设备级别，
+        将结果从字节每秒转换为比特每秒（乘以 8）。
+
+        Args:
+            sysName: 设备 `sysName` 标签值。
+            last_minutes: 计算速率的时间窗口（分钟）。未提供时默认使用 5 分钟窗口。
+
+        Returns:
+            ReturnResponse: 查询结果包装。
+        """
+        if direction == 'in':
+            query = f'(rate(snmp_interface_ifHCInOctets{{sysName="{sysName}", ifName="{ifName}"}}[{last_minutes}m])) * 8 / 1000000'
+        else:
+            query = f'(rate(snmp_interface_ifHCOutOctets{{sysName="{sysName}", ifName="{ifName}"}}[{last_minutes}m])) * 8 / 1000000'
+        r = self.query(query)
+        rate = r.data[0]['value'][1]
+        return int(float(rate))
+    
+    def check_interface_avg_rate(self,
+                                 direction: Literal['in', 'out'],
+                                 sysname: str, 
+                                 ifname:str, 
+                                 last_hours: Optional[int] = 24,
+                                 last_minutes: Optional[int] = 5,
+                                ) -> ReturnResponse:
+        '''
+        _summary_
+
+        Args:
+            direction (Literal['in', 'out']): _description_
+            sysname (str): _description_
+            ifname (str): _description_
+            last_hours (Optional[int], optional): _description_. Defaults to 24.
+            last_minutes (Optional[int], optional): _description_. Defaults to 5.
+
+        Returns:
+            ReturnResponse: _description_
+        '''
+        if direction == 'in':
+            query = f'avg_over_time((rate(snmp_interface_ifHCInOctets{{sysName="{sysname}", ifName="{ifname}"}}[{last_minutes}m]) * 8) [{last_hours}h:]) / 1e6'
+        else:
+            query = f'avg_over_time((rate(snmp_interface_ifHCOutOctets{{sysName="{sysname}", ifName="{ifname}"}}[{last_minutes}m]) * 8) [{last_hours}h:]) / 1e6'
+        r = self.query(query)
+        try:
+            rate = r.data[0]['value'][1]
+            return ReturnResponse(code=0, msg=f"查询 {sysname} {ifname} 最近 {last_hours} 小时平均速率为 {round(float(rate), 2)} Mbit/s", data=round(float(rate), 2))
+        except KeyError:
+            return ReturnResponse(code=1, msg=f"查询 {sysname} {ifname} 最近 {last_hours} 小时平均速率为 0 Mbit/s")
+
+    def check_interface_max_rate(self,
+                                 direction: Literal['in', 'out'],
+                                 sysname: str, 
+                                 ifname:str, 
+                                 last_hours: Optional[int] = 24,
+                                 last_minutes: Optional[int] = 5,
+                                ) -> ReturnResponse:
+        '''
+        _summary_
+
+        Args:
+            direction (Literal['in', 'out']): _description_
+            sysname (str): _description_
+            ifname (str): _description_
+            last_hours (Optional[int], optional): _description_. Defaults to 24.
+            last_minutes (Optional[int], optional): _description_. Defaults to 5.
+
+        Returns:
+            ReturnResponse: _description_
+        '''
+        if direction == 'in':
+            query = f'max_over_time((rate(snmp_interface_ifHCInOctets{{sysName="{sysname}", ifName="{ifname}"}}[{last_minutes}m]) * 8) [{last_hours}h:]) / 1e6'
+        else:
+            query = f'max_over_time((rate(snmp_interface_ifHCOutOctets{{sysName="{sysname}", ifName="{ifname}"}}[{last_minutes}m]) * 8) [{last_hours}h:]) / 1e6'
+        r = self.query(query)
+        try:
+            rate = r.data[0]['value'][1]
+            return ReturnResponse(code=0, msg=f"查询 {sysname} {ifname} 最近 {last_hours} 小时最大速率为 {round(float(rate), 2)} Mbit/s", data=round(float(rate), 2))
+        except KeyError:
+            return ReturnResponse(code=1, msg=f"查询 {sysname} {ifname} 最近 {last_hours} 小时最大速率为 0 Mbit/s")
+
+    def check_snmp_port_status(self, sysname: str=None, if_name: str=None, last_minute: int=5, dev_file: str=None) -> ReturnResponse:
+        '''
+        查询端口状态
+        status code 可参考 SNMP 文件 https://mibbrowser.online/mibdb_search.php?mib=IF-MIB
+
+        Args:
+            sysname (_type_): 设备名称
+            if_name (_type_): _description_
+            last_minute (_type_): _description_
+
+        Returns:
+            ReturnResponse: 
+            code: 0, msg: , data: up,down
+        '''
+        q = f"""avg_over_time(snmp_interface_ifOperStatus{{sysName="{sysname}", ifName="{if_name}"}}[{last_minute}m])"""
+        if self.env == 'dev':
+            r = load_dev_file(dev_file)
+        else:
+            r = self.query(query=q)
+        if r.code == 0:
+            status_code = int(r.data[0]['value'][1])
+            if status_code == 1:
+                status = 'up'
+            else:
+                status = 'down'
+            return ReturnResponse(code=0, msg=f"{sysname} {if_name} 最近 {last_minute} 分钟端口状态为 {status}", data=status)
+        else:
+            return r
+
+    def insert_cronjob_run_status(self, 
+                                  app_type: Literal['alert', 'meraki', 'other']='other', 
+                                  app: str='', 
+                                  status_code: Literal[0, 1]=1, 
+                                  comment: str=None, 
+                                  schedule_interval: str=None, 
+                                  schedule_cron: str=None
+                                ) -> ReturnResponse:
+        labels = {
+            "app": app,
+            "env": self.env,
+        }
+        if app_type:
+            labels['app_type'] = app_type
+        if comment:
+            labels['comment'] = comment
+            
+        if schedule_interval:
+            labels['schedule_type'] = 'interval'
+            labels['schedule_interval'] = schedule_interval
+            
+        if schedule_cron:
+            labels['schedule_type'] = 'cron'
+            labels['schedule_cron'] = schedule_cron
+            
+        r = self.insert(metric_name="cronjob_run_status", labels=labels, value=status_code)
+        return r
+    
+    def insert_cronjob_duration_seconds(self, 
+                                        app_type: Literal['alert', 'meraki', 'other']='other', 
+                                        app: str='', 
+                                        duration_seconds: float=None, 
+                                        comment: str=None, 
+                                        schedule_interval: str=None, 
+                                        schedule_cron: str=None
+                                    ) -> ReturnResponse:
+        labels = {
+            "app": app,
+            "env": self.env
+        }
+        if app_type:
+            labels['app_type'] = app_type
+        if comment:
+            labels['comment'] = comment
+
+        if schedule_interval:
+            labels['schedule_type'] = 'interval'
+            labels['schedule_interval'] = schedule_interval
+            
+        if schedule_cron:
+            labels['schedule_type'] = 'cron'
+            labels['schedule_cron'] = schedule_cron
+        r = self.insert(metric_name="cronjob_run_duration_seconds", labels=labels, value=duration_seconds)
+        return r
+    
+    def get_vmware_esxhostnames(self, vcenter: str=None) -> list:
+        '''
+        _summary_
+        '''
+        esxhostnames = []
+        query = f'vsphere_host_sys_uptime_latest{{vcenter="{vcenter}"}}'
+        metrics = self.query(query=query).data
+        for metric in metrics:
+            esxhostname = metric['metric']['esxhostname']
+            esxhostnames.append(esxhostname)
+        return esxhostnames
+    
+    def get_vmware_cpu_usage(self, vcenter: str=None, esxhostname: str=None) -> float:
+        '''
+        _summary_
+        '''
+        query = f'vsphere_host_cpu_usage_average{{vcenter="{vcenter}", esxhostname="{esxhostname}"}}'
+        return self.query(query=query).data[0]['value'][1]
+    
+    def get_vmware_memory_usage(self, vcenter: str=None, esxhostname: str=None) -> float:
+        '''
+        _summary_
+        '''
+        query = f'vsphere_host_mem_usage_average{{vcenter="{vcenter}", esxhostname="{esxhostname}"}}'
+        return self.query(query=query).data[0]['value'][1]