Introduction

This section describes the Snippet Framework: the execution engine within Skylar One that runs snippet-based monitoring logic. It explains how the framework is structured, how it executes monitoring workflows, and how it relates to the toolkits, PowerPacks, Dynamic Applications, and user interface tools that depend on it.

This manual is intended for:

• Monitoring developers who build Dynamic Applications using snippet-based workflows.
• System administrators who install, configure, and manage snippet-based monitoring content.
• Technical architects who need to understand how Skylar One's monitoring execution layer works. This section focuses on concepts and configuration. It is not a step-by-step guide.

This manual focuses on the Snippet Framework’s execution model and architecture. For instructions on building Dynamic Applications in the Skylar One user interface, see the Dynamic Application Development and Snippet Dynamic Application Development manuals.

For more information, visit the Developer Documentation site for the full documentation.

Prerequisites

Before reading this manual, you should be familiar with:

• Basic Skylar One administration, including devices, credentials, and PowerPacks.

• The concept of Dynamic Applications and how they define monitoring behavior. See the Dynamic Application Development manual for an introduction.

Familiarity with YAML syntax is helpful but not required.

Related Manuals

Standalone Manuals

Manuals	What It Covers
Dynamic Application Development	The foundational reference for building Dynamic Applications of any type. Covers how to configure Dynamic Application properties, collection objects, presentation objects, alerts, and thresholds. Also covers caching, collector affinity, and Execution Environments. Start here before reading any protocol-specific manual.
ScienceLogic Libraries and Execution Environments	Covers the Python virtual environments (Execution Environments) and ScienceLogic Libraries that the Snippet Framework depends on to run toolkit steps. Explains how to install, update, and align libraries to Dynamic Applications.
Dynamic Application Builder	Covers the Dynamic Application Builder, a standalone desktop tool (part of the Skylar One Studio suite) for building snippet-based Dynamic Applications on your local machine. Walks through installing the tool, creating credentials, building Dynamic Applications using a step-by-step wizard, and exporting them to a Skylar One system.

PowerPack Manuals

Manuals	What It Covers
CLI: Toolkit PowerPack	Covers the "CLI: Toolkit" PowerPack, which adds command-line and SSH-based collection steps to the Snippet Framework. Includes installation instructions, an overview of what the PowerPack provides (execution environment, template PowerPack, support for caching and pagination), and links to the full step reference in the developer docs.
REST: Toolkit PowerPack	Covers the "REST: Toolkit" PowerPack, which adds HTTP/REST API collection steps to the Snippet Framework. Includes installation instructions and an overview of the REST libraries, execution environment, example Dynamic Applications, and built-in credential support for REST authentication.
Prometheus: Toolkit PowerPack	Covers the "Prometheus: Toolkit" PowerPack, which adds PromQL-based metrics collection steps to the Snippet Framework. Includes installation instructions and an overview of the PromQL execution environment, template PowerPack, and supported authentication types (Basic, Bearer Token, API Key, OAuth2).
Low-code Tools PowerPack	Covers the "Low-code Tools" PowerPack, the single consolidated toolkit that replaces the individual CLI, REST, and Prometheus Toolkit PowerPacks. Provides steps for REST, CLI, SSH, SNMP, Prometheus, JMX, and WinRM collection in one unified package. Recommended for all new Snippet Framework development.

What Is the Snippet Framework?

The Snippet Framework is the execution layer within Skylar One that runs reusable pieces of monitoring logic called snippets. Instead of relying on large, monolithic scripts, the framework breaks monitoring functionality into smaller, focused units that can be configured, combined, and reused across multiple monitoring workflows.

Snippets are designed to perform specific, well‑defined tasks, such as:

• Running a command or request
• Calling a REST API
• Parsing or transforming structured output
• Processing monitoring results before they are stored

The Snippet Framework coordinates how these snippets are executed, how data is passed between them, and how execution steps are sequenced to support complex monitoring use cases. This approach enables low‑code monitoring development while still supporting advanced customization when needed.

