主机安装¶

本文介绍 DataKit 的基本安装。

获取安装命令¶

登陆工作空间，点击左侧「集成」选择顶部「Datakit」，即可看到各种平台的安装命令。

注意，以下 Linux/Mac/Windows 安装程序，能自动识别硬件平台（arm/x86, 32bit/64bit），无需做硬件平台选择。

LinuxMacWindows

命令大概如下：

DK_DATAWAY=https://openway.guance.com?token=<TOKEN> bash -c "$(curl -L https://static.guance.com/datakit/install.sh)"

安装完成后，在终端会看到安装成功的提示。

Mac 下安装命令跟 Linux 基本一样：

DK_DATAWAY=https://openway.guance.com?token=<TOKEN> bash -c "$(curl -L https://static.guance.com/datakit/install.sh)"

安装完成后，在终端会看到安装成功的提示。

Windows 上安装需在 Powershell 命令行安装，且必须以管理员身份运行 Powershell。按下 Windows 键，输入 powershell 即可看到弹出的 powershell 图标，右键选择「以管理员身份运行」即可。

$env:DK_DATAWAY="https://openway.guance.com?token=<TOKEN>"; Set-ExecutionPolicy Bypass -scope Process -Force; Import-Module bitstransfer; start-bitstransfer -source https://static.guance.com/datakit/install.ps1 -destination .install.ps1; powershell .install.ps1;

Mac 安装问题

Mac 上安装时，如果安装/升级过程中出现

"launchctl" failed with stderr: /Library/LaunchDaemons/cn.dataflux.datakit.plist: Service is disabled
# 或者
"launchctl" failed with stderr: /Library/LaunchDaemons/com.guance.datakit.plist: Service is disabled

执行

sudo launchctl enable system/datakit

然后再执行如下命令即可

sudo launchctl load -w /Library/LaunchDaemons/cn.dataflux.datakit.plist
# 或者
sudo launchctl load -w /Library/LaunchDaemons/com.guance.datakit.plist

额外支持的安装变量¶

如果需要在安装阶段定义一些 DataKit 配置，可在安装命令中增加环境变量，在 DK_DATAWAY 前面追加即可。如追加 DK_NAMESPACE 设置：

# Linux/Mac
DK_NAMESPACE="<namespace>" DK_DATAWAY="https://openway.guance.com?token=<TOKEN>" bash -c "$(curl -L https://static.guance.com/datakit/install.sh)"

# Windows
$env:DK_NAMESPACE="<namespace>"; $env:DK_DATAWAY="https://openway.guance.com?token=<TOKEN>"; Set-ExecutionPolicy Bypass -scope Process -Force; Import-Module bitstransfer; start-bitstransfer -source https://static.guance.com/datakit/install.ps1 -destination .install.ps1; powershell .install.ps1;

俩种环境变量的设置格式为：

# Windows: 多个环境变量之间以分号分割
$env:NAME1="value1"; $env:Name2="value2"

# Linux/Mac: 多个环境变量之间以空格分割
NAME1="value1" NAME2="value2"

安装脚本支持的环境变量如下（全平台支持）。

Attention

全离线安装不支持这些环境变量设置。但可以通过代理以及设置本地安装地址方式来设置这些环境变量。

最常用环境变量¶

DK_DATAWAY：指定 DataWay 地址，目前 DataKit 安装命令已经默认带上
DK_GLOBAL_TAGS：已弃用，改用 DK_GLOBAL_HOST_TAGS
DK_GLOBAL_HOST_TAGS：支持安装阶段填写全局主机 tag，格式范例：host=__datakit_hostname,host_ip=__datakit_ip（多个 tag 之间以英文逗号分隔）
DK_GLOBAL_ELECTION_TAGS：支持安装阶段填写全局选举 tag，格式范例：project=my-porject,cluster=my-cluster（多个 tag 之间以英文逗号分隔）
DK_DEF_INPUTS：默认开启的采集器名称列表，格式范例：cpu,mem,disk
由于默认会开启很多采集器，这个环境变量用于调整这个默认的采集器列表，比如，可以选择只开启 cpu,mem,disk 三个采集的话，传入 DK_DEF_INPUTS="cpu,mem,disk" 即可
DK_CLOUD_PROVIDER：支持安装阶段填写云厂商(aliyun/aws/tencent/hwcloud/azure)

DataKit 自身日志相关¶

DK_LOG_LEVEL: 可选值 info/debug
DK_LOG: 如果改成 stdout, 日志将不写文件, 而是终端输出
DK_GIN_LOG: 如果改成 stdout, 日志将不写文件, 而是终端输出

DataKit pprof 相关¶

DK_ENABLE_PPROF: 是否开启 pprof
DK_PPROF_LISTEN: pprof服务监听地址

DataKit 选举相关¶

DK_ENABLE_ELECTION: 开启选举, 默认不开启, 如需开启, 给该环境变量任意一个非空字符串值即可。（如 True/False）
DK_NAMESPACE：支持安装阶段指定命名空间(选举用)

HTTP/API 相关环境变量¶

DK_HTTP_LISTEN：支持安装阶段指定 DataKit HTTP 服务绑定的网卡（默认 localhost）
DK_HTTP_PORT：支持安装阶段指定 DataKit HTTP 服务绑定的端口（默认 9529）
DK_RUM_ORIGIN_IP_HEADER: RUM 专用
DK_DISABLE_404PAGE: 禁用 DataKit 404 页面 (公网部署 DataKit RUM 时常用.如 True/False)
DK_INSTALL_IPDB: 安装时指定IP库(当前仅支持iploc, geolite2)

