The StackState Agent is a piece of software that runs on your hosts. Its job is to faithfully collect events and metrics and bring them to StackState on your behalf so that you can do something useful with your monitoring and performance data.
The source code for the StackState Agent can be found here.
The Agent has three main parts: the collector, stsstatsd, and the forwarder.
The main agent configuration file is
/etc/sts-agent/stackstate.conf. There are two critical options that need to be configured to get the agent working. These are the StackState URL and the API key.
The agent sends topology and telemetry to the StackState server. The server endpoint where the data is sent must be configured in the agent configuration file. For example:
The agent can also be configured to send data over HTTPS.
StackState server must be configured to use HTTPS separately. This can be achieved by configuring a reverse proxy.
In addition to configuring the agent to use HTTPS, Connbeat, part of the agent responsible for detecting connections, requires a separate configuration. The file
/etc/sts-agent/connbeat.yml contains the Connbeat configuration. Enabling HTTPS for Connbeat requires the following instructions:
output: http: hosts: ["https://stackstate:443/stsAgent/connbeat?api_key=none"] compression_level: 6 protocol: "https" tls: enabled: true
NOTE: the HTTPS URL in the configuration above requires an explicit port number.
The agent communicates with the StackState server specifying a unique API key. The server is configured to only allow incoming data from a particular key. The API key used by the agent must be configured in the agent configuration file. For example:
Server: file APIKEY
If you encountered an issue during the Agent installation that prevented any installation whatsoever from occurring, please reach out to our technical support. Please let us know your OS and version, as well as how you are installing the Agent (and which agent version). Also, please include the errors you encountered along the way.
If you get the Agent installed but are not seeing any data in StackState, you can troubleshoot in the following manner. First, run the info command. Select your OS in the nav column on the left of this page to see how to run this. Does running the info command show any errors?
If not, you should also check the logs (location of the logs again depends on OS). Errors in the logs may also reveal the cause of any issues.
If not, please send both the full output of the info command and the logs as attachments to our technical support.
Here is a quick guide for troubleshooting getting integrations installed:
Run the info command (find this based on your OS in the left column above).
Is the integration showing up in the info command?