.. include:: ../common.txt
.. include:: ../links.txt


###############################
|TOOLKIT_PROMETHEUS| PowerPack
###############################


********
Overview
********

The |TOOLKIT_PROMETHEUS| PowerPack allows users to build Dynamic Applications
that monitor Prometheus using PromQL, a functional query language (Prometheus
Query Language) that lets users select and aggregate time series data in real
time. The SL1 platform collects data using these Dynamic Applications to
monitor, visualize, and forecast information.

The |TOOLKIT_PROMETHEUS| PowerPack includes:

* 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 (more information about `authentication types`_).


*************
Prerequisites
*************

Before building a Dynamic Application with this PowerPack, you should
familiarize yourself with the `Snippet Framework`_ material. This material
provides the necessary workflows and procedures you will use the PowerPack to
complete a Prometheus Dynamic Application build.

Other areas to be familiar with include:

* `How to Build Dynamic Applications with the Snippet Framework`_


****************************************
Using the |TOOLKIT_PROMETHEUS| PowerPack
****************************************

To build a successful PromQL Dynamic Application with this PowerPack:

* Import and install the |TOOLKIT_PROMETHEUS| PowerPack.
* Determine the correct Authentication Method to use.
* Configure a Credential.
* Define your Dynamic Applications by using the :ref:`sf_avail_steps`
  in this Toolkit.

See the `Snippet Framework Development tutorial`_ to help walk through
|TOOLKIT_PROMETHEUS| PowerPack usage.


********************
Authentication Types
********************

Authentication is crucial to the collection of data with the
|TOOLKIT_PROMETHEUS| PowerPack. The |SNIPPET_FRAMEWORK| uses requests to
collect data. Meaning, you must ensure that you are using the correct
authentication method for data collection. The |TOOLKIT_PROMETHEUS| will not
make device data requests until a successful authentication attempt has been
made. This PowerPack supports these types of authentications:

* Basic
* Bearer Token
* API Key
* Oauth2

For more information review `authentication types`_ of the |TOOLKIT_REST|.


****************************************************************
Defining your Dynamic Applications with the |TOOLKIT_PROMETHEUS|
****************************************************************

The Prometheus Library can be used as a set of available steps. These
:ref:`sf_avail_steps`, when followed completely, enable low-code development
capabilities for Prometheus PowerPacks. Without the need for Python
development, the building time for Prometheus PowerPacks will decrease.


***************
Troubleshooting
***************

After you build a |SNIPPET_FRAMEWORK| Dynamic Application using the steps
called out in the |TOOLKIT_PROMETHEUS|, you may want to troubleshoot any
|SNIPPET_FRAMEWORK| authentication issues that arise.

To troubleshoot a built Dynamic Application:

1. Click **Manage > Credentials** to access the Credentials page.
2. Assure that your authentication type is selected from the Authentication
   Type drop-down menu.
3. Set Logging Debug as **[True]**. The debug option displays information from
   the SL1 collector to the authentication endpoint.
4. Click **[Save & Test]**.
5. Click **[Devices]** in the side page menu to navigate to the Devices page.
6. Select your Device from the Devices list and click the **[Collections]**
   tab.
7. Click the **Ellipses (…)** button to the right of your Dynamic Application
   and select **[Run Now]**.

If you encounter issues while using the |TOOLKIT_PROMETHEUS| or |SNIPPET_FRAMEWORK|,
you can find additional information at `Logging/Debugging`_.


***********
Limitations
***********

The |TOOLKIT_PROMETHEUS| does not supports the following metric types:

* Histogram
* Summary


************
Known Issues
************

Some fields may display incorrectly when a user changes a previously selected
Authentication Type to a new type in the Prometheus Snippet Framework
credential. To correct these fields, you must close out the in-progress
configuration of the credential without saving. Then, re-open and select the
desired Authentication Type.