{"id":13821743,"url":"https://github.com/perses/perses","last_synced_at":"2025-10-03T16:44:44.545Z","repository":{"id":37234662,"uuid":"333211722","full_name":"perses/perses","owner":"perses","description":"The CNCF sandbox for observability visualisation. Already supports Prometheus/Tempo - more data sources to come!","archived":false,"fork":false,"pushed_at":"2025-06-10T16:24:37.000Z","size":38569,"stargazers_count":1396,"open_issues_count":150,"forks_count":102,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-06-10T18:38:42.541Z","etag":null,"topics":["cncf-project","dashboard","monitoring","observability","prometheus"],"latest_commit_sha":null,"homepage":"https://perses.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/perses.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"GOVERNANCE.md","roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-01-26T20:41:33.000Z","updated_at":"2025-06-10T16:24:39.000Z","dependencies_parsed_at":"2023-09-21T19:28:32.360Z","dependency_job_id":"2333c388-be22-4b87-a403-94304da3f880","html_url":"https://github.com/perses/perses","commit_stats":{"total_commits":2107,"total_committers":39,"mean_commits":54.02564102564103,"dds":0.6929283341243474,"last_synced_commit":"a22234836c38d1d849364e054c3dcafef0d6b607"},"previous_names":[],"tags_count":94,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perses%2Fperses","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perses%2Fperses/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perses%2Fperses/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perses%2Fperses/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/perses","download_url":"https://codeload.github.com/perses/perses/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/perses%2Fperses/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259131914,"owners_count":22810495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cncf-project","dashboard","monitoring","observability","prometheus"],"created_at":"2024-08-04T08:01:27.201Z","updated_at":"2025-10-03T16:44:44.539Z","avatar_url":"https://github.com/perses.png","language":"TypeScript","funding_links":[],"categories":["monitoring","Observability \u0026 Monitoring","TypeScript","Go","Observability"],"sub_categories":["Visualization \u0026 Dashboards"],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch1 style=\"border-bottom: none\"\u003e\n    \u003ca href=\"https://github.com/perses\" target=\"_blank\"\u003e\u003cimg alt=\"Perses\" src=\"/docs/images/perses_logo_cropped.svg\"\u003e\u003c/a\u003e\u003cbr\u003ePerses\n\u003c/h1\u003e\n\n[![build](https://github.com/perses/perses/workflows/ci/badge.svg)](https://github.com/perses/perses/actions?query=workflow%3Aci)\n[![go](https://github.com/perses/perses/workflows/go/badge.svg)](https://github.com/perses/perses/actions?query=workflow%3Ago)\n[![react](https://github.com/perses/perses/workflows/react/badge.svg)](https://github.com/perses/perses/actions?query=workflow%3AReact)\n[![Go Report Card](https://goreportcard.com/badge/github.com/perses/perses)](https://goreportcard.com/report/github.com/perses/perses)\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9410/badge)](https://www.bestpractices.dev/projects/9410)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/perses/perses/badge)](https://securityscorecards.dev/viewer/?uri=github.com/perses/perses)\n\n\u003c/div\u003e\n\n## Overview\n\nPerses is first and foremost a dashboard tool that you can use to display a variety of observability data. It currently supports Prometheus metrics \u0026 Tempo traces, with plans to expand its capabilities in the future to include logging, profiling, additional technologies for monitoring and tracing, and more.\n\nPerses is a [Cloud Native Computing Foundation](https://cncf.io) sandbox project.\n\n![img.png](https://perses.dev/assets/images/home/perses_overview.gif)\n\nBeyond its core usage, Perses aims to achieve several broader goals:\n\n- **Open specification for dashboards**. Perses is also an initiative to define a standardized dashboard specification, fostering interoperability across observability tools.\n- **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.\n- **Extensibility**. Perses supports multiple kinds of plugins, enabling users to extend the tool’s native capabilities to suit specific needs.\n- **GitOps-friendly**. SDKs, CI/CD libraries, static validation, native CLI.. Perses provides everything you need for a great Dashboard-as-Code experience.\n- **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](https://github.com/perses/perses-operator).\n\nWant to learn more? Check the [documentation website](https://perses.dev).\n\n## Try it\n\nWe are providing an online demo available at **https://demo.perses.dev**, where you can check existing dashboards or create your own resources.\n\n## Status\n\n1. Perses as an application can now **be used**.\n   * The data model reached a stable point, and we are providing multiple panel types that should cover most of the monitoring \u0026 tracing use cases.\n   * Authentication and authorization are available.\n2. On the GitOps aspect:\n   * We provide a CLI that helps interacting with the API. A short doc is available [here](./docs/cli.md)\n   * Two SDKs (in Golang and in Cuelang) are available for coding dashboards. See [Dashboard-as-Code](./docs/dac/getting-started.md) guide.\n     These SDKs will likely evolve based on the feedback we receive. However, changes are expected to focus on adding utility functions rather than introducing breaking changes.\n3. A plugin architecture:\n   * Enables the externalization of both plugin loading and implementation.\n   * The core plugins are maintained in [perses/plugins](https://github.com/perses/plugins) repository.\n\n## What's next\n\nCurrent Roadmap is available [here](./ROADMAP.md)\n\n## Install\n\nThere are various ways of installing Perses.\n\n### Precompiled binaries\n\nPrecompiled binaries for released versions are available in\nthe [GitHub release](https://github.com/perses/perses/releases). Using the latest release binary is the recommended way\nof installing Perses.\n\n### Docker images\n\nDocker images are available on [Docker Hub](https://hub.docker.com/r/persesdev/perses).\n\nYou can launch a Perses container for trying it out with:\n\n```bash\ndocker run --name perses -d -p 127.0.0.1:8080:8080 persesdev/perses\n```\n\n### Homebrew\n\nWe have [a Homebrew tap](https://github.com/perses/homebrew-tap) so macOS and Linux users can install with:\n\n`brew install perses/tap/perses` for the server and web UI\n`brew install perses/tap/percli` for the CLI tool\n\n### Building from source\n\nTo build Perses from source code, You need:\n\n- Go [version 1.23 or greater](https://golang.org/doc/install).\n- NodeJS [version 22 or greater](https://nodejs.org/).\n- npm [version 10 or greater](https://www.npmjs.com/).\n\nStart by cloning the repository:\n\n```bash\ngit clone https://github.com/perses/perses.git\ncd perses\n```\n\nThen you can use `make build` that would build the web assets and then Perses itself (and also the Perses CLI that can\nbe used to interact directly with the Perses API in case you prefer to browser the API using a terminal).\n\n```bash\nmake build\n./bin/perses --config=your_config.yml\n```\n\n## Contributing and development\n\nGeneral instructions about how you can contribute to Perses are available in the\ndocument [CONTRIBUTING.md](CONTRIBUTING.md).\n\n### UI development\n\nIf you are primarily interested in contributing to the UI application and libraries, please refer to\nthe [UI Readme](./ui/README.md). It includes quick start instructions for how to build, run, and test the React UI. It\nalso includes details about the architecture and [guidelines](./ui/ui-guidelines.md) for development.\n\n## License\n\nThe code is licensed under an [Apache 2.0](./LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperses%2Fperses","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperses%2Fperses","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperses%2Fperses/lists"}