Skip to content
logo
Percona Operator for MySQL
Monitor with Percona Monitoring and Management (PMM)
Initializing search
    percona/k8sps-docs
    percona/k8sps-docs
    • Welcome
      • Design and architecture
      • Install with Helm
      • Install on Minikube
      • System Requirements
      • Install on Google Kubernetes Engine (GKE)
      • Install on Amazon Elastic Kubernetes Service (AWS EKS)
      • Generic Kubernetes installation
      • Backup and restore
      • Application and system users
      • Anti-affinity and tolerations
      • Labels and annotations
      • Changing MySQL Options
      • Exposing the cluster
      • Transport Encryption (TLS/SSL)
      • Telemetry
      • Horizontal and vertical scaling
      • Monitor with Percona Monitoring and Management (PMM)
        • Installing the PMM Server
        • Installing the PMM Client
      • Add sidecar containers
      • Monitor Kubernetes
      • Custom Resource options
      • Percona certified images
      • Copyright and licensing information
      • Trademark policy
      • Release notes index
      • Percona Operator for MySQL 0.5.0 (2023-03-30)
      • Percona Operator for MySQL 0.4.0 (2023-01-30)
      • Percona Operator for MySQL 0.3.0 (2022-09-29)
      • Percona Operator for MySQL 0.2.0 (2022-06-30)
      • Percona Distribution for MySQL Operator based on Percona Server for MySQL 0.1.0 (2022-01-25)

    • Installing the PMM Server
    • Installing the PMM Client

    Monitoring¶

    Percona Monitoring and Management (PMM) provides an excellent solution to monitor Percona Distribution for MySQL.

    Note

    Only PMM 2.x versions are supported by the Operator.

    PMM is a client/server application. PMM Client runs on each node with the database you wish to monitor: it collects needed metrics and sends gathered data to PMM Server. As a user, you connect to PMM Server to see database metrics on a number of dashboards.

    That’s why PMM Server and PMM Client need to be installed separately.

    Installing the PMM Server¶

    PMM Server runs as a Docker image, a virtual appliance, or on an AWS instance. Please refer to the official PMM documentation for the installation instructions.

    Installing the PMM Client¶

    The following steps are needed for the PMM client installation in your Kubernetes-based environment:

    1. The PMM client installation is initiated by updating the pmm section in the deploy/cr.yaml file.

      • set pmm.enabled=true
      • set the pmm.serverHost key to your PMM Server hostname or IP address (it should be resolvable and reachable from within your cluster)
      • authorize PMM Client within PMM Server: Acquire the API Key from your PMM Server and set pmmserverkey in the users Secrets object to this obtained API Key value. For example, setting the PMM Server API Key to new_key in the cluster1-secrets object can be done with the following command:

        $ kubectl patch secret/cluster1-secrets -p '{"data":{"pmmserverkey": '$(echo -n new_key | base64 --wrap=0)'}}'
        
        $ kubectl patch secret/cluster1-secrets -p '{"data":{"pmmserverkey": '$(echo -n new_key | base64)'}}'
        

      When done, apply the edited deploy/cr.yaml file:

      $ kubectl apply -f deploy/cr.yaml
      
    2. Check that corresponding Pods are not in a cycle of stopping and restarting. This cycle occurs if there are errors on the previous steps:

      $ kubectl get pods
      $ kubectl logs cluster1-mysql-0 -c pmm-client
      
    3. Now you can access PMM via https in a web browser, with the login/password authentication, and the browser is configured to show Percona Server for MySQL metrics.

    Contact Us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: 2023-08-31
    Percona LLC and/or its affiliates, © 2009 - 2023
    Made with Material for MkDocs

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. Read more about Percona Cookie Policy.