pytbox 0.0.6__tar.gz → 0.0.9__tar.gz

pytbox-0.0.9/MANIFEST.in

@@ -0,0 +1,15 @@
+# 包含所有模板文件
+recursive-include src/pytbox/categraf/jinja2 *.j2
+recursive-include src/pytbox/categraf *.toml
+
+# 包含文档文件
+include README.md
+
+# 包含配置文件
+include pyproject.toml
+
+# 排除缓存和临时文件
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude .git*
+global-exclude .DS_Store

{pytbox-0.0.6 → pytbox-0.0.9}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.0.6
+Version: 0.0.9
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
-License: MIT
+License-Expression: MIT
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: requests>=2.0

{pytbox-0.0.6 → pytbox-0.0.9}/pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytbox"
-version = "0.0.6"
+version = "0.0.9"
 description = "A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)"
 authors = [{ name = "mingming hou", email = "houm01@foxmail.com" }]
-license = { text = "MIT" }
+license = "MIT"
 readme = "README.md"
 requires-python = ">=3.8"
 
@@ -34,5 +34,8 @@ cli = [
     "toml>=0.10.0",  # TOML 输出支持
 ]
 
+[tool.setuptools]
+include-package-data = true
+
 [tool.setuptools.packages.find]
 where = ["src"]

pytbox-0.0.9/src/pytbox/categraf/build_config.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python3
+
+import os
+from pathlib import Path
+from pytbox.utils.load_config import load_config_by_file
+
+from jinja2 import Environment, FileSystemLoader
+
+
+jinja2_path = Path(__file__).parent / 'jinja2'
+env = Environment(loader=FileSystemLoader(jinja2_path))
+
+ping_template = env.get_template('input.ping/ping.toml.j2')
+prometheus_template = env.get_template('input.prometheus/prometheus.toml.j2')
+
+
+class BuildConfig:
+    '''
+    生成配置
+
+    Args:
+        instances (_type_): _description_
+        output_dir (_type_): _description_
+    '''
+    def __init__(self, instances, output_dir):
+        self.instances = load_config_by_file(instances)
+        self.output_dir = output_dir
+    
+    def _get_template(self, template_name):
+        return env.get_template(template_name)
+
+    def common(self, input_name):
+        template = self._get_template(f'input.{input_name}/{input_name}.toml.j2')
+        render_data = template.render()
+        target_dir = Path(self.output_dir) / f'input.{input_name}'
+        if not target_dir.exists():
+            target_dir.mkdir(parents=True, exist_ok=True)
+            
+        with open(Path(self.output_dir) / f'input.{input_name}' / f'{input_name}.toml', 'w', encoding='utf-8') as f:
+            f.write(render_data)
+
+    def ping(self):
+        instances = self.instances['ping']['instance']
+        render_data = ping_template.render(instances=instances)
+        target_dir = Path(self.output_dir) / 'input.ping'
+        if not target_dir.exists():
+            target_dir.mkdir(parents=True, exist_ok=True)
+            
+        with open(Path(self.output_dir) / 'input.ping' / 'ping.toml', 'w', encoding='utf-8') as f:
+            f.write(render_data)
+
+    def prometheus(self):
+        instances = self.instances['prometheus']['urls']
+        render_data = prometheus_template.render(instances=instances)
+        target_dir = Path(self.output_dir) / 'input.prometheus'
+        if not target_dir.exists():
+            target_dir.mkdir(parents=True, exist_ok=True)
+        with open(Path(self.output_dir) / 'input.prometheus' / 'prometheus.toml', 'w', encoding='utf-8') as f:
+            f.write(render_data)
+
+    def vsphere(self):
+        template = self._get_template('input.vsphere/vsphere.toml.j2')
+        instances = self.instances['vsphere']['instance']
+        print(instances)
+        render_data = template.render(instances=instances)
+        target_dir = Path(self.output_dir) / 'input.vsphere'
+        if not target_dir.exists():
+            target_dir.mkdir(parents=True, exist_ok=True)
+        with open(Path(self.output_dir) / 'input.vsphere' / 'vsphere.toml', 'w', encoding='utf-8') as f:
+            f.write(render_data)
+
+    def http_response(self):
+        template = self._get_template('input.http_response/http_response.toml.j2')
+        instances = self.instances['http_response']['instance']
+        render_data = template.render(instances=instances)
+        target_dir = Path(self.output_dir) / 'input.http_response'
+        if not target_dir.exists():
+            target_dir.mkdir(parents=True, exist_ok=True)
+        with open(Path(self.output_dir) / 'input.http_response' / 'http_response.toml', 'w', encoding='utf-8') as f:
+            f.write(render_data)
+            
+    def run(self):
+        # self.common('cpu')
+        # self.common('mem')
+        # self.common('net')
+        # self.common('disk')
+        # self.common('diskio')
+        # self.vsphere()
+        # self.ping()
+        # self.prometheus()   
+        self.http_response()

