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

pytbox/categraf/jinja2/input.vsphere/vsphere.toml.j2

@@ -0,0 +1,211 @@
+# # collect interval
+# interval = 15
+
+# Read metrics from one or many vCenters
+{% for instance in instances %}
+{% for name, vcenter_info in instance.items() %}
+[[instances]]
+vcenter = "{{ vcenter_info['vcenter'] }}"
+username = "{{ vcenter_info['username'] }}" 
+password = "{{ vcenter_info['password'] }}"
+
+  cluster_metric_exlcude = ["*"]
+  ## VMs
+  ## Typical VM metrics (if omitted or empty, all metrics are collected)
+  # vm_include = [ "/*/vm/**"] # Inventory path to VMs to collect (by default all are collected)
+  # vm_exclude = [] # Inventory paths to exclude
+  vm_metric_include = [
+    # "config.hardware.numCPU",
+    # "config.hardware.memoryMB",
+    "cpu.demand.average",
+    "cpu.idle.summation",
+    "cpu.latency.average",
+    "cpu.readiness.average",
+    "cpu.ready.summation",
+    "cpu.run.summation",
+    "cpu.usagemhz.average",
+    "cpu.usage.average",
+    "cpu.used.summation",
+    "cpu.wait.summation",
+    "mem.active.average",
+    "mem.granted.average",
+    "mem.latency.average",
+    "mem.swapin.average",
+    "mem.swapinRate.average",
+    "mem.swapout.average",
+    "mem.swapoutRate.average",
+    "mem.usage.average",
+    "mem.vmmemctl.average",
+    "net.bytesRx.average",
+    "net.bytesTx.average",
+    "net.droppedRx.summation",
+    "net.droppedTx.summation",
+    "net.usage.average",
+    "power.power.average",
+    "virtualDisk.numberReadAveraged.average",
+    "virtualDisk.numberWriteAveraged.average",
+    "virtualDisk.read.average",
+    "virtualDisk.readOIO.latest",
+    "virtualDisk.throughput.usage.average",
+    "virtualDisk.totalReadLatency.average",
+    "virtualDisk.totalWriteLatency.average",
+    "virtualDisk.write.average",
+    "virtualDisk.writeOIO.latest",
+    "sys.uptime.latest",
+  ]
+  # vm_metric_exclude = [] ## Nothing is excluded by default
+  # vm_instances = true ## true by default
+
+  ## Hosts
+  ## Typical host metrics (if omitted or empty, all metrics are collected)
+  # host_include = [ "/*/host/**"] # Inventory path to hosts to collect (by default all are collected)
+  # host_exclude [] # Inventory paths to exclude
+  host_metric_include = [
+    "cpu.coreUtilization.average",
+    "cpu.costop.summation",
+    "cpu.demand.average",
+    "cpu.idle.summation",
+    "cpu.latency.average",
+    "cpu.readiness.average",
+    "cpu.ready.summation",
+    "cpu.swapwait.summation",
+    "cpu.usage.average",
+    "cpu.usagemhz.average",
+    "cpu.used.summation",
+    "cpu.utilization.average",
+    "cpu.wait.summation",
+    "disk.deviceReadLatency.average",
+    "disk.deviceWriteLatency.average",
+    "disk.kernelReadLatency.average",
+    "disk.kernelWriteLatency.average",
+    "disk.numberReadAveraged.average",
+    "disk.numberWriteAveraged.average",
+    "disk.read.average",
+    "disk.totalReadLatency.average",
+    "disk.totalWriteLatency.average",
+    "disk.write.average",
+    "mem.active.average",
+    "mem.latency.average",
+    "mem.state.latest",
+    "mem.swapin.average",
+    "mem.swapinRate.average",
+    "mem.swapout.average",
+    "mem.swapoutRate.average",
+    "mem.totalCapacity.average",
+    "mem.usage.average",
+    "mem.vmmemctl.average",
+    "net.bytesRx.average",
+    "net.bytesTx.average",
+    "net.droppedRx.summation",
+    "net.droppedTx.summation",
+    "net.errorsRx.summation",
+    "net.errorsTx.summation",
+    "net.usage.average",
+    "power.power.average",
+    "storageAdapter.numberReadAveraged.average",
+    "storageAdapter.numberWriteAveraged.average",
+    "storageAdapter.read.average",
+    "storageAdapter.write.average",
+    "sys.uptime.latest",
+  ]
+
+
+  # host_instances = true ## true by default
+  # host_include = [] ## Nothing included by default
+  # host_exclude = [] ## Nothing excluded by default
+  # host_metric_include = [] ## Nothing included by default
+  # host_metric_exclude = [] ## Nothing excluded by default
+
+
+  ## Clusters
+  # cluster_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected)
+  # cluster_exclude = [] # Inventory paths to exclude
+  # cluster_metric_include = [] ## if omitted or empty, all metrics are collected
+  # cluster_metric_exclude = [] ## Nothing excluded by default
+  # cluster_instances = false ## false by default
+
+  ## Resource Pools
+  # resoucepool_include = [ "/*/host/**"] # Inventory path to datastores to collect (by default all are collected)
+  # resoucepool_exclude = [] # Inventory paths to exclude
+  # resoucepool_metric_include = [] ## if omitted or empty, all metrics are collected
+  # resoucepool_metric_exclude = [] ## Nothing excluded by default
+  # resoucepool_instances = false ## false by default
+
+  ## Datastores
+  # datastore_include = [ "/*/datastore/**"] # Inventory path to datastores to collect (by default all are collected)
+  # datastore_exclude = [] # Inventory paths to exclude
+  # datastore_metric_include = [] ## if omitted or empty, all metrics are collected
+  # datastore_metric_exclude = [] ## Nothing excluded by default
+  # datastore_instances = false ## false by default
+
+  ## Datacenters
+  # datacenter_include = [ "/*/host/**"] # Inventory path to clusters to collect (by default all are collected)
+  # datacenter_exclude = [] # Inventory paths to exclude
+  # datacenter_metric_include = [] ## if omitted or empty, all metrics are collected
+  # datacenter_metric_exclude = [ "*" ] ## Datacenters are not collected by default.
+  # datacenter_instances = false ## false by default
+
+  ## Plugin Settings
+  ## separator character to use for measurement and field names (default: "_")
+  # separator = "_"
+
+   ## Collect IP addresses? Valid values are "ipv4" and "ipv6"
+  # ip_addresses = ["ipv6", "ipv4" ]
+
+  ## When set to true, all samples are sent as integers. This makes the output
+  ## data types backwards compatible with Telegraf 1.9 or lower. Normally all
+  ## samples from vCenter, with the exception of percentages, are integer
+  ## values, but under some conditions, some averaging takes place internally in
+  ## the plugin. Setting this flag to "false" will send values as floats to
+  ## preserve the full precision when averaging takes place.
+  # use_int_samples = true
+
+  ## Custom attributes from vCenter can be very useful for queries in order to slice the
+  ## metrics along different dimension and for forming ad-hoc relationships. They are disabled
+  ## by default, since they can add a considerable amount of tags to the resulting metrics. To
+  ## enable, simply set custom_attribute_exclude to [] (empty set) and use custom_attribute_include
+  ## to select the attributes you want to include.
+  ## By default, since they can add a considerable amount of tags to the resulting metrics. To
+  ## enable, simply set custom_attribute_exclude to [] (empty set) and use custom_attribute_include
+  ## to select the attributes you want to include.
+  # custom_attribute_include = []
+  # custom_attribute_exclude = ["*"]
+
+
+  ## The number of vSphere 5 minute metric collection cycles to look back for non-realtime metrics. In
+  ## some versions (6.7, 7.0 and possible more), certain metrics, such as cluster metrics, may be reported
+  ## with a significant delay (>30min). If this happens, try increasing this number. Please note that increasing
+  ## it too much may cause performance issues.
+  # metric_lookback = 3
+
+  ## number of objects to retrieve per query for realtime resources (vms and hosts)
+  ## set to 64 for vCenter 5.5 and 6.0 (default: 256)
+  # max_query_objects = 256
+
+  ## number of metrics to retrieve per query for non-realtime resources (clusters and datastores)
+  ## set to 64 for vCenter 5.5 and 6.0 (default: 256)
+  # max_query_metrics = 256
+
+  ## number of go routines to use for collection and discovery of objects and metrics
+  # collect_concurrency = 1
+  # discover_concurrency = 1
+
+  ## the interval before (re)discovering objects subject to metrics collection (default: 300s)
+  # object_discovery_interval = "300s"
+
+  ## timeout applies to any of the api request made to vcenter
+  # timeout = "60s"
+
+  ## Optional SSL Config
+  use_tls = true
+  # tls_ca = "/path/to/cafile"
+  # tls_cert = "/path/to/certfile"
+  # tls_key = "/path/to/keyfile"
+  ## Use SSL but skip chain & host verification
+  insecure_skip_verify = true
+
+  ## The Historical Interval value must match EXACTLY the interval in the daily
+  # "Interval Duration" found on the VCenter server under Configure > General > Statistics > Statistic intervals
+  # historical_interval = "5m"
+{% endfor %}
+{% endfor %}

