Skip to content

nicolastakashi/community-perses-dashboards

Repository files navigation

Perses Community Dashboards

Welcome to the Perses Community Dashboards repository! This project is designed to provide Prometheus mixins tailored for the Perses platform. Developed with the Perses Go SDK, these dashboards are modular, reusable, and simple to integrate into various observability setups.

Overview of Available Dashboards

Prometheus Dashboards

  • Prometheus Overview
  • Prometheus Remote Write

Node Exporter Dashboards

  • Nodes
  • Cluster USE Method

AlertManager Dashboards

  • AlertManager Overview

Library Panels

In addition to the community dashboards, this repository also offers a library of reusable panels. These panels can be used as building blocks for custom dashboard creation, enabling you to craft tailored setups to suit specific observability needs.

Rendering Dashboards

To render and generate the dashboards, run the following command:

make build-dashboards

The generated dashboard files will be stored as YAML files in the dist directory by default. You can then import these files into your Perses instance.

Local Development Guide

For local development, you can quickly spin up a Perses environment with the following command:

make start-demo

This command initializes a local Perses instance that includes predefined resources such as Projects and DataSources. Once the instance is running, you can access the Perses UI at http://localhost:8080.

Applying Dashboards with percli

To apply the dashboards to your Perses instance, use the percli tool with the following command:

percli apply -d dist/

This will deploy the dashboards from the dist directory to your local Perses instance.