Uploaded image for project: 'Percona Monitoring and Management'
  1. Percona Monitoring and Management
  2. PMM-4172

Ability to execute `pt-mysql-summary` for MySQL service

Details

    • 3
    • Yes
    • Yes
    • Yes
    • [obsolete] C/S Core

    Description

      Build with PG Summary, MySQL Summary and dashboards together HERE: https://github.com/Percona-Lab/pmm-submodules/pull/1535

        

      This is the same as PMM-3831 just  for MySQL 

      Problem:  we missing big part from pmm1  - when we were able to see results on pm-summary  output  (the tool form Percona toolkit) on PMM UI

      This tool provides a lot of useful information regarding the Mysql and parameters. We need to add this feature back 

       

      UI: 

      User Stories:

      • As a PMM user, I need to be able to see the pt-mysql-summary output on Mysql Instance Summary  when Mysql selected, so that will provide me information about the mysql instance 
      • As a Percona Support  person, I need to be able to see  information from the pt-mysql-summary panel on Snapshot user uploaded  to our server, so that  I have full information about user system 

       

      ----------------

      Additional info: 

      pt-mysql-summary should be run on the same Node where MySQL is running. From https://www.percona.com/doc/percona-toolkit/3.0/pt-mysql-summary.html:

      The tool interacts minimally with the server upon which it runs. It assumes that you’ll run it on the same server you’re inspecting, and therefore it assumes that it will be able to find the my.cnf configuration file, for example. However, it should degrade gracefully if this is not the case. Note, however, that its output does not indicate which information comes from the MySQL database and which comes from the host operating system, so it is possible for confusing output to be generated if you run the tool on one server and connect to a MySQL database server running on another server.

       

      Similar to pt summary in Node Summary.

      New panel should be added Mysql Instace Summary page

      This panel should be filled by the result of StartPtMySQLSummary action result.

      Backend is expecting service_id as input and pmm-agent_id as optional value.

      Service id will be extracted on frontend grafana variables.

       

      Out of scope:

       PMM client and DB in Containers are out of scope

       

       

      How to demonstrate first user case:

      1. Run pmm-server
      2. Run MySQL instance (do not use Docker installation)
      3. Add MySQL instance via pmm-admin
      4. Open Home Page
      5. Open Services -> MySQL Instance Overview
      6. Select newly created MySQL service in services list (service name)
      7. Open MySQL -> MySQL Instance Summary
      8. See new panel with a result of pt-mysql-summary

       

       

      How to demonstrate second user case:

      1. Run pmm-server
      2. Run MySQL instance (do not use Docker installation)
      3. Add MySQL instance via pmm-admin
      4. Open Home Page
      5. Open Services -> MySQL Instance Overview
      6. Select newly created MySQL service in services list (service name)
      7. Open MySQL -> MySQL Instance Summary
      8. Click Share Dashboard button on the top left corner
      9. Select Snapshot Tab
      10. Local Snapshot
      11. Open created link 
      12. See the same output that we had before making snapshot.

       

      How to test/demonstrate via Swagger:

      • Steps 1-3 from cases above
      • Open Swagger UI
      • Call /v1/management/Actions/StartPTMySQLSummary
      • Save action_id from the result of previous call
      • Wait 30-60 seconds
      • Call /v1/management/Actions/Get with previously saved action_id
      • Check that done is true
        • If not wait a little bit and call /v1/management/Actions/Get again.
      • Check that output has data
      • Check that error is empty

       

      How to test cases:

      1. The same like in how to demonstrate steps.
      2. With remote MySQL instance
        1. The same as steps above, but replace step 3 with "Add MySQL instance via UI"
      3. Tests with SSL enabled instances
      4. Test it with MySQL, Percona Server for MySQL and MariaDB. 

      Details:

      Should be tested on CentOS with MySQL 8.0 only

       

      Attachments

        Issue Links

          Activity

            People

              jiri.ctvrtka Jiří Čtvrtka
              alexey.palazhchenko Alexey Palazhchenko (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Smart Checklist