# About StackState Agent V3 ## Overview StackState Agent V3 functions as a collector and gateway. It connects to external systems to retrieve data and pushes this to StackState. ## About the Agent ### Architecture StackState Agent V3 can be run on Linux systems or inside a Docker container. It isn't necessary to deploy StackState Agent V3 on every machine to retrieve data. Each deployed StackState Agent can run multiple checks to collect data from different external systems. ![StackState Agent architecture](https://2702698828-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ft9xRpVRApnyVQrX3f8HH%2Fuploads%2Fgit-blob-4da588b5425eeed4c229e763ab662a426d49d3ab%2Fstackstate-agent.svg?alt=media) * In [Docker Swarm mode](https://archivedocs.stackstate.com/5.1/setup/docker#docker-swarm-mode), the Cluster Agent is deployed on the manager node and one Agent on each node. * On [Kubernetes or OpenShift](https://archivedocs.stackstate.com/5.1/setup/agent/kubernetes-openshift) clusters, a single Cluster Agent is deployed per cluster and one Agent on each node. The Checks Agent runs checks that are configured on the Cluster Agent. ### Integrations In StackState, the [StackState Agent V2 StackPack](https://archivedocs.stackstate.com/5.1/stackpacks/integrations/agent) includes all the settings required to integrate with a number of external systems. Data from other external systems can be retrieved by installing additional StackPacks in StackState. To integrate with an external system, an Agent must be deployed in a location that can connect to both the external system and StackState. An Agent check configured on the Agent can then connect to the external system to retrieve data. Documentation for the available StackState integrations, including how to configure the associated Agent checks, can be found on the [StackPacks > Integrations pages](https://archivedocs.stackstate.com/5.1/stackpacks/integrations). ### Open source StackState Agent V3 is open source and can be found on GitHub at: . ### Processes and overhead StackState Agent V3 consists of up to four different processes - `stackstate-agent`, `trace-agent`, `process-agent` and `cluster-agent`. To run the basic Agent, the resources named below are required. These were observed running StackState Agent V2 (v2.13.0) on a c5.xlarge instance with 4 vCPU cores and 8GB RAM. They give an indication of the overhead for the most simple set up. Actual resource usage will increase based on the Agent configuration running. This can be impacted by factors such as the Agent processes that are enabled, the number and nature of checks running, whether network connection tracking and protocol inspection are enabled, and the number of Kubernetes pods from which metrics are collected on the same host as the Agent. {% tabs %} {% tab title="stackstate-agent" %} | Resource | Usage | | ------------ | ---------------------------------------------------------------------- | | CPU | \~0.18% | | Memory | 95-100MB RAM | | Disk space | 416MB (includes `stackstate-agent`, `process-agent` and `trace-agent`) | | {% endtab %} | | {% tab title="process-agent" %} | Resource | Usage | | ------------ | ---------------------------------------------------------------------- | | CPU | up to 0.96% | | Memory | 52-56MB | | Disk space | 416MB (includes `stackstate-agent`, `process-agent` and `trace-agent`) | | {% endtab %} | | {% tab title="trace-agent" %} | Resource | Usage | | ------------- | ---------------------------------------------------------------------- | | CPU | less than 0.04% | | Memory | less than 16.8MB | | Disk space | 416MB (includes `stackstate-agent`, `process-agent` and `trace-agent`) | | {% endtab %} | | | {% endtabs %} | | On Kubernetes, limits are placed on CPU and memory usage of the Agent, Cluster Agent and Cluster checks. These can be configured in the [Agent Helm chart (github.com)](https://github.com/StackVista/helm-charts/tree/master/stable/stackstate-agent). ## Running the Agent ### Deployment Deployment instructions, commands to work with StackState Agent V3 and other platform-specific details can be found on the pages listed below: * [StackState Agent V3 on Docker](https://archivedocs.stackstate.com/5.1/setup/agent/docker) * [StackState Agent V3 on Kubernetes](https://archivedocs.stackstate.com/5.1/setup/agent/kubernetes-openshift) * [StackState Agent V3 on Linux](https://archivedocs.stackstate.com/5.1/setup/agent/linux) * [StackState Agent V2 on Windows](https://archivedocs.stackstate.com/5.1/setup/agent/windows) ### Connect to StackState #### Receiver API address StackState Agent connects to the StackState Receiver API at the configured ``. {% tabs %} {% tab title="Kubernetes" %} For StackState running on Kubernetes or OpenShift, the `` is by default: `https:///receiver/stsAgent` The `` is set during StackState installation. For details see [Kubernetes install - configuration parameters](https://archivedocs.stackstate.com/5.1/install-stackstate/kubernetes_openshift/kubernetes_install#generate-values.yaml). {% endtab %} {% tab title="Linux" %} For StackState running on Linux, the `` is by default: `https:///stsAgent` The `` is set during StackState installation. For details see [Linux install - configuration parameters](https://archivedocs.stackstate.com/5.1/install-stackstate/linux/install_stackstate#configuration-options-required-during-install). {% endtab %} {% tab title="StackState SaaS" %} For the StackState SaaS product, the StackState Receiver API address will be provided on the StackState UI Agent V2 StackPack page after the StackPack has been installed. [➡️ Go to the StackState SaaS product documentation](https://docs.stackstate.com/v/stackstate-saas/) {% endtab %} {% endtabs %} #### Receiver API key StackState Agent requires the StackState Receiver API key to communicate with the StackState Receiver API. {% tabs %} {% tab title="Kubernetes" %} For StackState running on Kubernetes, the Receiver API Key is set during installation. For details see [StackState Kubernetes install - configuration parameters](https://archivedocs.stackstate.com/5.1/install-stackstate/kubernetes_openshift/kubernetes_install#generate-values-yaml) {% endtab %} {% tab title="Linux" %} For StackState running on Linux, the Receiver API Key is set during installation. For details see [StackState Linux install - configuration parameters](https://archivedocs.stackstate.com/5.1/install-stackstate/linux/install_stackstate#configuration-options-required-during-install) {% endtab %} {% tab title="StackState SaaS" %} For the StackState SaaS product, the StackState Receiver API key will be provided on the StackState UI Agent StackPack page after the StackPack has been installed. [➡️ Go to the StackState SaaS product documentation](https://docs.stackstate.com/v/stackstate-saas/) {% endtab %} {% endtabs %} ### Troubleshooting #### Log files and debug mode For details of how to set the Agent log level to debug and access the Agent logs, see the platform-specific Agent pages: * [StackState Agent V3 on Docker](https://archivedocs.stackstate.com/5.1/setup/docker#troubleshooting) * [StackState Agent V3 on Kubernetes](https://archivedocs.stackstate.com/5.1/setup/kubernetes-openshift#troubleshooting) * [StackState Agent V3 on Linux](https://archivedocs.stackstate.com/5.1/setup/linux#troubleshooting) * [StackState Agent V2 on Windows](https://archivedocs.stackstate.com/5.1/setup/windows#troubleshooting) #### 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). ## Release notes Release notes for StackState Agent V3 can be found on GitHub at: ## See also * [StackState Agent V2 StackPack](https://archivedocs.stackstate.com/5.1/stackpacks/integrations/agent) * [StackState integrations](https://archivedocs.stackstate.com/5.1/stackpacks/integrations) * [StackState Agent V1 (legacy)](https://archivedocs.stackstate.com/5.1/setup/agent/agent-v1)