DCA 相关¶

DK_DCA_ENABLE：支持安装阶段开启 DCA 服务（默认未开启）
DK_DCA_LISTEN：支持安装阶段自定义配置 DCA 服务的监听地址和端口（默认0.0.0.0:9531）
DK_DCA_WHITE_LIST: 支持安装阶段设置访问 DCA 服务白名单，多个白名单以 , 分割 (如：192.168.0.1/24,10.10.0.1/24)

外部采集器相关¶

DK_INSTALL_EXTERNALS: 可用于安装如 ebpf 等未与 DataKit 一起打包的外部采集器

Confd 配置相关¶

环境变量名	类型	适用场景	说明	样例值
DK_CONFD_BACKEND	string	全部	后端源类型	`etcdv3`或`zookeeper`或`redis`或`consul`
DK_CONFD_BASIC_AUTH	string	`etcdv3`或`consul`	可选
DK_CONFD_CLIENT_CA_KEYS	string	`etcdv3`或`consul`	可选
DK_CONFD_CLIENT_CERT	string	`etcdv3`或`consul`	可选
DK_CONFD_CLIENT_KEY	string	`etcdv3`或`consul`或`redis`	可选
DK_CONFD_BACKEND_NODES	string	全部	后端源地址	`[IP地址:2379,IP地址2:2379]`
DK_CONFD_PASSWORD	string	`etcdv3`或`consul`	可选
DK_CONFD_SCHEME	string	`etcdv3`或`consul`	可选
DK_CONFD_SEPARATOR	string	`redis`	可选默认0
DK_CONFD_USERNAME	string	`etcdv3`或`consul`	可选

Git 配置相关¶

DK_GIT_URL: 管理配置文件的远程 git repo 地址。（如 http://username:password@github.com/username/repository.git）
DK_GIT_KEY_PATH: 本地 PrivateKey 的全路径。（如 /Users/username/.ssh/id_rsa）
DK_GIT_KEY_PW: 本地 PrivateKey 的使用密码。（如 passwd）
DK_GIT_BRANCH: 指定拉取的分支。为空则是默认，默认是远程指定的主分支，一般是 master。
DK_GIT_INTERVAL: 定时拉取的间隔。（如 1m）

Sinker 相关配置¶

DK_SINK_M: 安装时指定 Metric 的 sink。
DK_SINK_N: 安装时指定 Network 的 sink。
DK_SINK_K: 安装时指定 KeyEvent 的 sink。
DK_SINK_O: 安装时指定 Object 的 sink。
DK_SINK_CO: 安装时指定 CustomObject 的 sink。
DK_SINK_L: 安装时指定 Logging 的 sink。
DK_SINK_T: 安装时指定 Tracing 的 sink。
DK_SINK_R: 安装时指定 RUM 的 sink。
DK_SINK_S: 安装时指定 Security 的 sink。
DK_SINK_P: 安装时指定 Profiling 的 sink。
DK_LOG_SINK_DETAIL: 安装时指定开启 sink 详细日志(开启后会产生大量日志, 仅供调试, 不建议在生产环境中使用)。例: "yes"。

参见 M3DB 示例

cgroup 配置相关¶

以下安装选项仅 Linux 平台支持：

DK_CGROUP_DISABLED：Linux 系统下关闭 Cgroup 功能（默认开启）
DK_LIMIT_CPUMAX：Linux 系统下支持 CPU 的最大功率，默认 30.0
DK_LIMIT_CPUMIN：Linux 系统下支持 CPU 的最小功率，默认 5.0
DK_LIMIT_MEMMAX：Linux 系统下限制内存（含 swap）最大用量，默认 4096（4GB）

其它安装选项¶

DK_INSTALL_ONLY：仅安装，不运行
DK_HOSTNAME:支持安装阶段自定义配置主机名
DK_UPGRADE：升级到最新版本（注：一旦开启该选项，其它选项均无效）
DK_INSTALLER_BASE_URL：可选择不同环境的安装脚本，默认为 https://static.guance.com/datakit
HTTPS_PROXY：通过 Datakit 代理安装
DK_PROXY_TYPE：代理类型。选项有: "datakit" 或 "nginx"，均为小写
DK_NGINX_IP：代理服务器 IP 地址（只需要填 IP 不需要填端口）。这个与上面的 "HTTP_PROXY" 和 "HTTPS_PROXY" 互斥，而且优先级最高，会覆盖以上两者
DK_INSTALL_LOG：设置安装程序日志路径，默认为当前目录下的 install.log，如果设置为 stdout 则输出到命令行终端

FAQ¶

如何应付不友好的主机名¶

由于 DataKit 使用主机名（Hostname）作为数据串联的依据，某些情况下，一些主机名取得不是很友好，比如 iZbp141ahn....，但由于某些原因，又不能修改这些主机名，这给使用带来一定的困扰。在 DataKit 中，可在主配置中覆盖这个不友好的主机名。

在 datakit.conf 中，修改如下配置，DataKit 将读取 ENV_HOSTNAME 来覆盖当前的真实主机名：

[environments]
    ENV_HOSTNAME = "your-fake-hostname-for-datakit"

注意：如果之前某个主机已经采集了一段时间的数据，更改主机名后，这些历史数据将不再跟新的主机名关联。更改主机名，相当于新增了一台全新的主机。

扩展阅读¶

DataKit 使用入门