Temboard插件开发指南：为PostgreSQL远程控制平台扩展自定义功能-拓冰建站

Temboard插件开发指南：为PostgreSQL远程控制平台扩展自定义功能

【免费下载链接】temboardPostgreSQL Remote Control项目地址: https://gitcode.com/gh_mirrors/te/temboard

Temboard是一款强大的PostgreSQL远程控制平台，通过插件系统可以轻松扩展其功能。本指南将带你快速掌握Temboard插件开发的核心步骤，从零开始创建一个属于自己的插件，为PostgreSQL管理添加自定义功能。

插件开发准备工作

在开始开发之前，请确保你的开发环境已满足以下条件：

环境配置：已安装Python 3.6+和必要的依赖库
源码获取：通过以下命令克隆Temboard仓库
```
git clone https://gitcode.com/gh_mirrors/te/temboard
```
目录结构：了解Temboard的插件目录结构，所有插件位于agent/temboardagent/plugins/目录下

Temboard的插件系统采用模块化设计，每个插件都是一个独立的Python包，包含必要的配置、路由和业务逻辑。

插件基础架构解析

Temboard插件采用统一的架构模式，主要包含以下核心组件：

插件目录结构

一个标准的Temboard插件目录结构如下：

plugins/ ├── your_plugin/ │ ├── __init__.py # 插件主类定义 │ ├── functions.py # 业务逻辑实现 │ ├── routes.py # API路由定义 │ └── templates/ # 前端模板(如需要)

插件主类定义

每个插件都需要定义一个继承自基础插件类的主类，用于插件的初始化和配置加载。以监控插件为例：

class MonitoringPlugin: PG_MIN_VERSION = (90400, 9.4) # 支持的最低PostgreSQL版本 option_specs = [ # 插件配置选项 OptionSpec("monitoring", "dbnames", default="*", validator=commalist), OptionSpec("monitoring", "scheduler_interval", default=60, validator=int), ] def __init__(self, app, **kw): self.app = app self.app.config.add_specs(self.option_specs) # 添加配置选项 def load(self): default_app().mount("/monitoring", bottle) # 挂载路由 # 注册定时任务等其他初始化操作

从零开始开发你的第一个插件

下面我们将通过创建一个简单的"Hello World"插件，演示Temboard插件开发的完整流程。

步骤1：创建插件目录和基础文件

首先，在agent/temboardagent/plugins/目录下创建插件目录和必要文件：

mkdir -p agent/temboardagent/plugins/helloworld touch agent/temboardagent/plugins/helloworld/__init__.py

步骤2：实现插件主类

编辑__init__.py文件，定义插件主类：

import logging from bottle import default_app from temboardtoolkit.configuration import OptionSpec from ...web.app import CustomBottle logger = logging.getLogger(__name__) bottle = CustomBottle() # 创建Bottle应用实例 class HelloWorldPlugin: PG_MIN_VERSION = (90400, 9.4) # 支持PostgreSQL 9.4及以上版本 option_specs = [ OptionSpec("helloworld", "greeting", default="Hello", validator=str), ] def __init__(self, app, **kw): self.app = app self.app.config.add_specs(self.option_specs) # 添加配置选项 def load(self): # 挂载路由到/helloworld路径 default_app().mount("/helloworld", bottle) logger.info("HelloWorld plugin loaded successfully")

步骤3：添加API路由

在同一个文件中添加API路由处理函数：

@bottle.get("/") def get_hello(): app = default_app().temboard # 从配置中获取问候语，默认为"Hello" greeting = app.config.helloworld.greeting return {"message": f"{greeting}, Temboard!"} @bottle.get("/custom/<name>") def get_custom_hello(name): app = default_app().temboard greeting = app.config.helloworld.greeting return {"message": f"{greeting}, {name}!"}

步骤4：配置插件

在Temboard配置文件中添加插件配置：

[helloworld] greeting = Welcome

步骤5：注册插件

要使插件被Temboard识别，需要在agent/temboardagent/plugins/__init__.py中注册插件：

from .helloworld import HelloWorldPlugin def get_plugins(): return [ # 其他已有插件... HelloWorldPlugin, ]

插件高级功能开发

掌握基础插件开发后，我们可以实现更复杂的功能，如数据库交互、定时任务和前端集成。

数据库交互

Temboard提供了便捷的数据库连接方式，可在插件中轻松执行SQL查询：

@bottle.get("/databaseinfo") def get_database_info(pgconn): # pgconn参数会自动注入数据库连接 # 执行SQL查询 result = pgconn.query("SELECT version(), current_database()") return {"database_info": result[0]}

定时任务

通过Temboard的任务调度系统，可以实现定时执行的功能，如定期收集数据：

from temboardtoolkit import taskmanager workers = taskmanager.WorkerSet() @workers.register(pool_size=1) def hello_worker(app): logger.info("Hello from scheduled task!") class HelloWorldPlugin: # ... 其他代码 ... def load(self): # ... 其他初始化代码 ... self.app.worker_pool.add(workers) # 每30秒执行一次任务 workers.schedule(id="hello_task", redo_interval=30)(hello_worker) self.app.scheduler.add(workers)

前端界面集成

如果需要为插件添加前端界面，可以在插件目录中创建templates文件夹，添加HTML模板文件，并在路由中返回渲染后的页面：

from bottle import template @bottle.get("/ui") def get_hello_ui(): return template("helloworld/ui", greeting="Hello from UI")

插件测试与调试

开发插件时，有效的测试和调试方法可以提高开发效率：

本地测试

使用Temboard开发模式启动服务，实时查看插件效果：

temboard-agent --devel --config /path/to/your/config.ini

日志调试

利用Temboard的日志系统输出调试信息：

logger.debug("Debug message with data: %s", data) logger.info("Plugin initialized successfully") logger.warning("Low memory warning")

单元测试

为插件编写单元测试，确保功能稳定性。测试文件放在tests/unit/目录下，如test_helloworld.py。

插件打包与分发

开发完成后，可以将插件打包为独立的安装包，方便在其他Temboard实例中使用：

创建setup.py文件定义包信息
打包为wheel文件：python setup.py bdist_wheel
在目标系统安装：pip install your_plugin-1.0-py3-none-any.whl

实战案例：开发性能监控插件

让我们通过一个实际案例，开发一个简单的性能监控插件，展示Temboard插件的强大功能。

功能描述

该插件将：

定期收集PostgreSQL性能指标
提供API接口查询历史数据
在Temboard界面显示性能图表

核心实现代码

以下是该插件的核心代码片段：

# 在插件主类中添加定时任务 def load(self): default_app().mount("/performance", bottle) self.app.worker_pool.add(workers) workers.schedule( id="performance_collector", redo_interval=self.app.config.performance.interval, )(performance_collector_worker) self.app.scheduler.add(workers) # 定时收集性能数据 @workers.register(pool_size=1) def performance_collector_worker(app): with app.postgres.dbpool() as pool: # 收集CPU使用率 cpu_usage = pool.query("SELECT pg_stat_activity.usage FROM ...") # 收集内存使用 memory_usage = pool.query("SELECT pg_stat_activity.memory FROM ...") # 存储数据 db.add_metric(app.config.temboard.home, "performance.db", time.time(), { "cpu": cpu_usage, "memory": memory_usage })