logo
Use Prometheus metrics to monitor your infrastructure and application. If you don’t have a running Prometheus instance, you can use our starter kit to start it up - instructions below!

Setup

In order to enable Prometheus Provider in Fiberplane you need to either add it via direct access (for an openly accessible URL) or add it as a valid entry in the data_source.yaml configuration.
The data_sources.yaml format for adding a Prometheus Provider looks like this:
yaml
# data_sources.yaml # # Replace the following line with the name of the data source - name: prometheus-prod description: Prometheus (Production) providerType: prometheus config: # Replace the following line with your Prometheus URL url: http://prometheus # If accessing your Prometheus requires authentication - add the token below token: <TOKEN>

Starter kit

The Prometheus starter-kit uses Docker to run the following as Docker containers:

Pre-Requisites

docker and docker-compose - Installed and running. These are used to run containers locally.
Fiberplane CLI - Enables you to create & manage templates, notebooks, proxy API keys and more via cli.
Proxy API token - Can be created either on Fiberplane Studio (UI) or via CLI.
It's possible to replace docker with podman when using our starter kits. If you wish to do so, we recommend installing podman-compose and replacing all docker-compose commands with podman-compose. All other aspects remain the same.

docker-compose

  • Clone the quickstart repository git clone https://github.com/fiberplane/quickstart.git
  • Go to the relevant directory: cd starter-kits/prometheus/docker-compose
  • Create an .env file and add in the proxy API token generated in step 3 of the Pre-Requisites. e.g : FP_PROXY_TOKEN=yourtokenhere
  • Spin it up! docker-compose up -d

Verify the installation

Verify that the containers are up and running (run docker ps).
Here is a sample output of what you should see
Image without caption

Explore the data on Fiberplane

Now that you have everything setup, you are ready to create your first notebook. We recommend following the instructions below to do so using our starter kit template.
  1. Get the template - cd ../ (prometheus directory)
  1. Add the template jsonnet file to Fiberplane: fp templates create --title="My prometheus template" fp-prom-starter-template.jsonnet >> Make a note of the template id.
  1. Now you can create a notebook using the template you just created. On Fiberplane studio, click on templates >> your template >> New notebook >> Create Notebook. This is also doable using CLI, just make sure you have the template id from step 2 - fp templates expand <templateid>
  1. Click the notebook link and you will have a notebook with few prometheus queries pre-populated. Select your datasource my Prometheus
Image without caption
  1. Now run each query by hitting CTRL + ↩︎ (Mac: ⌘ + ↩︎) or by clicking the play button next to each query cell.
Image without caption

Helpful?