PMM Contributions Overview

Percona welcomes community contributions to help improve Percona Monitoring & Management (PMM). Learn how to become an active contributor within the PMM community. It’s easy to get started (you don’t need to be a developer). Through interaction with Percona’s experts, you'll build expertise, and win recognition from the community and your peers!

PMM is a free and open-source tool with over 250,000 downloads and active users. PMM helps DBAs, developers, and DevOps teams gain deep insight to manage their complex database environments. Discover a wealth of PMM resources on GitHub.

Percona takes a broad and expansive view, and invites contributions to the full spectrum of PMM infrastructure and resources. Although its a key part, we welcome more than just contributing source code

Percona invites:
  1. Dashboards
  2. Exporters
  3. Documentation
  4. Contributions to the Percona Community Blog
  5. Video Tutorials or Testimonials
  6. UI Enhancements
  7. New Features and Functionality
  8. Bug Fixes

To start, it helps to understand that PMM includes three major subsystems:

Percona has already built Exporters and Dashboards for the most popular databases, Linux metrics and indicators, but there’s room for more. There are popular Prometheus exporters that cover 20 databases, but only six have been integrated into PMM so far.

We invite you to start small and gain confidence. In no time you’ll grow to understand PMM, how to participate, and be moving on to bigger challenges.


Contribute Video Tutorials or Testimonials

Tell the world how PMM helps you, what features you like or dislike, etcetera on:

  1. Your personal blog or social media networks
  2. A video or screencast posted on YouTube

You can also propose original content for publication on the Percona Community Blog.

You can talk about:
  1. Your indicators and metrics
  2. Your favorite dashboards
  3. Your best practices with PMM
  4. Your ideas or concerns about PMM

You don't have to be cool or exciting, just candid and honest, and there’s no need to disclose private data. Mask any sensitive data or show only a test environment.


Contribute Documentation

PMM already has extensive documentation written by Percona’s technical writing team, however there is still room for improvement! PMM’s documentation is developed using sphinx-doc.org, a simple tool, similar to Markdown that’s easy to learn and use.


Contribute Dashboards

Customizing PMM’s Dashboards is a simple and quick way to begin contributing to PMM. Install PMM, connect it to your database or instead configure the Exporter for Linux. You can create a new Dashboard with the charts, indicators, and exporters most interesting to you. Then simply upload your Dashboard to Grafana’s Community Dashboards. You might be surprised how useful your Dashboard will be to other PMM users. Percona will pull the best Dashboards into PMM. Here are just a few ideas:

  • Create a new dashboard for Linux indicators and metrics.
  • Create an improved Dashboard for PMM’s existing databases, i.e. MySQL, PostgreSQL, MongoDB, ProxySQL
  • In the future, you will be able to connect other Exporters and make Dashboard for them. (Redis, Cassandra, etc.)

Percona can help you get started, review your work, and give you advice along the way.


Contribute Exporters

The Prometheus Exporters used by PMM are written in the GO language using Jira, GIT and CI/CD as our development environment. Creating an Exporter is not for beginners and requires advanced technical skills. However if you have those skills and represent a company that wants to develop an exporter, please feel free to contact us.

Google Summer of Code

Google Summer of Code (GSoC) 2020 is an international annual program run by Google for college students interested in getting a stipend to contribute to open source projects.

Our GSoC projects are focused on improving Percona Monitoring and Management (PMM). Learn more about the program and how to participate.

How To Get Started Contributing?

All community contributions to PMM are coordinated by Percona’s Community team. Simply email community-team@percona.com and add "PMM Community” to your subject line. Explain briefly what you want to do, what kind of help you might need, and include your full contact information. Join the PMM contributors club today!!