Synchronizations and templated files
This page describes StackState version 4.3.
The StackState 4.3 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.3 version range to upgrade to a more recent release.
To obtain the
.stj
Templated file for your StackPack you need to perform a few steps in StackState Settings page and then edit the template file by hand.Every .stj template is filled with information about the hosts and environments that StackState collects data from. Example of this information looks like this:
{
"nodes": [
{
"_type": "Layer",
"description": "Some layer",
"id": -1,
"identifier": "urn:stackpack:dummy:layer:a",
"name": "A",
"order": 1.0
},
{
"_type": "Layer",
"description": "Some other layer",
"id": -2,
"identifier": "urn:stackpack:dummy:layer:b",
"name": "B",
"order": 2.0
}
],
"timestamp": "2019-05-31T18:36:35Z",
"version": "0.1"
}
Preparing a templated file is a process that requires some configuration of StackState. To get the above file in a structure that can be used to create a StackPack, follow the below route:
The first step is to prepare a check using the Agent V2 StackPack. This step allows for getting data from synchronizations that you configure in the next steps. Find out more about Agent V2 checks.
To install this StackPack go to StackState's StackPacks section and locate the "Custom Synchronization" in Other StackPacks. During the installation process, you need to provide the following information:
- Instance type (source identifier) - this is the identifier for the resource that you want to integrate with StackState, for example, AWS, Azure and Zabbix.
- Instance URL - The URL of the instance the data is being reported for.
When the above information is provided click the "Install" button and if Agent V2 checks are working you should start to see the topology coming in for your integration and the "Custom Synchronization" should become enabled.
Once you have installed Custom Synchronization StackPack, you need to start preparing the configuration that is needed for your integration.
There are some default Layers, Domains, and Environments created by StackState. Layers are used for vertical separation between components; Domains are used for horizontal separation between components; Environments are grouping components. You can add custom Layers, Domains, and Environments in the Settings pages to match your StackPack needs.
These can also be created automatically by StackState using the
getOrCreate
functionality described a little further in this document.There are some default component and relation types in StackState. Component types are used to visualize components with a given icon; Relation types are here to describe relations between components. Read more about Component and Relation types.
Component types and Relation types can also be created automatically by StackState using the
getOrCreate
functionality described in the Component + Relation Templates
section. Auto-generated components types will be created without an icon.When creating a StackPack, it is important to have a
component
and relation
identity extractor function. There are a few default Id Extractor Functions present in StackState. The Auto sync component id extractor
and Auto sync relation id extractor
are good starting points for your StackPack. You can go ahead and rename these, add a description if needed, and confirm the popup dialog to unlock these Id Extractor Functions from the Custom Synchronization
StackPack.