Windows
StackState Self-hosted v5.1.x
Last updated
StackState v5.1
StackState Self-hosted v5.1.x
Last updated
StackState Agent V2 can be installed on Windows systems. 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 V2 will synchronize the following data from the host it's running on with StackState:
Hosts, processes and containers.
Telemetry for hosts, processes and containers
Network connections between processes and containers, including network traffic telemetry.
StackState Agent V2.19.x is supported to run on:
Windows 10 or higher
Windows Server 2012 or higher
If you have access to the internet on the machine where the Agent will be installed, the install.ps1 script can be run using iwr and the Agent installer package will be downloaded automatically.
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.
Download the PowerShell install script and copy this to the host where it will be installed:
Download the latest version of the Agent installer package and copy this to the host where it will be installed next to the PowerShell install script:
Assuming the installer script is saved as C:\stackstate-custom.msi and the PowerShell script is saved as C:\install_script.ps1, open PowerShell with elevated privileges and invoke the following set of commands:
To upgrade StackState Agent V2 running on Windows,
Download the latest version of the Agent installer package and copy this to the host where it will be installed next to the PowerShell install script:
Double-click the downloaded *.msi file.
The StackState Agent V2 configuration is located in the file C:\ProgramData\StackState\stackstate.yaml. The stsApiKey and stsUrl specified during installation will be added here by the install script. No further configuration should be required.
The Agent can be configured to run checks that integrate with external systems. Configuration files for integrations run through StackState Agent V2 can be found in the directory C:\ProgramData\StackState\conf.d. Each integration has its own configuration file that's used by the enabled Agent checks.
To manually start, stop or restart StackState Agent V2:
To check if StackState Agent V2 is running and receive information about the Agent's status:
Use the command below to manually run an Agent check once and output the results.
Logs for the Agent subsystems can be found in the following files:
C:\ProgramData\StackState\logs\agent.log
C:\ProgramData\StackState\logs\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 Windows:
Edit the file C:\ProgramData\StackState\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 V2 running on Windows:
In the Windows task bar, search for control panel.
In the control panel, open Add/remove programs.
Follow the instructions to uninstall StackState Agent V2.
StackState Agent V2 is installed using a script.
- 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 Agent V2 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 .