Snippet Framework Toolkits and Execution Environments

Download this manual as a PDF file

This section explains what you need in place before the Snippet Framework can actually collect data. It covers the fact that the framework does not include any built-in collection steps, and that toolkits supply those steps for specific protocols (CLI, REST, and Prometheus). It also explains what Execution Environments are, why every snippet-based Dynamic Application requires one, and why the "Low-code Tools" PowerPack is the recommended starting point for new development.

Toolkits and Execution Environments Overview

The Snippet Framework is an execution engine. It defines how steps run, how data flows between them, and how pipelines are assembled. It does not, however, provide any step implementations of its own.

All step implementations are provided by toolkits.

Toolkits

A toolkit is a library of step implementations for a specific data collection protocol. Toolkits register their steps with the Snippet Framework so that snippet arguments can reference them by name.

Without a compatible toolkit installed and available in an Execution Environment, the framework cannot execute any collection steps. Toolkits are the mechanism through which the Snippet Framework connects to external systems.

ScienceLogic provides three toolkits:

Toolkit Collection Method Typical Use Cases
CLI Toolkit

SSH, local commands

 Network device CLI, OS-level metrics, file parsing
REST Toolkit

HTTP/HTTPS API requests

 REST APIs, JSON or XML responses, OAuth, paging
Prometheus Toolkit

Prometheus metrics scraping

 Cloud-native monitoring, Kubernetes, time-series metrics

For snippet-based Dynamic Applications that use the REST Toolkit to collect data over HTTPS, SSL certificate verification during collection is controlled by the Verify SSL for Collections by Default setting on the Behavior Settings page (System > Settings > Behavior). This setting is disabled by default. For more information, see the System Administration manual.

Execution Environments

An Execution Environment is a named Python virtual environment that packages the ScienceLogic Libraries (toolkits) needed for a collection. Every snippet-based Dynamic Application requires a compatible Execution Environment to be selected.

When a Dynamic Application runs, the Snippet Framework resolves the Execution Environment specified in the Dynamic Application to determine which library versions, and therefore which step implementations are available for that collection.

Execution Environments are managed through the Skylar One user interface in the ScienceLogicLibrary Manager page (System > Customize > ScienceLogic Libraries). A Dynamic Application's Execution Environment must include the library version that provides the steps references in its snippet arguments. "Low-code Tools" PowerPack installations automatically make the corresponding Execution Environment available.

For instructions on managing Execution Environments, see the Dynamic Application Development manual.

The Low-Code Tools PowerPack

Over time, the three individual toolkit PowerPacks (CLI, REST, Prometheus) have been consolidated into the "Low-Code Tools" PowerPack. This PowerPack is the current recommended toolkit for all new snippet-based Dynamic Application development.

Version 104 of the "Low-code Tools" PowerPack is included in the Skylar One 12.5.20 ISO.

The "Low-code Tools" PowerPack contains the following capabilities and features:

  • A single, versioned package containing all three toolkit step implementations
  • A standardized Execution Environment
  • Bundled directly in Skylar One releases starting with version 12.6.0, meaning it does not require a separate PowerPack installation in those environments

The individual CLI, REST, and Prometheus Toolkit PowerPacks continue to exist as legacy documents. They describe the toolkit implementations as they existed before consolidation. For most users working with current Skylar One releases, see the Low-Code Tools PowerPack manual.