Install on macOS¶

Prerequisites

Requires macOS 10.13 or later.

Choose DataWay Gateway Address¶

DataWay is the data gateway for Guance. All data reported by collectors to Guance must pass through the DataWay gateway.

Installation Command¶

Copy the installation command below and run it on your server.

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

During the installation phase, you can define part of the DataKit configuration by adding environment variables to the installation command. Prefix the variables with $env:, and separate multiple environment variables with semicolons.

View more environment variables.

Common Configurations¶

Add global host tags, separate multiple tags with English commas. For example: host=datakit_hostname;
Specify the collectors to be enabled. By default, some host-related collectors are enabled. For example: cpu, mem, disk.

RUM & HTTP¶

Configure the DataKit HTTP service address (❗️If using RUM functionality, this must be configured as a publicly accessible address). For example: localhost;
Configure the port bound to the DataKit HTTP service, default is 9529;
Choose whether to enable the RUM collector;
Choose whether to install the IP geolocation database;
Choose whether to disable the DataKit 404 page;
Choose whether to install the Source Map toolset.

APM¶

Choose whether to enable the DDTrace collector;
Choose whether to enable APM auto-injection.

DCA¶

Choose whether to enable the DCA service.

Notes¶

If the following appears during installation/upgrade:

"launchctl" failed with stderr: /Library/LaunchDaemons/com.guance.datakit.plist: Service is disabled

First execute the command:

sudo launchctl enable system/datakit

Then execute the command:

sudo launchctl load -w /Library/LaunchDaemons/com.guance.datakit.plist