脚本开发 / TrueWatch

TrueWatch 连接器操作对象主要提供用于数据写入的 DataWay 对象以及 OpenAPI 的封装。

此连接器的 API Key 需要 Administrator 角色

由于本连接器会自动获取工作空间 Token 等敏感信息，以供后续上报数据等操作。

因此，需要为 API Key 分配 Administrator 角色

DFF.CONN(...) 参数如下：

参数	类型	必须 / 默认值	说明
connector_id	str	必须	连接器 ID

OpenAPI 文档请参考：

• TrueWatch 文档 / OpenAPI

.dataway

dataway 属性为当前TrueWatch 对应的 DataWay 操作对象，使用方式与直接创建的 DataWay 连接器操作对象相同。

status_code, result = truewatch.dataway.write_by_category(category='metric', measurement='服务监控', tags={'service': 'mysql'}, fields={'mem': 10})

完整内容请参考：

• 脚本开发 / 连接器对象 DFF.CONN / DataKit、DataWay

.is_api_key_valid / .is_api_key_match

is_api_key_valid / is_api_key_match 属性返回当前连接器的 API Key 是否有效：

print(truewatch.is_api_key_valid)

True

.workspace

workspace 属性返回当前工作空间信息：

import json
print(json.dumps(truewatch.workspace, indent=2))

{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp2",
  "language"    : "en",
  "timezone"    : "",
  "bossStation" : "HK",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<其他字段略>": "..."
}

.workspace_uuid

workspace_uuid 属性返回当前工作空间 UUID：

print(truewatch.workspace_uuid)

wksp_xxxxx

.workspace_token

workspace_token 属性返回当前工作空间 Token：

print(truewatch.workspace_token)

tkn_xxxxx

.workspace_language

workspace_language 属性返回当前工作空间语言：

print(truewatch.workspace_language)

zh

.do_get(...)

用于向TrueWatch OpenAPI 发起 GET 请求，参数如下：

参数	类型	必须 / 默认值	说明
path	str	必须	路径
query	dict		参数

import json

result = truewatch.do_get('/api/v1/workspace/get')
print(json.dumps(result, indent=2))

{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp1",
  "language"    : "en",
  "timezone"    : "",
  "bossStation" : "HK",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<其他字段略>": "..."
}

.do_post(...)

用于向TrueWatch OpenAPI 发起 POST 请求，参数如下：

参数	类型	必须 / 默认值	说明
path	str	必须	路径
query	dict		参数
body	dict		JSON 请求体

body = {
    'name': '新名称'
}
result = truewatch.do_post('/api/v1/workspace/modify', body=body)

节点

TrueWatch 系统搭载多节点分布式架构，在创建连接器时需精准指定目标节点以确保功能正常调用。

DataFlux Func 为实现完全离线使用场景的兼容性，采用版本化节点列表固化机制 —— 每个版本发布时均会同步保存当次最新的 TrueWatch 节点清单，以此保障离线环境下的稳定运行。

受限于上述机制，若 TrueWatch 后续新增节点，可能出现 DataFlux Func 版本节点列表未及时更新的情况。建议用户关注版本迭代信息，如需使用最新节点功能，可通过升级至 DataFlux Func 最新版本获取完整支持。

若遇上述情况，可通过以下方式完成新节点配置：

1. 信息查询：访问指定地址获取 TrueWatch 新增节点的完整配置参数；
2. 手动部署：选择「私有部署」模式，将查询到的节点信息手工填入系统对应字段完成配置。

建议操作前确认参数准确性，确保与当前环境适配以保障部署效果。

• urls.truewatch.com

当前可用的节点列表如下：

节点	名称	地址
正在获取最新节点列表...