# Windows ## Overview {% hint style="info" %} **StackState Agent V2** {% endhint %} 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 [StackState Agent V2 StackPack](/5.1/stackpacks/integrations/agent.md) must be installed in your StackState instance. For details of the data retrieved and available integrations, see the [StackPack integration documentation](/5.1/stackpacks/integrations.md). ## Monitoring 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. ## Setup ### Supported versions StackState Agent V2.19.x is supported to run on: * Windows 10 or higher * Windows Server 2012 or higher ### Install StackState Agent V2 is installed using a [PowerShell (learn.microsoft.com)](https://learn.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7.2\&viewFallbackFrom=powershell-6) script. * [Online install](#online-install) - If you have access to the internet on the machine where the Agent will be installed. * [Offline install](#offline-install) - If you **don't** have access to the internet on the machine where the Agent will be installed. {% hint style="info" %} * `` is set during StackState installation. * `` is specific to your installation of StackState. For details see [StackState Receiver API](/5.1/setup/agent/about-stackstate-agent.md#connect-to-stackstate). {% endhint %} #### Online install 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. ``` . { iwr -useb https://stackstate-agent-2.s3.amazonaws.com/install.ps1 } | iex; ` install -stsApiKey "" ` -stsUrl "" ``` #### Offline install 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. 1. Download the PowerShell install script and copy this to the host where it will be installed: * 2. 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: * 3. 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: ``` Import-Module C:\install_script.ps1 install -stsApiKey ` -stsUrl ` -f C:\\stackstate-custom.msi ``` ### Upgrade To upgrade StackState Agent V2 running on Windows, 1. 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: * 2. Double-click the downloaded `*.msi` file. ## Configure ### Agent configuration 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. ### Advanced Agent configuration 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 [advanced Agent configuration](/5.1/setup/agent/advanced-agent-configuration.md). ### Integration configuration 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. Documentation for the available StackState integrations, including configuration details can be found on the [StackPacks > Integrations pages](/5.1/stackpacks/integrations.md). ### Proxy configuration The Agent can be configured to use a proxy for HTTP and HTTPS requests. For details, see [use an HTTP/HTTPS proxy](/5.1/setup/agent/agent-proxy.md). ## Commands {% hint style="info" %} Commands require elevated privileges. {% endhint %} ### Start, stop or restart the Agent To manually start, stop or restart StackState Agent V2: {% tabs %} {% tab title="CMD" %} ``` "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" start-service "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" stopservice "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" restart-service ``` {% endtab %} {% tab title="PowerShell" %} ``` & "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" start-service & "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" stopservice & "C:\Program Files\StackState\StackState Agent\embedded\agent.exe" restart-service ``` {% endtab %} {% endtabs %} ### Status To check if StackState Agent V2 is running and receive information about the Agent's status: ``` "./agent.exe status" ``` ### Manually run a check Use the command below to manually run an Agent check once and output the results. ```yaml C:\Program Files\StackState\StackState Agent\embedded\agent.exe check ``` ## Troubleshooting To troubleshoot the Agent, try to [check the Agent status](#status) or [manually run a check](#manually-run-a-check). ### Log files 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` ### Debug mode 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: 1. Edit the file `C:\ProgramData\StackState\stackstate.yaml` 2. To set the log level to `DEBUG`, add the line: ``` log_level: debug ``` 3. To also include the topology/telemetry payloads sent to StackState in the Agent log, add the line: ``` log_payloads: true ``` 4. Save the file and [restart the Agent](#start-stop-or-restart-the-agent) for changes to be applied. ### Support knowledge base Troubleshooting steps for any known issues can be found in the [StackState support knowledge base](https://support.stackstate.com/hc/en-us/search?category=360002777619\&filter_by=knowledge_base\&query=agent). ## Uninstall To uninstall StackState Agent V2 running on Windows: 1. In the Windows task bar, search for **control panel**. 2. In the control panel, open **Add/remove programs**. 3. Follow the instructions to uninstall StackState Agent V2. ## See also * [About StackState Agent V2](/5.1/setup/agent/about-stackstate-agent.md) * [Advanced Agent configuration](/5.1/setup/agent/advanced-agent-configuration.md) * [StackState Agent V2 StackPack](/5.1/stackpacks/integrations/agent.md) * [StackState Agent V2 (github.com)](https://github.com/StackVista/stackstate-agent) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://archivedocs.stackstate.com/5.1/setup/agent/windows.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.