LogoLogo
StackState.comDownloadSupportExplore playground
StackState v5.1
StackState v5.1
  • Welcome to the StackState docs!
  • StackState self-hosted v5.1 docs
  • Getting Started
  • 🚀Setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Override default configuration
        • Configure storage
        • Configure Ingress
        • Install from custom image registry
        • Migrate from Linux install
      • Linux
        • Before you install
        • Download
        • Install StackState
        • Install with production configuration
        • Install with development configuration
        • Install with POC configuration
        • Set up a reverse proxy
        • Set up TLS without reverse proxy
      • Initial run guide
      • Troubleshooting
    • Upgrade StackState
      • Steps to upgrade
      • Version specific upgrade instructions
      • StackPack versions
      • StackState release notes
    • StackState Agent
      • About StackState Agent V3
      • Docker
      • Kubernetes / OpenShift
      • Linux
      • Windows
      • Advanced Agent configuration
      • Use an HTTP/HTTPS proxy
      • Agent V1 (legacy)
      • Migrate Agent V1 to Agent V2
        • Linux
        • Docker
    • StackState CLI
      • CLI: sts
      • CLI: stac (deprecated)
      • Comparison between CLIs
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Linux backup
        • Configuration backup
      • Data retention
      • Clear stored data
  • 👤Use
    • Concepts
      • The 4T data model
      • Components
      • Relations
      • Health state
      • Layers, Domains and Environments
      • Perspectives
      • Anomaly detection
      • StackState architecture
    • StackState UI
      • Explore mode
      • Filters
      • Views
        • About views
        • Configure the view health
        • Create and edit views
        • Visualization settings
      • Perspectives
        • Topology Perspective
        • Events Perspective
        • Traces Perspective
        • Metrics Perspective
      • Timeline and time travel
      • Analytics
      • Keyboard shortcuts
    • Checks and monitors
      • Checks
      • Add a health check
      • Anomaly health checks
      • Monitors
      • Manage monitors
    • Problem analysis
      • About problems
      • Problem lifecycle
      • Investigate a problem
      • Problem notifications
    • Metrics
      • Telemetry streams
      • Golden signals
      • Top metrics
      • Add a telemetry stream
      • Browse telemetry
      • Set telemetry stream priority
    • Events
      • About events
      • Event notifications
      • Manage event handlers
    • Glossary
  • 🧩StackPacks
    • About StackPacks
    • Add-ons
      • Autonomous Anomaly Detector
      • Health Forecast
    • Integrations
      • About integrations
      • 💠StackState Agent V2
      • 💠AWS
        • AWS
        • AWS ECS
        • AWS X-ray
        • StackState/Agent IAM role: EC2
        • StackState/Agent IAM role: EKS
        • Policies for AWS
        • AWS (legacy)
        • Migrate AWS (legacy) to AWS
      • 💠Dynatrace
      • 💠Kubernetes
      • 💠OpenShift
      • 💠OpenTelemetry
        • About instrumentations
        • AWS NodeJS Instrumentation
        • Manual Instrumentation
          • Prerequisites
          • Tracer and span mappings
          • Relations between components
          • Span health state
          • Merging components
          • Code examples
      • 💠ServiceNow
      • 💠Slack
      • 💠Splunk
        • Splunk
        • Splunk Events
        • Splunk Health
        • Splunk Metrics
        • Splunk Topology
      • 💠VMWare vSphere
      • Apache Tomcat
      • Azure
      • Cloudera
      • Custom Synchronization
      • DotNet APM
      • Elasticsearch
      • Humio
      • Java APM
      • JMX
      • Logz.io
      • MySQL
      • Nagios
      • OpenMetrics
      • PostgreSQL
      • Prometheus
      • SAP
      • SCOM
      • SolarWinds
      • Static Health
      • Static Topology
      • Traefik
      • WMI
      • Zabbix
    • Develop your own StackPacks
  • 🔧Configure
    • Topology
      • Component actions
      • Identifiers
      • Topology naming guide
      • Topology sources
      • Create a topology manually
      • Configure topology synchronizations
      • Enable email event notifications
      • Send topology data over HTTP
      • Set the topology filtering limit
      • Use a proxy for event handlers
      • Use tags
      • Tune topology synchronization
      • Debug topology synchronization
    • Telemetry
      • Add telemetry during topology synchronization
      • Data sources
        • Elasticsearch
        • Prometheus mirror
      • Send events over HTTP
      • Send metrics data over HTTP
      • Set the default telemetry interval
      • Debug telemetry synchronization
    • Traces
      • Set up traces
      • Advanced configuration for traces
    • Health
      • Health synchronization
      • Send health data over HTTP
        • Send health data
        • Repeat Snapshots JSON
        • Repeat States JSON
        • Transactional Increments JSON
      • Debug health synchronization
    • Anomaly Detection
      • Export anomaly feedback
      • Scale the AAD up and down
      • The AAD status UI
    • Security
      • Authentication
        • Authentication options
        • File based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
        • Subjects
      • Secrets management
      • Self-signed certificates
      • Set up a security backend for Linux
      • Set up a security backend for Windows
    • Logging
      • Kubernetes logs
      • Linux logs
      • Enable logging for functions
  • 📖Develop
    • Developer guides
      • Agent checks
        • About Agent checks
        • Agent check API
        • Agent check state
        • How to develop Agent checks
        • Connect an Agent check to StackState
      • Custom functions and scripts
        • StackState functions
        • Check functions
        • Component actions
        • Event handler functions
        • ID extractor functions
        • Mapping functions
        • Monitor functions
        • Propagation functions
        • Template functions
        • View health state configuration functions
      • Custom Synchronization StackPack
        • About the Custom Synchronization StackPack
        • How to customize elements created by the Custom Synchronization StackPack
        • How to configure a custom synchronization
      • Integrate external services
      • Mirroring Telemetry
      • Monitors
        • Create monitors
        • Monitor STJ file format
      • StackPack development
        • How to create a StackPack
        • Packaging
        • How to get a template file
        • How to make a multi-instance StackPack
        • Prepare a multi-instance provisioning script
        • Upload a StackPack file
        • Prepare a shared template
        • Customize a StackPack
        • Prepare instance template files
        • Prepare a StackPack provisioning script
        • Resources in a StackPack
        • StackState Common Layer
      • Synchronizations and templated files
    • Reference
      • StackState OpenAPI docs
      • StackState Template JSON (STJ)
        • Using STJ
        • Template functions
      • StackState Markup Language (STML)
        • Using STML
        • STML Tags
      • StackState Query Language (STQL)
      • StackState Scripting Language (STSL)
        • Scripting in StackState
        • Script result: Async
        • Script result: Streaming
        • Time in scripts
        • Script APIs
          • Async - script API
          • Component - script API
          • HTTP - script API
          • Prediction - script API
          • StackPack - script API
          • Telemetry - script API
          • Time - script API
          • Topology - script API
          • UI - script API
          • View - script API
    • Tutorials
      • Create a simple StackPack
      • Push data to StackState from an external system
      • Send events to StackState from an external system
      • Set up a mirror to pull telemetry data from an external system
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Provisioning script context
  • The StackState (sts) object
  • The StackPack (stackPack) object
  • The StackPack instance (instance) object
  • The environment (env) object
  • How to ensure consistency between the provisioning script and the template file
  1. Develop
  2. Developer guides
  3. StackPack development