pytbox/cli/__init__.py

@@ -0,0 +1,7 @@
+"""
+Pytbox CLI 包
+"""
+
+from .main import main
+
+__all__ = ['main']

pytbox/cli/categraf/__init__.py

@@ -0,0 +1,7 @@
+"""
+Categraf CLI 模块
+"""
+
+from .commands import categraf_group
+
+__all__ = ['categraf_group']

pytbox/cli/categraf/commands.py

@@ -0,0 +1,55 @@
+"""
+Categraf 相关命令 - 支持 rich 美化输出
+"""
+
+import shutil
+from pathlib import Path
+import click
+from ...utils.richutils import RichUtils
+from ...categraf.build_config import BuildConfig
+
+
+
+rich_utils = RichUtils()
+
+
+@click.group()
+def categraf_group():
+    """Categraf 配置管理工具"""
+    pass
+
+
+@categraf_group.command('get-instances')
+@click.option('--output-dir', '-o', type=click.Path(exists=True), default='.')
+def get_instances(output_dir):
+    """获取 Categraf 实例配置"""
+    instances_template_path = Path(__file__).parent.parent.parent / 'categraf' / 'instances.toml'
+    dest_path = Path(output_dir) / 'instances.toml'
+    shutil.copy(instances_template_path, dest_path)
+    rich_utils.print(msg=f'已将 {instances_template_path} 复制到 {dest_path}', style='info')
+
+
+@categraf_group.command('build-config')
+@click.option('--instances', '-i', type=click.Path(exists=True), default='.')
+@click.option('--output-dir', '-o', type=click.Path(exists=True), default='.')
+def build_config(instances, output_dir):
+    '''
+    生成配置
+
+    Args:
+        instances (_type_): _description_
+        output_dir (_type_): _description_
+    '''
+    # ping_template_path = Path(__file__).parent.parent.parent / 'categraf' / 'ping.toml'
+    # dest_path = Path(output_dir) / 'ping.toml'
+    # shutil.copy(ping_template_path, dest_path)
+    # rich_utils.print(msg=f'已将 {ping_template_path} 复制到 {dest_path}', style='info')
+    # 获取 instances 和 output_dir 的绝对路径
+    instances_abs = str(Path(instances).resolve())
+    output_dir_abs = str(Path(output_dir).resolve())
+    
+    rich_utils.print(msg=f'instances 绝对路径: {instances_abs}', style='info')
+    rich_utils.print(msg=f'output_dir 绝对路径: {output_dir_abs}', style='info')
+
+    build_config = BuildConfig(instances_abs, output_dir_abs)
+    build_config.run()

