HG-CLI (recommended)

A fun and easy-to-use command line tool for installing and configuring agents in your systems.

Contents

• Linux Installation

• Macos Installation

• Windows (PowerShell)

• HG-CLI Commands

• Metrics and Visualizations

Our HG command line tool is an interactive way to install an agent on your system, without ever needing to touch a configuration file! This tool currently supports Telegraf installation, with more agents to be added in the future (like OpenTelemetry).

Once you've installed HG-CLI you can run it in TUI or CLI mode, and you can see our list of commands for all available options and examples.

Linux Installation

Locate the official release assets HERE, and below are some example installation commands:

• Ubuntu/Debian (AMD64)

curl -LO https://github.com/hostedgraphite/hg-cli/releases/download/v0.0.1-alpha/hg-cli_0.0.1-alpha_linux_amd64.deb
sudo dpkg -i hg-cli_0.0.1-alpha_linux_amd64.deb

• RedHat/CentOS/Fedora (AMD64)

curl -LO https://github.com/hostedgraphite/hg-cli/releases/download/v0.0.1-alpha/hg-cli_0.0.1-alpha_linux_amd64.rpm
sudo rpm -i hg-cli_0.0.1-alpha_linux_amd64.rpm

Macos Installation

You can use Homebrew to tap and install the HG-CLI packages for MacOS. This method supports both AMD64/ARM64 architecture and the official GitHub repository can be located HERE.

Add tap (optional):

brew tap hostedgraphite/hg-cli

Install:

brew install hg-cli

Windows (PowerShell)

Locate the official release assets HERE, and below are some example installation commands:

AMD64:

Invoke-WebRequest -Uri "https://github.com/hostedgraphite/hg-cli/releases/download/v0.0.1-alpha/hg-cli_0.0.1-alpha_windows_amd64.zip" -OutFile "hg-cli.zip"
Expand-Archive -Path "hg-cli.zip" -DestinationPath "C:\hg-cli"

ARM64:

Invoke-WebRequest -Uri "https://github.com/hostedgraphite/hg-cli/releases/download/v0.0.1-alpha/hg-cli_0.0.1-alpha_windows_arm64.zip" -OutFile "hg-cli.zip"
Expand-Archive -Path "hg-cli.zip" -DestinationPath "C:\hg-cli"

Add to system PATH (optional):

$env:Path += ";C:\hg-cli"

HG-CLI Commands

Once HG-CLI is installed, you can run it as a TUI application, or in CLI mode (for automated installs). Below are all available options and command examples for using this tool.

Run the interactive TUI application (recommended):

hg-cli tui

Run it in CLI mode with the default configuration:

hg-cli agent install telegraf --apikey <HG-API-KEY> --install default

CLI mode for a custom install - to specify which plugins you want:

hg-cli agent install telegraf --apikey <HG-API-KEY> --install custom --plugins cpu,disk,mem

CLI mode to update an API key in an existing config (telegraf):

hg-cli agent update-apikey telegraf --apikey <HG-API-KEY> --config <config path>

To uninstall an agent (telegraf):

hg-cli agent uninstall telegraf

Available flags for CLI mode:

• --apikey (required)

• --action (install, update-apikey)

• --agent (telegraf)

• --install (default, custom)

• --plugins (if custom install)

• --config (config path for updating apikey)

Metrics and Visualizations

Once you have run the HG-CLI and installed an agent, the terminal output will show you that the installation was successful, which plugins were enabled, where your configuration file is located, and the command needed to start the service (required for collecting and forwarding metrics to your HG account).

TUI Installation Output

Once the agent service has been started, you'll be able to locate your system metrics in our Metrics Search UI (with the telegraf prefix). Once telegraf.* metrics have been sent to your account, a Telegraf dashboard will be automatically created and can be located in your HG account (Dashboards ⇒ Telegraf). This auto-dash offers a great starting point and can be customized further!

Telegraf Auto-Dash

If you need help enabling additional plugins or have feedback on the HG-CLI tool, please send us a message: [e-mail]