TCollector 技术文档

1. 安装指南

系统要求

在安装 TCollector 之前，请确保您的系统满足以下要求：

• Python 2.6 或更高版本
• OpenTSDB 安装并运行

安装步骤

1. 克隆项目代码：

   git clone https://github.com/OpenTSDB/tcollector.git
   

2. 进入项目目录：

   cd tcollector
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 运行安装脚本：

   python setup.py install
   

5. 验证安装是否成功：

   tcollector -V
   

   如果看到版本信息，则表示安装成功。

2. 项目使用说明

TCollector 是一个用于收集数据点并将其存储在 OpenTSDB 中的框架。您可以通过编写简单的收集器来实现数据的收集和监控。以下是项目的基本使用方法：

运行默认配置

运行以下命令，TCollector 将启动并开始收集默认配置中的数据点：

tcollector

定制配置

如果您需要收集特定的数据点，可以通过修改配置文件 tcollector.conf 来实现。配置文件位于项目根目录下，您可以根据需要添加或修改数据收集器。

例如，要添加一个名为 my_collector.py 的自定义数据收集器，请按照以下步骤操作：

1. 创建自定义收集器文件 my_collector.py 并编写代码。

2. 在 tcollector.conf 文件中添加以下内容：

   [my_collector]
   cmd = python my_collector.py
   

3. 重新启动 TCollector：

   tcollector
   

现在，TCollector 将运行并收集您自定义的数据点。

3. 项目API使用文档

TCollector 提供了丰富的 API 用于扩展和自定义数据收集器。以下是常用的 API 及其使用方法：

get metric

获取指定 metric 的数据点。

def getmetric metric, value, tags=None, timestamp=None

• metric：数据指标名称
• value：数据指标值
• tags：可选，用于描述数据点的标签
• timestamp：可选，数据点的时间戳

send metrics

发送一组数据点到 OpenTSDB。

def sendmetrics metrics

• metrics：数据点列表，每个元素是一个 getmetric 调用的结果

log

记录日志信息。

def log level, message

• level：日志级别，如 INFO, WARN, ERROR
• message：日志信息

4. 项目安装方式

TCollector 支持以下安装方式：

直接安装

按照上文提到的“安装指南”中的步骤进行安装。

使用 Docker

1. 拉取 Docker 镜像：

   docker pull opentsdb/tcollector
   

2. 运行容器：

   docker run -d --name tcollector -e TSD_URL=http://<TSD_HOST>:<TSD_PORT> opentsdb/tcollector
   

   替换 <TSD_HOST> 和 <TSD_PORT> 为您的 OpenTSDB 服务的地址和端口。

3. 查看容器日志：

   docker logs tcollector
   

   如果看到收集器启动和运行的信息，则表示安装成功。