CONTRIBUTING.md

Welcome to Percona Monitoring and Management (PMM)!

We'd be glad to welcome you to Percona community which tries to keep the open source open. Percona Monitoring and Management (PMM) is an open source database monitoring solution. It allows you to monitor your databases, different services (HAProxy, ProxySQL and etc) as well as Nodes, Kubernetes clusters and containers. Please check our Documentation for the actual architecture.

Table of contents

1. Project repos structure
2. API documentation
3. Prerequisites
4. Submitting a bug
5. Setup your local development environment
6. Tests
7. Feature Build
8. Code Reviews

Project repos structure

This project is built from several repositories:

APIs

• percona/pmm
• percona-platform/saas
• percona-platform/dbaas-api

PMM Server

Backends

• percona/pmm-managed manages configuration of PMM server components (VictoriaMetrics, Grafana, etc.) and exposes API for that. APIs are used by pmm-admin
• percona-platform/dbaas-controller exposes a simplified API for managing Percona Kubernetes Operators.
• percona/qan-api query analytics API
• percona/pmm-update is a tool for updating packages and OS configuration for PMM

Frontends

• percona/grafana-dashboards PMM dashboards for database monitoring
• percona/grafana user interface for PMM

PMM Client

• percona/pmm-agent monitoring agent for PMM. Runs exporters, and VMAgent that collects data from exporters and send to VictoriaMetrics
• percona/pmm-admin admin tool for PMM to manage service that should be monitored by PMM
• percona/node_exporter exports machine's metrics
• percona/mysqld_exporter exports MySQL server's metrics
• percona/mongodb_exporter exports MongoDB server's metrics
• percona/postgres_exporter exports PostgreSQL server's metrics
• percona/proxysql_exporter exports ProxySQL server's metrics
• percona/rds_exporter exports metrics from RDS
• percona/azure_exporter exports metrics from Azure
• percona/percona-toolkit is a collection of advanced command-line tools to perform a variety of MySQL and system tasks that are too difficult or complex to perform manually

Building and Packaging

• Percona-Lab/pmm-submodules
• Percona-Lab/jenkins-pipelines

QA, Testing and Documentation

• percona/pmm-ui-tests
• percona/pmm-qa
• percona/pmm-doc

API Reference Documentation

You can review the PMM API definition here.

It is generated from our .proto files using a special OpenAPI v2 tool and additional API documentation source files which are located in the docs/api/ directory. The content and structure of these is formatted using Markdown markup language and published on the ReadMe.com service.

You can edit the content using your favorite editor (ideally one that supports previewing MarkDown content, e.g. Microsoft Visual Studio Code).

If you need to create a new file, copy one of the existing *.md documents in the folder to maintain the overall structure and format.

When choosing a file name, make sure that it reflects the topic or the theme you are talking about and follow the format of my-topic.md (no spaces, only letters and dashes).

Make sure to create a unique slug for your file, for example: slug: authentication.

Header rules: in Markdown, the level of a header line is defined by the number of hash signs, example: ### would be equivalent to an H3 header. Please avoid using H1 headers. Your first-level header must be H2. The rest of the headers can by anything between H3 and H6.

Once you're done, please submit your proposed changes via a GitHub pull request as outlined below.

After the PR has been merged, make sure you can see your contribution live at https://percona-pmm.readme.io/

Prerequisites

Before submitting code or documentation contributions, you should first complete the following prerequisites.

1. Sign the CLA

Before you can contribute, we kindly ask you to sign our Contributor License Agreement (CLA). You can do this using your GitHub account and one click.

2. Code of Conduct

Please make sure to read and agree to our Code of Conduct.

Submitting a Bug

See Submitting Bug Reports in README.md.

Setup your local development environment

Since PMM has a lot of components, we will mention only three big parts of it.

PMM Server

• Clone pmm repository
• Run make env-up to start development container. This will be slow on first run, all subsequent runs will be order of magnitude faster, because development container will be reused. From time to time it is recommended to rebuild the container to pull the latest changes by running make env-up-rebuild.
• To run pmm-managed with your code changes, just run make run-managed. It updates pmm-managed running in the container.

PMM Client

