💠 API-Integration

StackState core integration
What is the API-Integration StackPack?
The StackState API-Integration StackPack enables StackState synchronizations through the StackState API-Integration Agent. The API-Integration Agent allows you to run checks that connect to Splunk to collect topology, metrics and events data.
The StackState API-Integration Agent is open source: View the source code on GitHub.
Installation
To install the API-Integration StackPack, go to the StackState UI page StackPacks > Integrations > API-Integration and click INSTALL.
Install the StackState API-Integration Agent by using the following sequence of steps:
Debian, Ubuntu
Amazon linux, CentOS, Fedora, Red Hat
Debian, Ubuntu
Download the API-Integration Agent Debian package or run this command on the machine where you wish to install the Agent:
wget https://s3-eu-west-1.amazonaws.com/agent.stackstate.com/stackstate-agent-deb-repo/pool/s/stackstate-agent/stackstate-agent_1.3.0-1_amd64.deb'
Use dpkg to install the downloaded package:
dpkg -i stackstate-agent_1.3.0-1_amd64.deb
Set the following keys in the stackstate.conf.example file:
 api_key: {{config.apiKey}}
 dd_url: {{config.baseUrl}}/stsAgent/
After this the example configuration can be used as configuration.
 cp /etc/sts-agent/stackstate.conf.example /etc/sts-agent/stackstate.conf
Amazon linux, CentOS, Fedora, Red Hat
Download the API-Integration Agent RPM package or run this command on the machine where you wish to install the Agent:
wget 'https://s3-eu-west-1.amazonaws.com/agent.stackstate.com/stackstate-agent-yum-repo/stackstate-agent_1.3.0-1.x86_64.rpm'
Use rpm to install the downloaded package:
rpm -i stackstate-agent_1.3.0-1.x86_64.rpm
Set the following keys in the stackstate.conf.example file:
 api_key: {{config.apiKey}}
 dd_url: {{config.baseUrl}}/stsAgent
After this the example configuration can be used as configuration.
 cp /etc/sts-agent/stackstate.conf.example /etc/sts-agent/stackstate.conf
If you need further assistance, our support team will be glad to help.
Start / stop / restart the StackState Agent
Commands require elevated privileges.
Restarting the StackState Agent will reload the configuration files.
To manually start, stop or restart the StackState Agent:
Linux
Windows
Linux
sudo /etc/init.d/stackstate-agent start
sudo /etc/init.d/stackstate-agent stop
sudo /etc/init.d/stackstate-agent restart
Windows
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
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
Status and information
Linux
Windows
Linux
To check if the StackState API-Integration Agent is running:
sudo /etc/init.d/stackstate-agent status
To receive information about the StackState API-Integration Agent state:
sudo /etc/init.d/stackstate-agent info
Tracebacks for errors can be retrieved by setting the -v flag:
sudo /etc/init.d/stackstate-agent info -v
Windows
To check if the StackState Agent is running and receive information about the Agent's state:
"./agent.exe status"
Troubleshooting
Try running the info command to see the state of the API-Integration Agent.
Logs for the subsystems are in the following files:
/var/log/stackstate/supervisord.log
/var/log/stackstate/collector.log
/var/log/stackstate/stsstatsd.log
/var/log/stackstate/forwarder.log
If you are still having trouble, contact our support team on the StackState support site.
Release notes
API Integration StackPack v2.4.1 (2021-04-02)
Improvement: Update documentation.
Improvement: Enable auto grouping on generated views.
Improvement: Common bumped from 2.2.3 to 2.5.1
Improvement: StackState min version bumped to 4.3.0
API Integration StackPack v3.0.2 (2021-03-29)
Bugfix: Update the minimum required StackState version to 4.3.0.
API Integration StackPack v3.0.1 (2021-03-25)
Improvement: Update documentation.
API Integration StackPack v3.0.0 (2021-03-25)
Improvement: Enable auto grouping on generated views.
Improvement: Common bumped from 2.2.3 to 2.4.3
API Integration StackPack v2.3.1 (2020-08-18)
Features: Introduced the Release notes pop up for customer
Features: Use the latest StackState Agent V1
API Integration StackPack v2.3.0 (2020-08-04)
Improvement: Deprecated stackpack specific layers and introduced a new common layer structure.
Improvement: Replace resolveOrCreate with getOrCreate.
API Integration StackPack v2.2.0 (2020-06-04)
Features: Token based authentication supported for Splunk.
Features: Updated Splunk integration documents for metrics, events and topology.
Features: Short link for doc site updated.
💠 StackState Agent
💠 AWS
Last updated 1 day ago