pytbox/cli/commands/vm.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+import click
+from pytbox.database.victoriametrics import VictoriaMetrics
+from pytbox.utils.richutils import RichUtils
+
+rich_utils = RichUtils()
+
+@click.group()
+def vm_group():
+    """VictoriaMetrics 查询工具"""
+    pass
+
+
+@vm_group.command('query')
+@click.option('--url', '-u', type=str, required=True)
+@click.option('--query', '-q', type=str, required=True)
+def query(url, query):
+    """查询 VM 数据"""
+    vm_client = VictoriaMetrics(url=url)
+    r = vm_client.query(query, output_format='json')
+    rich_utils.print(msg=r)

pytbox/cli/common/__init__.py

@@ -0,0 +1,6 @@
+"""
+CLI 通用模块
+"""
+
+from .options import *
+from .utils import *

pytbox/cli/common/options.py

@@ -0,0 +1,42 @@
+"""
+通用的 Click 选项定义
+"""
+
+import click
+
+# 通用选项
+output_option = click.option(
+    '--output', '-o', 
+    type=click.Path(), 
+    help='输出到文件'
+)
+
+format_option = click.option(
+    '--format', 'output_format',
+    type=click.Choice(['toml', 'json', 'yaml']),
+    default='toml',
+    help='输出格式'
+)
+
+data_option = click.option(
+    '--data', '-d',
+    help='JSON 格式的模板变量'
+)
+
+data_file_option = click.option(
+    '--data-file',
+    type=click.Path(exists=True),
+    help='包含模板变量的 JSON 文件'
+)
+
+verbose_option = click.option(
+    '--verbose', '-v',
+    is_flag=True,
+    help='显示详细信息'
+)
+
+quiet_option = click.option(
+    '--quiet', '-q',
+    is_flag=True,
+    help='静默模式，只显示错误'
+)

