Perses is first and foremost a dashboard tool that you can use to display a variety of observability data. It currently supports Prometheus metrics & Tempo traces, with plans to expand its capabilities in the future to include logging, profiling, additional technologies for monitoring and tracing, and more.

Perses is a Cloud Native Computing Foundation sandbox project.

Beyond its core usage, Perses aims to achieve several broader goals:

• Open specification for dashboards. Perses is also an initiative to define a standardized dashboard specification, fostering interoperability across observability tools.
• Integrability. Perses provides various npm packages that allow developers to embed panels and dashboards into their own UIs, benefiting from the work done in Perses. For instance, these packages could be used in the future to enhance data visualization in the Prometheus UI.
• Extensibility. Perses is soon to support plugins, enabling users to extend the tool’s native capabilities to suit specific needs.
• GitOps-friendly. SDKs, CI/CD libraries, static validation, native CLI.. Perses provides everything you need for a great Dashboard-as-Code experience.
• Kubernetes-native mode. Dashboard definitions will be deployable into and readable from individual application namespaces using Custom Resource Definitions (CRDs). For more information on that topic you can take a look at the Perses Operator.

We are providing an online demo available at https://demo.perses.dev. You can create your own project(s) and dashboard(s) there, no one else will be able to modify them!

1. Perses as an application can now be used.
   • The data model reached a stable point, and we are providing multiple panel types that should cover most of the use cases when using Prometheus.
   • Authentication and authorization are available.
2. On the GitOps aspect:
   • We provide a CLI that helps interacting with the API. A short doc is available here
   • Two SDKs (in Golang and in Cuelang) are available to code dashboards. See Dashboard-as-Code guide. Probably these SDKs are going to evolve depending on the feedbacks we might receive. Still it's likely to be about adding more util functions rather than breaking things.
3. We are eager to change the current plugin architecture to make it potentially simpler and above all to be able to externalize the load and the implementation of a plugin.
   • Changes are more on the frontend side. cue/schemas are kept in their current shape as there is no point to remove the static validation of plugins on the backend side.
   • Work is in progress

Current Roadmap is available here

There are various ways of installing Perses.

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 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

To build Perses from source code, You need:

• Go version 1.18 or greater.
• NodeJS version 18 or greater.
• npm version 8 or greater.

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

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

If you are primarily interested in contributing to the UI application and libraries, please refer to the UI Readme. It includes quick start instructions for how to build, run, and test the React UI. It also includes details about the architecture and guidelines for development.

The code is licensed under an Apache 2.0 license.