• Clone pmm repository.
• Navigate to the /agent folder in the root of the repository.
• Run make setup-dev to connect pmm-agent to PMM Server.
  • This command will register local pmm-agent to PMM Server and generate config file pmm-agent-dev.yaml
• Once it's connected just use make run to run pmm-agent.
• To work correctly, pmm-agent needs vmagent and exporters installed on the system.
  • The first option is to install pmm-client using this instrucion https://docs.percona.com/percona-monitoring-and-management/setting-up/client/index.html#install. It will install all exporters as well.
  • Another option is to do it manually
    • vmagent and exporters can be installed by building each of them or by downloading the pmm-client tarball from percona.com and copying binaries to the exporters_base directory configured in pmm-agent-dev.yaml file.
    • All paths to exporter binaries are configured in pmm-agent-dev.yaml, so they can be changed manually if necessary.

Exporters

Exporters by themselves are independent applications, so each of them contains its own README files explaining how to set up a local environment see PMM Client.

UI

See Grafana Dashboards Contribution Guide.

Tests

In PMM we have 3 kinds of tests:

• unit tests
• API tests
• end-to-end, or e2e, tests

Unit tests

Each repository mentioned above has its own set of unit tests, as well as its own instruction on how to run unit tests.

API tests

API tests are part of the PMM repository and can be found in api-tests directory. API tests run inside of an active PMM Server container.

End-to-end (E2E) tests

End-to-end tests are located in pmm-qa repository. They include UI tests and CLI tests. Please refer to readme for details on how to run these.

Submitting a Pull Request

Before proceeding with your first pull request, we highly recommend you to read the following documents:

• Working with Git and GitHub
• Tech stack
• Best practices

Once your PR is created, please do the following:

• prepare your PR for review
  • run code syntax checks, or linters
  • run tests and make sure they all pass
• pass the review (ask for review, ping reviewers)
• then merge it
  • ask code owners or admins to merge it if merging is blocked for some reason

Feature Build

PMM is quite a complex project, it consists of many different repos described above. A Feature Build (FB) is a way to put everything together, build all components, run tests and, finally, build client and server containers.

Please see: How to create a feature build

The Goals of Feature Builds

1. Provide a way to have the functionality tested by the developer and QA (or other PMM team members)
2. Inform the Developer about Automation Test results before the code is merged
3. Let the Developers add or modify e2e tests whenever there are functional changes

The Rules

1. Create a Feature Build for every feature/improvement/bugfix you are working on.
2. Create a draft Pull Request in https://percona-lab/pmm-submodules.
3. Change the status of the Pull Request from Draft to Open ONLY if you are contributing code changes to pmm-submodules (very rare).
4. Provide a short explanation in the Description field of you feature build PR and checkboxes to all related Pull Requests. If you need examples, check out PRs made by others.
5. After all related PRs in feature build are merged you should: a. either close the PR and delete the branch (this is the default option) or b. merge the PR to pmm-submodules repository (please note, this rarely needs to be merged, for example infrastructure changes)

Code Reviews

There is a number of approaches we use for the code review and ownership:

• code ownership, which is enforced via github's CODEOWNERS file
• github code review assignment
• finally, a PR owner can manually assign reviewers (usually one or more PMM team members).

To make the review process effective, we use a mixed approach:

• for repos that have CODEOWNERS
  • github will assign reviewers automatically
• for repos that don't have CODEOWNERS
  • add reviewers as follows:
    • add pmm-review-fe for UI/UX reviews
    • add pmm-review-exporters for exporter reviews see PMM Client
    • add pmm-review-be for backend reviews
• if you know exactly who should review your code, add them to the review

Team	Description	Members
pmm-review-fe	UI reviewers of PRs to FrontEnd repos	FE team
pmm-review-exporters	exporter reviewers of PRs to PMM Client	Exporters team
pmm-review-be	reviewers of backend (Go) PRs	BE team
PMM Admins	reviewers that could use admins rights to force merge or change repo settings	PMM Admin team

After your Pull Request is merged

Once your pull request is merged, you are an official Percona Community Contributor. Welcome to the community!

We're looking forward to your contributions and hope to hear from you soon on our Forums.