Prepare a StackPack provisioning script

StackState Self-hosted v5.1.x

The provisioning script used for provisioning the StackPack should extend from com.stackstate.stackpack.ProvisioningScript. The provisioning script can be split into multiple groovy scripts. The provisioning directory inside the StackPack is part of the classpath, so any groovy script referred to inside the provisioning directory is also loaded.

A provisioning script is provided with a set of capabilities that it can execute in the StackState environment. The capabilities are restricted to those that are defined as part of com.stackstate.stackpack.ProvisioningContext which is passed as a constructor parameter for the ProvisioningScript.

Here is an example of a provisioning script:

import com.stackstate.stackpack.ProvisioningContext
import com.stackstate.stackpack.ProvisioningIO
import com.stackstate.stackpack.ProvisioningScript
import com.stackstate.stackpack.ProvisioningIO$
import com.stackstate.stackpack.Version

class SomeProvisioningScript extends ProvisioningScript {
  SomeProvisioningScript(ProvisioningContext context) {
      super(context)
  }

  @Override
  ProvisioningIO<scala.Unit> preInstall(Map<String, Object> config) {
    // Return any action that needs to run globally for this StackPack.
  }

  @Override
  ProvisioningIO<scala.Unit> install(Map<String, Object> config) {
    // Return any action that needs to run per StackPack instance.
  }

  @Override
  ProvisioningIO<scala.Unit> upgrade(Map<String, Object> config, Version previousVersion) {
    // Return any action that needs to be done when upgrading each instance from `previousVersion` to the latest.
  }

  @Override
  ProvisioningIO<scala.Unit> uninstall(Map<String, Object> config) {
    // Return any action that needs to run per StackPack instance.
  }

  @Override
  ProvisioningIO<scala.Unit> postUninstall(Map<String, Object> config) {
    // Return any action that needs to run globally for this StackPack.
  }

  @Override
  void waitingForData(Map<String, Object> config) {
    // Determine wether sufficient data has reached StackState.
  }
}