How the Snippet Framework Fits into Skylar One

Monitoring in Skylar One is defined and executed through a layered architecture, with each layer responsible for a specific role.

At a high level:

• Dynamic Applications define what to monitor and when monitoring runs.
• The Snippet Framework executes the monitoring logic required to collect and process data.
• Toolkits provide collections of prebuilt snippets that perform data collection and processing using specific technologies.
• PowerPacks package and distribute snippets, toolkits, Dynamic Applications, and related components.

Dynamic Applications act as the top‑level definition. When a Dynamic Application executes, it invokes the Snippet Framework to run one or more snippets that perform the underlying collection and processing work.

Snippets and Snippet Arguments

A snippet is a reusable unit of execution within a monitoring workflow. Snippets are intentionally generic, allowing them to be reused across multiple Dynamic Applications without modification. Snippet behavior is controlled through snippet arguments, which allow configuration without writing custom code. This argument‑driven approach is a core design principle of the Snippet Framework.

Examples include:

• A REST snippet that accepts arguments for API endpoints, authentication methods, or paging behavior.
• A CLI snippet that accepts arguments for command strings, timeout values, or parse patterns.

By externalizing behavior into configuration, the Snippet Framework enables low‑code monitoring workflows while maintaining flexibility and reusability.

Snippets Execution Model

The Snippet Framework can be thought of as an execution pipeline that assembles and runs monitoring logic based on configuration input.

During execution:

• Dynamic Applications supply execution context and snippet arguments.
• The framework determines the required execution steps.
• Snippets provided by toolkits perform request, processing, and transformation tasks.
• Results are returned to Skylar One for storage, analysis, and visualization.

The framework manages sequencing, error handling, and data flow so that developers can focus on defining what to collect rather than implementing execution mechanics.

Toolkits, Low‑Code Tools, and the Snippet Framework

The Snippet Framework itself does not collect data. All data collection logic is supplied through toolkits, which are distributed as PowerPacks.

Common examples include:

• CLI Toolkit, for command-line-based data collection
• REST Toolkit, for API-based monitoring
• Prometheus Toolkit, for metric-driven monitoring

These toolkits provide reusable snippets that follow common conventions and are designed to work seamlessly with the Snippet Framework.

Over time, many standalone toolkits have been consolidated into the "Low‑Code Tools" PowerPack, which provides a standardized execution environment and unified set of snippets for building Dynamic Applications across multiple technologies.

PowerPacks and Distribution

Snippets and toolkits are distributed through PowerPacks. A PowerPack may include:

• Snippets and toolkit libraries
• Dynamic Applications that reference those snippets
• Execution environments and supporting assets

PowerPacks allow Snippet Framework-based monitoring logic to be shared, versioned, and deployed consistently across Skylar One systems. Administrators manage PowerPacks through standard Skylar One import and installation workflows.

The Snippet Framework and the User Interface

Although the Snippet Framework is a backend execution system, it is configured and managed through the Skylar One user interface.

When you create or modify snippet‑based Dynamic Applications, they typically interact with:

• Snippets arguments
• Execution order
• Toolkit-provided steps

The user interface experience is commonly referred to as the Dynamic Application Builder, which acts as a bridge between the Skylar One user interface and the underlying Snippet Framework.

This manual focuses on the Snippet Framework’s execution model and architecture. For step‑by‑step instructions on configuring Dynamic Applications or working with snippets in the Skylar One user interface, see the Dynamic Application Development manual

Best Practices for Using the Snippet Framework

When working with the Snippet Framework:

• Design snippets to perform a single, focused task.
• Favor configuration through snippet arguments over custom logic.
• Reuse toolkit‑provided snippets whenever possible.
• Treat shared snippets as platform building blocks and manage changes carefully.

As snippet libraries grow, consistent naming, documentation, and lifecycle management become essential to maintaining long‑term stability.