Prometheus: Toolkit PowerPack Overview

Download this manual as a PDF file 

This section describes how to use the "Prometheus: Toolkit" PowerPack.

The "Prometheus: Toolkit" PowerPack is part of the Skylar One Studio suite of tools. For more information, see https://support.sciencelogic.com/s/skylar-one/skylar-one-studio.

The "Prometheus: Toolkit" PowerPack has been superseded by the "Low-code Tools" PowerPack, a single PowerPack that provides CLI, REST, and Prometheus collection steps together. ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. For more information, see the Low-code Tools PowerPack manual.

What is the Prometheus: Toolkit PowerPack?

The "Prometheus: Toolkit" PowerPack adds Prometheus collection capabilities to the Snippet Framework. The Snippet Framework is the recommended method for building Snippet Dynamic Applications in Skylar One. Rather than writing Python code to collect data, you use Snippet Arguments to define what to collect, and the framework runs a series of prebuilt steps to perform the collection.

A toolkit is a PowerPack that supplies a set of these prebuilt steps for a particular collection method. The "Prometheus: Toolkit" PowerPack supplies the steps used to monitor Prometheus using PromQL, a functional query language (Prometheus Query Language) that lets you select and aggregate time series data in real time. The Skylar Onee platform collects data using these Dynamic Applications to monitor, visualize, and forecast information. This is a Python 3 only PowerPack.

If you are not already familiar with the Snippet Framework, see the Snippet Framework manual before using this PowerPack. The "Introduction to Snippet Framework" section explain what the framework is and how it works, the "Snippet Framework Collection Pipeline" section explains steps and the execution model, and the "Snippet Framework Toolkits and Execution Environments" section explains how toolkits such as the "Prometheus: Toolkit" PowerPack supply steps to the framework.

What Does the Prometheus: Toolkit PowerPack Include?

This Prometheus: Toolkit PowerPack provides the ability to create Dynamic Applications that query the Prometheus server without having to write snippet code. This PowerPack includes sample Dynamic Application that can be easily modified and replicated to retrieve metrics from a Prometheus server through PromQL language.

The Prometheus: Toolkit PowerPack includes the following features:

  • A PromQL execution environment.

  • A list of required steps for PromQL Dynamic Application development.

  • A template PowerPack implementation that demonstrates the use of the available steps.

  • Support for these authentication types: Basic, Bearer Token, API Key, and Oauth2.

The "Prometheus: Toolkit" PowerPack does not support the Histogram and Summary metric types.

Some fields might display incorrectly when you change a previously selected Authentication Type to a new type in the Prometheus Snippet Framework credential. To correct this, close the in-progress credential configuration without saving, then reopen it and select the authentication type you want.

For more information about these authentication types, see the "Authentication" section of the REST: Toolkit developer documentation.

Installing the Prometheus: Toolkit PowerPack

To use the Prometheus collection steps described in this manual, you must import and install the latest version of the "Prometheus: Toolkit" PowerPack. The minimum Skylar One version for this PowerPack is 11.3.0.

To download and install a PowerPack:

  1. Search for and download the PowerPack from the PowerPacks page at the ScienceLogic Support Center (Skylar One > PowerPacks, login required).
  2. Go to the PowerPack Manager page (System > Manage > PowerPacks).
  3. In the PowerPack Manager page, click the Actions button, then select Import PowerPack.
  4. The Import PowerPack dialog box appears.
  5. Click the [Browse] button and navigate to the PowerPack file.
  6. When the PowerPack Installer modal appears, click the Install button to install the PowerPack.

If you exit the PowerPack Installer without installing the imported PowerPack, the imported PowerPack will not appear in the PowerPack Manager page. However, the imported PowerPack will appear in the Imported PowerPacks page. This page appears when you click the Actions menu and select Install PowerPack.

Migrating to the Low-code Tools PowerPack

ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. The "Low-code Tools" PowerPack provides the Prometheus collection steps described in this manual, along with steps for CLI, REST, SNMP, JMX, WinRM, and PowerShell collection, in a single PowerPack. If you are starting new development, use the "Low-code Tools" PowerPack rather than the "Prometheus: Toolkit" PowerPack. For more information, see the Low-code Tools PowerPack manual.

Documentation for the Prometheus: Toolkit PowerPack

Full reference documentation for the "Prometheus: Toolkit" PowerPack, including getting started guidance, the complete list of available steps, and Prometheus development best practices, is provided in the Prometheus: Toolkit developer documentation.