DCA 客户端¶
DCA(DataKit Control App)是集中管理 DataKit 的 Web 管控系统,采用 B/S 架构和 WebSocket 双向通信协议对 DataKit 进行统一管理,如 DataKit 列表查看、运行信息、配置文件管理、Pipeline 管理等。
DCA 基本网络拓扑结构如下:
flowchart LR;
dca_server(DCA Server);
dca_web(DCA Web);
dk_upgrader1(Upgrader);
dk1(Datakit);
k8s_dk1(Datakit);
brand_name("观测云");
subgraph HOST DataKit
direction TB;
dk_upgrader1 --> dk1;
end
subgraph "Kubernetes DataKit"
k8s_dk1
end
dk1 -..-> |upload data|brand_name;
k8s_dk1 -..-> |upload data|brand_name;
dca_server <---> |websocket| dk_upgrader1 & k8s_dk1
dca_web -- HTTP --- dca_server;
dca_server -.-> |login/auth| brand_name;
DCA web 服务部署¶
DCA web 服务目前仅支持镜像安装,可通过 Docker 或 Kubernetes 来部署 DCA 服务。
环境变量配置¶
默认情况下,DCA 会采用系统默认的配置,如果需要自定义配置,可以通过注入环境变量方式来进行修改。目前支持以下环境变量:
环境变量名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
DCA_CONSOLE_API_URL |
string | https://console-api.guance.com |
观测云 console API 地址,参考 节点地址 |
DCA_CONSOLE_WEB_URL |
string | https://console.guance.com |
观测云平台地址,参考 节点地址 |
DCA_STATIC_BASE_URL |
string | https://static.guance.com |
静态文件服务器地址 |
DCA_CONSOLE_PROXY |
string | 无 | 观测云 API 代理,不代理 DataKit 接口 |
DCA_LOG_LEVEL |
string | info | 日志等级,取值为 debug/info/warn/error |
DCA_LOG_PATH |
string | 无 | 日志路径,如果需要输出到 stdout,则设置为 stdout |
DCA_TLS_ENABLE |
string | 无 | 是否开启 TLS,设置该值表示开启 |
DCA_TLS_CERT_FILE |
string | 无 | 证书文件路径,如: /etc/ssl/certs/server.crt |
DCA_TLS_KEY_FILE |
string | 无 | 私钥文件路径,如: /etc/ssl/certs/server.key |
DCA_PROM_LISTEN |
string | localhost:9090 ,指标暴露的请求路由为 localhost:9090/metrics |
DCA backend 指标暴露地址 |
示例:
docker run -d --name dca -p 8000:80 -e DCA_LOG_PATH=stdout -e DCA_LOG_LEVEL=info pubrepo.guance.com/tools/dca
节点地址¶
部署类型 | 节点名 | DCA_CONSOLE_API_URL |
DCA_CONSOLE_WEB_URL |
---|---|---|---|
SaaS 部署 | 中国区 1(杭州) | https://console-api.guance.com |
https://console.guance.com |
SaaS 部署 | 中国区 2(宁夏) | https://aws-console-api.guance.com |
https://aws-console.guance.com |
SaaS 部署 | 中国区 4(广州) | https://cn4-console-api.guance.com |
https://cn4-console.guance.com |
SaaS 部署 | 中国区 6(香港) | https://cn6-console-api.guance.com |
https://cn6-console.guance.com |
SaaS 部署 | 海外区 1(俄勒冈) | https://us1-console-api.guance.com |
https://us1-console.guance.com |
SaaS 部署 | 欧洲区 1(法兰克福) | https://eu1-console-api.guance.com |
https://eu1-console.guance.com |
SaaS 部署 | 亚太区 1(新加坡) | https://ap1-console-api.guance.com |
https://ap1-console.guance.com |
私有部署版 | 私有部署版 | 实际部署地址 | 实际部署地址 |
DataKit 客户端配置¶
Attention
不同版本的 DataKit 接口可能存在差异,为了更好地使用 DCA,建议升级 DataKit 为最新版本。
在安装命令前添加以下环境变量:
DK_DCA_ENABLE
是否开启,开启设置为 on
DK_DCA_WEBSOCKET_SERVER
配置 DCA web 服务的 WebSocket 地址 ( Version-1.64.0),即 ws://<dca_server_address>/ws
示例:
DK_DCA_ENABLE=on DK_DCA_WEBSOCKET_SERVER="ws://<DCA_SERVER_ADDRESS>/ws" DK_DATAWAY=https://openway.guance.com?token=<TOKEN> bash -c "$(curl -L https://static.guance.com/datakit/install.sh)"
安装成功后,DataKit 将自动连接 DCA 服务。
可通过 设置 DCA 相关环境变量 来开启 DCA 功能。
修改配置文件 datakit.conf:
配置好后,重启 DataKit 即可。
DCA 功能使用¶
登录 DCA¶
DCA 开启和安装以后,您可在浏览器输入 DCA web 服务地址进行访问。首次访问时,页面将导向一个登录跳转中转页面。点击页面下方「立即前往」按钮后,您将被引导至观测云平台。接下来,按照页面上的说明指引,配置 DCA 的地址。一旦配置完成,您便能够直接通过观测云平台实现无需登录即可访问 DCA 平台的功能。
查看 DataKit 列表¶
登录到 DCA 后,可在左上角选择工作空间管理其对应 DataKit 及采集器,支持通过搜索关键字快速筛选需要查看和管理的主机名称。
通过 DCA 远程管理的主机分成三种状态:
- running:说明数据上报正常,可通过 DCA 查看 DataKit 的运行情况和配置采集器;
- offline:说明 DataKit 离线状态。
- stopped: DataKit 处于停止状态。
- upgrading: DataKit 处于升级状态。
- restarting: DataKit 处于重启状态。
默认情况下,只能查看当前工作空间里的 DataKit 相关信息,如果需要对 DataKit 进行管理,如 DataKit 升级、采集器、Pipeline 的 新建、删除、修改等,则需要赋予当前帐号DCA 配置管理权限,具体设置可参考角色管理。
查看 DataKit 运行情况¶
登录到 DCA 后,选择工作空间,即可查看该工作空间下所有已经安装 DataKit 的主机名和 IP 信息。点击 DataKit 主机,即可远程连接到 DataKit ,查看该主机上 DataKit 的运行情况,包括版本、运行时间、发布日期、采集器运行情况等,以及可以对 DataKit 进行重新加载操作。
采集器配置管理¶
远程连接到 DataKit 以后,点击「采集器配置」,即可查看已经配置的采集器列表和 Sample 列表(当前 DataKit 支持配置的所有 Sample 文件)。
- 已配置列表:可查看,编辑和删除其下所有的 conf 文件。
- Sample 列表:可查看和编辑其下所有的 sample 文件。
- 帮助:可查看对应的采集器帮助文档
Pipelines 管理¶
远程连接到 DataKit 以后,点击「Pipelines」,即可查看,编辑和测试 DataKit 默认自带的 Pipeline 文件。关于 Pipeline 可参考文档 文本数据处理 。
查看黑名单¶
远程连接到 DataKit 以后,点击「黑名单」,即可查看在观测云工作配置的黑名单,如下图所示 source = default and (status in [unknown])
即为配置的黑名单条件。
注意:通过观测云创建的黑名单文件统一保存在路径:/usr/local/datakit/data/.pull
。
查看日志¶
远程连接到 DataKit 以后,点击「日志」,即可实时查看 DataKit 的日志,并且可以导出相应的日志到本地。
更新日志¶
0.1.1(2025/04/23)¶
- 增加 DCA backend Prometheus 指标暴露环境变量配置(
DCA_PROM_LISTEN
) - 重构 DCA 构建过程
0.1.0(2024/11/27)¶
- 重构 DCA 底层框架,使用 WebSocket 协议进行通信,便于管理不同网络环境下的 DataKit。
- 新增管理 DataKit 主配置的功能。
- 新增支持 TLS 配置。
- 调整 DataKit 的”重新加载“功能为“重启“。