pytbox-0.0.9/src/pytbox/categraf/instances.toml

@@ -0,0 +1,16 @@
+[ping]
+[[ping.instance]]
+"10.1.1.1" = { name = "x", env = "prod" }
+"10.1.1.2" = { name = "demo02", env = "dev" }
+
+[prometheus]
+[[prometheus.urls]]
+"http://10.200.12.202:9100" = { name = "x", env = "prod" }
+
+[vsphere]
+[[vsphere.instance]]
+"test" = { vcenter = "https://10.1.1.1/sdk", username = "categraf@vsphere.local", password = "xxx" }
+
+[http_response]
+[[http_response.instance]]
+"https://www.baidu.com" = { name = "x", env = "prod" }

pytbox-0.0.9/src/pytbox/categraf/jinja2/__init__.py

@@ -0,0 +1,6 @@
+"""
+Categraf Jinja2 模板文件包
+"""
+
+# 这个文件确保 jinja2 目录被 Python 识别为包
+# 这样模板文件就会被包含在安装包中

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.cpu/cpu.toml.j2

@@ -0,0 +1,5 @@
+# # collect interval
+# interval = 15
+
+# # whether collect per cpu
+# collect_per_cpu = false

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.disk/disk.toml.j2

@@ -0,0 +1,11 @@
+# # collect interval
+# interval = 15
+
+# # By default stats will be gathered for all mount points.
+# # Set mount_points will restrict the stats to only the specified mount points.
+# mount_points = ["/"]
+
+# Ignore mount points by filesystem type.
+ignore_fs = ["tmpfs", "devtmpfs", "devfs", "iso9660", "overlay", "aufs", "squashfs", "nsfs", "CDFS", "fuse.juicefs"]
+
+ignore_mount_points = ["/boot", "/var/lib/kubelet/pods"]

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.diskio/diskio.toml.j2

@@ -0,0 +1,6 @@
+# # collect interval
+# interval = 15
+
+# # By default, categraf will gather stats for all devices including disk partitions.
+# # Setting devices will restrict the stats to the specified devices.
+# devices = ["sda", "sdb", "vd*"]

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.http_response/http_response.toml.j2

@@ -0,0 +1,9 @@
+{% for instance in instances %}
+{% for target, labels in instance.items() %}
+[[instances]]
+targets = [
+    "{{ target }}"
+]
+labels = { {% for k, v in labels.items() %}{% if not loop.first %}, {% endif %}{% if k.isidentifier() %}{{ k }}{% else %}"{{ k }}"{% endif %} = "{{ v }}"{% endfor %} }
+{% endfor %}
+{% endfor %}

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.mem/mem.toml.j2

@@ -0,0 +1,5 @@
+# # collect interval
+# interval = 15
+
+# # whether collect platform specified metrics
+collect_platform_fields = true

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.net/net.toml.j2

@@ -0,0 +1,11 @@
+# # collect interval
+# interval = 15
+
+# # whether collect protocol stats on Linux
+# collect_protocol_stats = false
+
+# # setting interfaces will tell categraf to gather these explicit interfaces
+# interfaces = ["eth0"]
+ 
+# enable_loopback_stats=true
+# enable_link_down_stats=true

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.ping/ping.toml.j2

@@ -0,0 +1,11 @@
+{% for instance in instances %}
+{% for target, labels in instance.items() %}
+[[instances]]
+targets = [
+    "{{ target }}"
+]
+method = "exec"
+count = 3
+labels = { {% for k, v in labels.items() %}{% if not loop.first %}, {% endif %}{% if k.isidentifier() %}{{ k }}{% else %}"{{ k }}"{% endif %} = "{{ v }}"{% endfor %} }
+{% endfor %}
+{% endfor %}

