Details
-
New Feature
-
Status: Done
-
Medium
-
Resolution: Done
-
None
-
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:
- URL https://pmmdemo.percona.com/graph/d/mysql-instance-summary/mysql-instance-summary
- An additional panel with pt-mysql-summary results.
- Add the panel on "MySQL Instance Summary" dashboard
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:
- Run pmm-server
- Run MySQL instance (do not use Docker installation)
- Add MySQL instance via pmm-admin
- Open Home Page
- Open Services -> MySQL Instance Overview
- Select newly created MySQL service in services list (service name)
- Open MySQL -> MySQL Instance Summary
- See new panel with a result of pt-mysql-summary
How to demonstrate second user case:
- Run pmm-server
- Run MySQL instance (do not use Docker installation)
- Add MySQL instance via pmm-admin
- Open Home Page
- Open Services -> MySQL Instance Overview
- Select newly created MySQL service in services list (service name)
- Open MySQL -> MySQL Instance Summary
- Click Share Dashboard button on the top left corner
- Select Snapshot Tab
- Local Snapshot
- Open created link
- 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:
The same like in how to demonstrate steps.With remote MySQL instanceThe same as steps above, but replace step 3 with "Add MySQL instance via UI"
Tests with SSL enabled instancesTest it with MySQL, Percona Server for MySQL and MariaDB.
Details:
Should be tested on CentOS with MySQL 8.0 only
Attachments
Issue Links
- is cloned by
-
PMM-5784 Ability to execute `pt-pg-summary` for PostgreSQL service
-
- Done
-
- relates to
-
PMM-7159 Add summary panel to the "MySQL Instance Summary" dashboard
-
- Done
-
-
PMM-7562 Support for remote in MySQL summary.
-
- Open
-
-
PMM-4362 Hide pt-summary and pt-mysql-summary actions for now
-
- Done
-
-
PMM-7177 Dashboards: New Grafana panel combining `pt-mysql-summary`, `pt-mongodb-summary`, `pt-pg-summary` outputs
-
- Done
-
- mentioned in
-
Page Loading...