Send events to StackState from an external system
StackState Self-hosted v5.1.x
PreviousPush data to StackState from an external systemNextSet up a mirror to pull telemetry data from an external system
Last updated
StackState v5.1
StackState Self-hosted v5.1.x
Last updated
This tutorial shows you how to send events from external systems to StackState.
StackState creates a real-time map over your IT landscape and tracks all changes that occur. These changes are visible as events in the .
This tutorial shows how you can submit external events to StackState.
contains a sample project with a that will process a report of a Puppet configuration run and send events to StackState.
In StackState, the events visible in the Events Perspective are related to elements (components or relations). In our example, the events sent to StackState by the report processor will be related to the host that Puppet runs on.
The sample project uses to provision a virtual machine with Puppet and the sample report processor installed. If you don't have access to Vagrant, read how you can .
Clone the repository to your laptop to get started.
Before you get started, StackState must be configured to handle the data that will be sent from the sample project. The project uses a StackState Agent installed on the virtual machine to send data in a format that's consumed by the StackState Agent V2 StackPack.
The sample project will handle installation of a StackState Agent on the virtual machine. You will need to install the Agent V2 StackPack in StackState to interpret the data it sends. If you're running the tutorial on an existing instance of StackState, we advise you to install a dedicated instance of the Agent V2 StackPack for the tutorial. This will allow you to easily clean up and remove all configuration and topology imported during the tutorial when you're finished.
First, boot the virtual machine using Vagrant:
Vagrant will download a virtual machine image and provision a virtual machine. When it's finished, you can log into the machine using the command:
The rest of this tutorial assumes you are running as the root user. Use the following command to change to root in your virtual machine:
Before running the example, you need to configure the sample project with your StackState instance URL and API key.
That's it, you are now ready to run the example.
The sample project is shipped with a single run.sh script that does the following:
Check for the presence of the STS_STS_URL and STS_API_KEY environment variables.
Place the environment variables in the correct configuration files.
Install StackState Agent V3 if it isn't already installed.
Start StackState Agent V3 if it isn't already started.
Invoke Puppet to make some configuration changes to the virtual machine.
Now, go ahead and trigger the script:
The event will be visible in the StackState Events Perspective:
If you don't have access to Vagrant, you can also submit the JSON to StackState directly using the command below.
When you are done running the example, exit the shell and use the following command to terminate the virtual machine:
When you are done with this tutorial, you can remove the configuration from your StackState instance as follows:
Uninstall the Agent V2 StackPack. This will remove the configuration and data received (topology) from StackState.
Once the Puppet run is finished, the report processor is invoked and formats a JSON message that it sends to StackState. You can see the .
For these events to appear in StackState, the component representing the virtual machine must be present with the identifier urn:host:/localhost.localdomain. See how to .
