Linux
StackState Self-hosted v5.1.x
Last updated
StackState Self-hosted v5.1.x
Last updated
StackState Agent V3 can be installed on Linux systems running CentOS, Debian, Fedora, RedHat or Ubuntu. The Agent collects data from the host where it's running and can be configured to integrate with external systems. Retrieved data is pushed to StackState, to work with this data the must be installed in your StackState instance. For details of the data retrieved and available integrations, see the .
StackState Agent V3 will synchronize the following data with StackState from the Linux host it's running on:
Hosts, processes and containers.
Telemetry for hosts, processes and containers.
For OS versions with a network tracer:
Network connections between processes and containers.
Network traffic telemetry.
, such as HTTP server latencies, errors and request counts.
StackState Agent is tested to run on the Linux versions listed below with 64bit architecture. Note that host data for network connections between processes and containers (including network traffic telemetry) can only be retrieved for OS versions with a network tracer (kernel version 4.3.0 or higher):
CentOS
CentOS 6
CentOS 6 requires Agent V2.0.2 or above. Network tracer available from CentOS 8.
Debian
Debian 7 (Wheezy)
Debian 7 (Wheezy) requires glibc upgrade to 2.17. Network tracer available from Debian 9 (Stretch).
Fedora
Fedora 28
-
RHEL
RHEL 7
Network tracer available from RHEL 8.
Ubuntu
Ubuntu 15.04 (Vivid Vervet)
Network tracer available from Ubuntu 16.04 (LTS) (Xenial Xerus).
StackState Agent V3 is installed using an install script.
If you have access to the internet on the machine where the Agent will be installed, use one of the commands below to run the install.sh
script. The Agent installer package will be downloaded automatically.
<STACKSTATE_RECEIVER_API_KEY>
is set during StackState installation.
<STACKSTATE_RECEIVER_API_ADDRESS>
is specific to your installation of StackState.
If you don't have access to the internet on the machine where the Agent will be installed, you will need to download both the install script and the Agent installer package before you install. You can then set the environment variable STS_INSTALL_NO_REPO=yes
and specify the path to the downloaded installer package when you run the install.sh
script.
Download the install script and copy this to the host where it will be installed:
Get the Key of the latest version of the Agent installer package (DEB or RPM package):
Download the Agent installer package and copy this to the host where it will be installed. The download link can be constructed from the S3 bucket URL and the installer package Key
provided on the installer package list page. For example, to download the DEB installer package for agent_2.13.0-1_amd64.deb
, use: https://stackstate-agent-2.s3.amazonaws.com/pool/stable/s/st/stackstate-agent_2.13.0-1_amd64.deb
DEB Download link: https://stackstate-agent-2.s3.amazonaws.com/<Key_from_DEB_installer_package_list>
RPM Download link: https://stackstate-agent-2-rpm.s3.amazonaws.com/<Key_from_RPM_installer_package_list>
Use the command below to set the required environment variables and run the installer script.
<STACKSTATE_RECEIVER_API_KEY>
is set during StackState installation.
The StackState Agent V3 configuration is located in the file /etc/stackstate-agent/stackstate.yaml
. The <STACKSTATE_RECEIVER_API_KEY>
and <STACKSTATE_BASE_URL>
specified during installation will be added here by the install script. No further configuration should be required, however, a number of advanced configuration options are available.
The Agent can be configured to run checks that integrate with external systems. Configuration files for integrations run through StackState Agent V3 can be found in the directory /etc/stackstate-agent/conf.d/
. Each integration has its own configuration file that's used by the associated Agent check.
To manually start, stop or restart StackState Agent V3:
To check if StackState Agent V3 is running and receive information about the Agent's state:
To show tracebacks for errors or output the full log:
Use the command below to manually run an Agent check.
Logs for the Agent subsystems can be found in the following files:
/var/log/stackstate-agent/agent.log
/var/log/stackstate-agent/process-agent.log
By default, the log level of the Agent is set to INFO
. To assist in troubleshooting, the Agent log level can be set to DEBUG
. This will enable verbose logging and all errors encountered will be reported in the Agent log files.
To set the log level to DEBUG
for an Agent running on Linux:
Edit the file /etc/stackstate-agent/stackstate.yaml
To set the log level to DEBUG
, add the line:
To also include the topology/telemetry payloads sent to StackState in the Agent log, add the line:
To uninstall StackState Agent V3 from your system, stop the stackstate-agent
service and remove it using yum
or apt-get
.
- If you have access to the internet on the machine where the Agent will be installed.
- If you don't have access to the internet on the machine where the Agent will be installed.
For details see .
<STACKSTATE_RECEIVER_API_ADDRESS>
is specific to your installation of StackState. For details see .
To upgrade StackState Agent V3 on your system, stop the stackstate-agent
service and upgrade using yum
or apt-get
. To upgrade offline, download the Agent installer package (DEB or RPM package) and copy this to the host where it will be installed - see step 2 in the .
StackState Agent V3 can be configured to reduce data production, tune the process blacklist, or turn off specific features when not needed. The required settings are described in detail on the page .
Documentation for the available StackState integrations, including configuration details can be found on the .
The Agent can be configured to use a proxy for HTTP and HTTPS requests. For details, see .
To troubleshoot the Agent, try to or .
Save the file and for changes to be applied.
Troubleshooting steps for any known issues can be found in the .