Collector Linux package installation

This documentation explains how to install the AppSignal collector using a Linux package on the host you want to monitor.

Select the Operating System your host uses from the navigation on the right to continue.

Let us know if you want to run the collector on a distribution not listed here.

Debian

First, make sure the following packages are installed. All the following commands need root permissions. If you get a permission error, you may need to use sudo.

Shell
apt update apt install curl gpg -y

The following releases are supported.

  • Bookworm for Debian 12 (x86_64 and arm64)
  • Bullseye for Debian 11 (x86_64)

Follow the instructions for your Debian version.

Import the GPG signing key by running this command:

Shell
curl -fsSL "https://packages.buildkite.com/appsignal/collector-debian-bookworm/gpgkey" | gpg --dearmor -o /etc/apt/keyrings/appsignal_collector-debian-bookworm-archive-keyring.gpg

Configure the package source by running this command:

Shell
echo -e "deb [signed-by=/etc/apt/keyrings/appsignal_collector-debian-bookworm-archive-keyring.gpg] https://packages.buildkite.com/appsignal/collector-debian-bookworm/any/ any main\ndeb-src [signed-by=/etc/apt/keyrings/appsignal_collector-debian-bookworm-archive-keyring.gpg] https://packages.buildkite.com/appsignal/collector-debian-bookworm/any/ any main" > /etc/apt/sources.list.d/buildkite-appsignal-collector-debian-bookworm.list

Then, update apt to get the newly added packages and install the collector.

Shell
apt-get update apt-get install appsignal-collector

The collector has now been installed. Next up is configuring the collector so that AppSignal can receive data.

Ubuntu

First, make sure the following packages are installed. All the following commands need root permissions. If you get a permission error, you may need to use sudo.

Shell
apt update apt install curl gpg -y

The following releases are supported.

  • Noble for Ubuntu 24.04 (x86_64 and arm64)
  • Jammy for Ubuntu 22.04 (x86_64)

Follow the instructions for your Ubuntu version.

Import the GPG signing key by running this command:

Shell
curl -fsSL "https://packages.buildkite.com/appsignal/collector-ubuntu-noble/gpgkey" | gpg --dearmor -o /etc/apt/keyrings/appsignal_collector-ubuntu-noble-archive-keyring.gpg

Configure the package source by running this command:

Shell
echo -e "deb [signed-by=/etc/apt/keyrings/appsignal_collector-ubuntu-noble-archive-keyring.gpg] https://packages.buildkite.com/appsignal/collector-ubuntu-noble/any/ any main\ndeb-src [signed-by=/etc/apt/keyrings/appsignal_collector-ubuntu-noble-archive-keyring.gpg] https://packages.buildkite.com/appsignal/collector-ubuntu-noble/any/ any main" > /etc/apt/sources.list.d/buildkite-appsignal-collector-ubuntu-noble.list

Then, update apt to get the newly added packages and install the collector.

Shell
apt-get update apt-get install appsignal-collector

The collector has now been installed. Next up is configuring the collector so that AppSignal can receive data.

Red Hat Enterprise Linux/CentOS

The following Red Hat releases are supported.

  • RHEL 9 (x86_64)

The following commands need root permissions. If you get a permission error, you may need to use sudo.

Configure the package source by running this command:

Shell
sh -c 'echo -e "[collector-rpm-9]\nname=Collector RPM 9 \nbaseurl=https://packages.buildkite.com/appsignal/collector-rpm-9/rpm_any/rpm_any/\$basearch\nenabled=1\nrepo_gpgcheck=1\ngpgcheck=0\ngpgkey=https://packages.buildkite.com/appsignal/collector-rpm-9/gpgkey\npriority=1"' > /etc/yum.repos.d/collector-rpm-9.repo

Then, install the collector.

Shell
dnf install -y appsignal-collector

The collector has now been installed. Next up is configuring the collector so that AppSignal can receive data.

Configuration

The collector configuration can be found at /etc/appsignal-collector.conf. For a list of all the available options, see the configuration options page.

The required Push API key can be found in the "Push & Deploy" section for any app in your organization and in the "Add app" wizard for your organization.

Only the Push API key is required when configuring the collector. It will authorize requests to our Push API.

Config file
# /etc/appsignal-collector.conf push_api_key = "<YOUR PUSH API KEY>"

For example:

Config file
# /etc/appsignal-collector.conf push_api_key = "0000-0000-0000-0000"

Once the configuration file is updated, you need to restart the collector.

Shell
systemctl restart appsignal-collector

The collector should now be running!

Check the log output with the following command to see if any problems have been reported.

Shell
journalctl -u appsignal-collector