The supported actions are:

  • preInstall - this action is run when installing the very first instance of a StackPack - it's meant to install all the objects that each of the instances will share.

  • install - this action is run for every installed instance of a StackPack - it's meant to install instance-specific objects, that will be of use for this instance only.

  • waitingForData - this action allows the StackPack creator to check wether any external service that this StackPack communicates with is properly sending data that this StackPack can process. By default, it just transitions to the INSTALLED state.

  • upgrade - this action is run for every installed instance of a StackPack when the user upgrades their StackPack version.

  • uninstall - this action is run for every instance when it's being uninstalled - it's meant to clean up all the instance-specific objects.

  • postUninstall - this action is run when uninstalling the very last instance of a StackPack - it's meant to clean up all the StackPack-shared objects.

Provisioning script context

A set of useful objects for the above actions are exposed via the provisioning context accessible via the context() function.

The provisioning script can interact with the provisioning via the context() function:

context()

The context() function returns an object that provides the following functions:

  • scriptsDirectory() - returns the path to the directory where this script resides.

  • fail(errorMessage) - marks this StackPack instance as broken (StackPack is in ERROR state) with errorMessage error message.

The StackState (sts) object

The provisioning script can interact with the StackState instance it's running in via the sts() function:

context().sts()

The sts() function returns an object that provides the following functions:

  • intakeApi() - returns an object representing the StackState Receiver API that receives incoming data. The object supplies the following functions:

    • apiKey() - returns the API_KEY, this is the API key for the StackState Receiver API. Also referred to as the <STACKSTATE_RECEIVER_API_KEY> for clarity in the docs.

    • baseUrl() - returns the RECEIVER_BASE_URL, this is the base URL for the StackState Receiver API. Also referred to as the <STACKSTATE_RECEIVER_API_ADDRESS> for clarity in the docs.

  • log() - allows logging to be done in the provisioning script. Example: context().sts().log().debug("Installing test StackPack").

  • install(stackpackName, parameters) - triggers installation of StackPack stackpackName with parameters parameters.

  • onDataReceived(topic, callback) - runs a callback function whenever data is received by the StackState API on topic topic.

  • provisioningComplete() - called when provisioning is done, marks this StackPack instance state as INSTALLED.

  • createTopologyTopicName(sourceType, sourceId) - formats a StackState Kafka topic name using sourceType and sourceId parameters.

The StackPack (stackPack) object

The provisioning script can interact with the StackPack being installed via the stackPack() function:

context().stackPack()

The stackPack() function returns an object that provides the following functions:

  • importSnapshot(filename, parameters) - imports a template from filename in the StackPack's namespace, filling in the optional parameters substitutions.

The StackPack instance (instance) object

The provisioning script can interact with the StackPack instance being installed via the instance() function:

context().instance()

The instance() function returns an object that provides the following functions:

  • id() - returns the current StackPack instance id.

  • importSnapshot(filename, parameters) - imports a template from filename in the StackPack's namespace, filling in the optional parameters substitutions.

The environment (env) object

The provisioning script can interact with the StackState environment via the env() function:

context().env()

The env() function returns an object that provides the following functions:

  • execute(commandLine, directory, environment) - runs a shell script command commandLine in directory with environment setup.

How to ensure consistency between the provisioning script and the template file

It's time to template out the variables exposed by your StackPack. It's possible to define some input fields that your StackPack requires to authenticate against some external sources and to differentiate between instances. To generalize the configuration, it's needed to inject the configuration file with some template parameters which are provided by the provisioning script. Any parameters or configuration item can be passed down to the .stj template file.

One common example is to create the topic name required by the data source for a given instance. To ensure data received from the StackState Agent Check ends up in your StackPack's data source, make sure that you create the same topic in the provisioning script. The following code snippet shows how to create a function called topicName that generates a topic name for this instance, based on the data provided by the user in the StackPack installation step.

@Override
ProvisioningIO<scala.Unit> install(Map<String, Object> config) {
    def templateArguments = [
        'topicName': topicName(config),
        ... more template variables here ...
    ]
    // we place all the config variables in our template arguments as well.
    templateArguments.putAll(config)

    return context().sts().importSnapshot(context().stackPack().namespacePrefix(), "templates/{stackpack}.stj", templateArguments)
}

private def topicName(Map<String, Object> stackpackConfig) {
    def instance_url = stackpackConfig.instance_url
    def topic = instance_url.replace("/", "_").replace(":", "_")
    return context().sts().createTopologyTopicName("your_instance_type", topic)
}

It's possible now to reference any of the above templateArguments in your .stj template file. In case of the topicName you can replace the topic value in the config section of your StackState DataSource with this parameter:

{
    "_type": "DataSource",
    "name": "StackPack Data Source",
    "identifier": "urn:stackpack:stackpack_name:data-source:stackpack_data_source",
    "config": {
      ...
      "topic": "{{ topicName }}"
    },
    ...
}
PreviousPrepare instance template filesNextResources in a StackPack

Last updated 2 years ago

📖