pytbox/cli/common/utils.py

@@ -0,0 +1,269 @@
+"""
+CLI 通用工具函数 - 集成 rich 支持
+"""
+
+import json
+from pathlib import Path
+from typing import Optional, Dict, Any, Union
+
+try:
+    from rich.console import Console
+
+    from rich.panel import Panel
+    from rich.table import Table
+    from rich.progress import track
+    from rich.syntax import Syntax
+    from rich.tree import Tree
+    RICH_AVAILABLE = True
+except ImportError:
+    RICH_AVAILABLE = False
+
+# 如果 rich 不可用，使用标准输出
+import click
+
+
+class Logger:
+    """增强的日志器，支持 rich 格式化输出"""
+    
+    def __init__(self, verbose: bool = False, quiet: bool = False):
+        self.verbose = verbose
+        self.quiet = quiet
+        
+        if RICH_AVAILABLE:
+            self.console = Console()
+        else:
+            self.console = None
+    
+    def info(self, message: str, style: str = "info"):
+        """信息日志"""
+        if self.quiet:
+            return
+            
+        if RICH_AVAILABLE:
+            if style == "success":
+                self.console.print(f"✅ {message}", style="bold green")
+            elif style == "warning":
+                self.console.print(f"⚠️  {message}", style="bold yellow")
+            elif style == "error":
+                self.console.print(f"❌ {message}", style="bold red")
+            else:
+                self.console.print(f"ℹ️  {message}", style="bold blue")
+        else:
+            click.echo(message)
+    
+    def success(self, message: str):
+        """成功日志"""
+        self.info(message, "success")
+    
+    def warning(self, message: str):
+        """警告日志"""
+        self.info(message, "warning")
+    
+    def error(self, message: str):
+        """错误日志"""
+        if RICH_AVAILABLE:
+            self.console.print(f"❌ {message}", style="bold red", err=True)
+        else:
+            click.echo(f"错误: {message}", err=True)
+    
+    def debug(self, message: str):
+        """调试日志"""
+        if self.verbose:
+            if RICH_AVAILABLE:
+                self.console.print(f"🔍 {message}", style="dim")
+            else:
+                click.echo(f"DEBUG: {message}")
+    
+    def print_panel(self, content: str, title: str = "", style: str = "info"):
+        """打印面板"""
+        if self.quiet:
+            return
+            
+        if RICH_AVAILABLE:
+            if style == "success":
+                panel_style = "green"
+            elif style == "warning":
+                panel_style = "yellow"
+            elif style == "error":
+                panel_style = "red"
+            else:
+                panel_style = "blue"
+                
+            panel = Panel(content, title=title, border_style=panel_style)
+            self.console.print(panel)
+        else:
+            if title:
+                click.echo(f"=== {title} ===")
+            click.echo(content)
+    
+    def print_table(self, data: list, headers: list, title: str = ""):
+        """打印表格"""
+        if self.quiet:
+            return
+            
+        if RICH_AVAILABLE:
+            table = Table(title=title, show_header=True, header_style="bold magenta")
+            
+            for header in headers:
+                table.add_column(header)
+            
+            for row in data:
+                table.add_row(*[str(cell) for cell in row])
+            
+            self.console.print(table)
+        else:
+            if title:
+                click.echo(f"=== {title} ===")
+            click.echo("\t".join(headers))
+            for row in data:
+                click.echo("\t".join(str(cell) for cell in row))
+    
+    def print_syntax(self, code: str, language: str = "toml", title: str = ""):
+        """打印语法高亮的代码"""
+        if self.quiet:
+            return
+            
+        if RICH_AVAILABLE:
+            syntax = Syntax(code, language, theme="monokai", line_numbers=True)
+            if title:
+                panel = Panel(syntax, title=title, border_style="blue")
+                self.console.print(panel)
+            else:
+                self.console.print(syntax)
+        else:
+            if title:
+                click.echo(f"=== {title} ===")
+            click.echo(code)
+
+
+# 全局日志器实例
+logger = Logger()
+
+
+def set_logger_config(verbose: bool = False, quiet: bool = False):
+    """设置日志器配置"""
+    global logger
+    logger = Logger(verbose=verbose, quiet=quiet)
+
+
+def handle_error(error: Exception):
+    """统一的错误处理"""
+    logger.error(str(error))
+
+
+def write_output(content: str, output_path: Optional[str] = None, content_type: str = "text"):
+    """统一的输出处理"""
+    if output_path:
+        try:
+            output_file = Path(output_path)
+            output_file.parent.mkdir(parents=True, exist_ok=True)
+            
+            with open(output_file, 'w', encoding='utf-8') as f:
+                f.write(content)
+            
+            logger.success(f"内容已保存到: {output_path}")
+            logger.debug(f"文件大小: {len(content)} 字符")
+            
+        except Exception as e:
+            logger.error(f"保存文件失败: {e}")
+            raise
+    else:
+        # 根据内容类型选择合适的显示方式
+        if content_type == "json":
+            logger.print_syntax(content, "json", "JSON 内容")
+        elif content_type == "yaml":
+            logger.print_syntax(content, "yaml", "YAML 内容")
+        elif content_type == "toml":
+            logger.print_syntax(content, "toml", "TOML 内容")
+        elif content_type == "template":
+            logger.print_syntax(content, "jinja2", "模板内容")
+        else:
+            logger.print_panel(content, "输出内容")
+
+
+def load_template_vars(data_str: Optional[str] = None, data_file: Optional[str] = None) -> Dict[str, Any]:
+    """加载模板变量"""
+    template_vars = {}
+    
+    try:
+        if data_file:
+            logger.debug(f"从文件加载变量: {data_file}")
+            with open(data_file, 'r', encoding='utf-8') as f:
+                file_vars = json.load(f)
+                template_vars.update(file_vars)
+                logger.debug(f"从文件加载了 {len(file_vars)} 个变量")
+        
+        if data_str:
+            logger.debug("从命令行加载变量")
+            cli_vars = json.loads(data_str)
+            template_vars.update(cli_vars)
+            logger.debug(f"从命令行加载了 {len(cli_vars)} 个变量")
+        
+        if template_vars:
+            logger.debug(f"总计加载变量: {list(template_vars.keys())}")
+        
+        return template_vars
+        
+    except json.JSONDecodeError as e:
+        raise ValueError(f"JSON 格式错误: {e}")
+    except FileNotFoundError as e:
+        raise FileNotFoundError(f"数据文件不存在: {e}")
+    except Exception as e:
+        raise Exception(f"加载模板变量失败: {e}")
+
+
+def show_progress(items, description: str = "处理中..."):
+    """显示进度条"""
+    if RICH_AVAILABLE and not logger.quiet:
+        return track(items, description=description)
+    else:
+        return items
+
+
+def create_tree_view(data: dict, title: str = "数据结构") -> None:
+    """创建树形视图显示数据"""
+    if logger.quiet:
+        return
+        
+    if RICH_AVAILABLE:
+        tree = Tree(title)
+        
+        def add_dict_to_tree(node, data_dict):
+            for key, value in data_dict.items():
+                if isinstance(value, dict):
+                    child = node.add(f"[bold blue]{key}[/bold blue]")
+                    add_dict_to_tree(child, value)
+                elif isinstance(value, list):
+                    child = node.add(f"[bold green]{key}[/bold green] ({len(value)} items)")
+                    for i, item in enumerate(value):
+                        if isinstance(item, dict):
+                            item_node = child.add(f"[dim]Item {i}[/dim]")
+                            add_dict_to_tree(item_node, item)
+                        else:
+                            child.add(f"[dim]{item}[/dim]")
+                else:
+                    node.add(f"[yellow]{key}[/yellow]: [white]{value}[/white]")
+        
+        add_dict_to_tree(tree, data)
+        logger.console.print(tree)
+    else:
+        # 简单的文本输出
+        logger.info(f"=== {title} ===")
+        
+        def print_dict(data_dict, indent=0):
+            for key, value in data_dict.items():
+                prefix = "  " * indent
+                if isinstance(value, dict):
+                    click.echo(f"{prefix}{key}:")
+                    print_dict(value, indent + 1)
+                elif isinstance(value, list):
+                    click.echo(f"{prefix}{key}: ({len(value)} items)")
+                    for item in value:
+                        if isinstance(item, dict):
+                            print_dict(item, indent + 1)
+                        else:
+                            click.echo(f"{prefix}  - {item}")
+                else:
+                    click.echo(f"{prefix}{key}: {value}")
+        
+        print_dict(data)

pytbox/cli/formatters/__init__.py

@@ -0,0 +1,7 @@
+"""
+输出格式化器模块
+"""
+
+from .output import OutputFormatter
+
+__all__ = ['OutputFormatter']