Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicolastakashi/community-perses-dashboards
Perses Dashboards
https://github.com/nicolastakashi/community-perses-dashboards
dashboards observability perses
Last synced: about 7 hours ago
JSON representation
Perses Dashboards
- Host: GitHub
- URL: https://github.com/nicolastakashi/community-perses-dashboards
- Owner: nicolastakashi
- License: apache-2.0
- Created: 2024-09-27T10:17:11.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T22:24:26.000Z (6 days ago)
- Last Synced: 2024-11-08T22:31:47.314Z (6 days ago)
- Topics: dashboards, observability, perses
- Language: Go
- Homepage:
- Size: 62.5 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
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:
```bash
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](http://localhost:8080).
### Applying Dashboards with `percli`
To apply the dashboards to your Perses instance, use the [percli](https://pkg.go.dev/github.com/perses/perses/cmd/percli) tool with the following command:
```bash
percli apply -d dist/
```
This will deploy the dashboards from the `dist` directory to your local Perses instance.
---