Skip to content

Latest commit

 

History

History
119 lines (88 loc) · 5.56 KB

README.md

File metadata and controls

119 lines (88 loc) · 5.56 KB
Raw

Perses

build go react Go Report Card Gitpod ready-to-code

Overview

Perses is part of the CoreDash community. It belongs to the Linux Foundation. At a later stage, we want to promote the project to the Cloud Native Computing Foundation and be part of the monitoring tools like Prometheus or Thanos.

Perses is going to tackle multiple different goals:

  1. It aims to become a standard dashboard visualization tool for Prometheus and other datasources. It will focus on being GitOps-compatible and thus enabling a smooth "dashboards as code" workflow via a new and well-defined dashboard definition model.
  2. While becoming another visualization tool, Perses also aims to provide different npm packages, so it can benefit to anyone that would like to embed charts and dashboards in their UI. For example, these packages might be used to improve the display of the data in the Prometheus UI.
  3. It also aims to offer a Kubernetes-native mode in which dashboard definitions can be deployed into and read from individual application namespaces (Using CRDs). For more information you can take a look at the doc that would give you an idea of how it would work.
  4. To be friendly to dashboard as code users, we want to provide a complete static validation of the dashboard format. That means you will be able to validate your dashboard in a CI/CD using the Perses CLI (named percli)
  5. The architecture should support plugins (at least for the panels)

Status

While we already released a certain amount of versions, Perses is still in an early alpha stage and still work in progress. The current pieces that are in place are:

  • The Plugin architecture has finally reached a stable point.
    • The plugins concerned the Variables, the Panels, The Queries and the Datasources definitions.
    • To provide a good static validation, the backend is using multiple Cue schemas and the CLI has the lint command. All schemas are available in the schemas folder.
  • A backend REST API provides R/W access to dashboard and datasource definitions.
  • A CLI that can be used to interact with the REST API. A short docs is available here
  • While the UI is still in progress, we already have:
    • a beginning of navigation that will help to move from a dashboard to another.
    • a support of the following panel types:
      • Time series charts.
      • Gauge panels.
      • Stat panels (single value with sparkline).
      • Markdown panels (as an alternative to the Text panel)
    • The editing of dashboard is well advanced. Most of the remaining work is in panel options, right now you have to use the JSON editor for a lot of properties, but those will be form controls soon.
  • A migration script that will help to move from Grafana to Perses is on going.
  • The dashboard data model is still evolving along with the dashboard implementation and new requirements. Before reaching a stable state regarding the data model, we are waiting for feedback to know if we need to adjust and potentially break things.

What's next

Here is a not ordered list of what it can come in the future in Perses:

  • Perses native on Kubernetes using CRDs
  • Traces Visualization support
  • Docs, a lot of docs :)
  • Generating Panel #200
  • Sub folder management #183
  • Datasource discovery #74

Install

There are various ways of installing Perses.

Precompiled binaries

Precompiled binaries for released versions are available in the GitHub release. Using the latest release binary is the recommended way of installing Perses.

Docker images

Docker images are available on Docker Hub.

You can launch a Perses container for trying it out with:

docker run --name perses -d -p 127.0.0.1:8080:8080 persesdev/perses

Building from source

To build Perses from source code, You need:

Start by cloning the repository:

git clone https://github.com/perses/perses.git
cd perses

Then you can use make build that would build the web assets and then Perses itself (and also the Perses CLI that can be used to interact directly with the Perses API in case you prefer to browser the API using a terminal).

make build
./bin/perses --config=your_config.yml

Contributing and development

General instructions about how you can contribute to Perses are available in the document CONTRIBUTING.md.

In case you are more interested into the React UI development, please refer to UI Readme. It will give you instruction about how to build, run or test the React UI. It will also some insight about how it is designed.

License

The code is licensed under an Apache 2.0 license.