pytbox-0.0.9/src/pytbox/categraf/jinja2/input.prometheus/prometheus.toml.j2

@@ -0,0 +1,12 @@
+{% for instance in instances %}
+{% for instance, labels in instance.items() %}
+[[instances]]
+urls = [
+    "{{ instance }}"
+]
+
+url_label_key = "instance"
+url_label_value = "{{ '{{.Host}}' }}"
+labels = { {% for k, v in labels.items() %}{% if not loop.first %}, {% endif %}{% if k.isidentifier() %}{{ k }}{% else %}"{{ k }}"{% endif %} = "{{ v }}"{% endfor %} }
+{% endfor %}
+{% endfor %}

pytbox-0.0.9/src/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-0.0.6 → pytbox-0.0.9}/src/pytbox.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.0.6
+Version: 0.0.9
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
-License: MIT
+License-Expression: MIT
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: requests>=2.0

{pytbox-0.0.6 → pytbox-0.0.9}/src/pytbox.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+MANIFEST.in
 README.md
 pyproject.toml
 src/pytbox/base.py
@@ -15,6 +16,19 @@ src/pytbox/alert/alert_handler.py
 src/pytbox/alert/ping.py
 src/pytbox/alicloud/sls.py
 src/pytbox/categraf/build_config.py
+src/pytbox/categraf/instances.toml
+src/pytbox/categraf/jinja2/__init__.py
+src/pytbox/categraf/jinja2/input.cpu/cpu.toml.j2
+src/pytbox/categraf/jinja2/input.disk/disk.toml.j2
+src/pytbox/categraf/jinja2/input.diskio/diskio.toml.j2
+src/pytbox/categraf/jinja2/input.dns_query/dns_query.toml.j2
+src/pytbox/categraf/jinja2/input.http_response/http_response.toml.j2
+src/pytbox/categraf/jinja2/input.mem/mem.toml.j2
+src/pytbox/categraf/jinja2/input.net/net.toml.j2
+src/pytbox/categraf/jinja2/input.net_response/net_response.toml.j2
+src/pytbox/categraf/jinja2/input.ping/ping.toml.j2
+src/pytbox/categraf/jinja2/input.prometheus/prometheus.toml.j2
+src/pytbox/categraf/jinja2/input.vsphere/vsphere.toml.j2
 src/pytbox/cli/__init__.py
 src/pytbox/cli/main.py
 src/pytbox/cli/categraf/__init__.py

pytbox-0.0.6/src/pytbox/categraf/build_config.py

@@ -1,53 +0,0 @@
-#!/usr/bin/env python3
-
-import os
-from pathlib import Path
-from pytbox.utils.load_config import load_config_by_file
-
-from jinja2 import Environment, FileSystemLoader
-
-
-jinja2_path = Path(__file__).parent / 'jinja2'
-env = Environment(loader=FileSystemLoader(jinja2_path))
-
-ping_template = env.get_template('input.ping/ping.toml.j2')
-prometheus_template = env.get_template('input.prometheus/prometheus.toml.j2')
-
-
-class BuildConfig:
-    '''
-    生成配置
-
-    Args:
-        instances (_type_): _description_
-        output_dir (_type_): _description_
-    '''
-    def __init__(self, instances, output_dir):
-        self.instances = load_config_by_file(instances)
-        self.output_dir = output_dir
-    
-    
-    
-    def ping(self):
-        instances = self.instances['ping']['instance']
-        render_data = ping_template.render(instances=instances)
-        target_dir = Path(self.output_dir) / 'input.ping'
-        if not target_dir.exists():
-            target_dir.mkdir(parents=True, exist_ok=True)
-            
-        with open(Path(self.output_dir) / 'input.ping' / 'ping.toml', 'w', encoding='utf-8') as f:
-            f.write(render_data)
-
-    def prometheus(self):
-        instances = self.instances['prometheus']['urls']
-        render_data = prometheus_template.render(instances=instances)
-        target_dir = Path(self.output_dir) / 'input.prometheus'
-        if not target_dir.exists():
-            target_dir.mkdir(parents=True, exist_ok=True)
-            
-        with open(Path(self.output_dir) / 'input.prometheus' / 'prometheus.toml', 'w', encoding='utf-8') as f:
-            f.write(render_data)
-
-    def run(self):
-        # self.ping()
-        self.prometheus()