Add database version details to PMM inventory Services
Description
How to test
Add one of the following types of service to monitoring:
PostgreSQL
MongoDB
MySQL
ProxySQL
RDS PostgeSQL or RDS MySQL
Azure PostgreSQL or Azure MySQL
Find the service you just added on the PMM Inventory / Services table
Expand the row - you should see a non-empty version attribute
It's important to test that:
older (< 2.41.0) PMM Agents don't fail and work as before (i.e. they won't be able to detect the version)
How to document
We have added the `version` attribute to the response of the endpoint that provides a list of services being monitored by PMM (i.e. the response of `/v1/management/Service/List`). This will make it easy to visualize the database server version.
The feature is shipped with the following limitations:
the version is not captured for the internal PostgreSQL database (currently version 14.9)
the version is only captured when a new service is being added to PMM and the agent installed on the client side is equal or greater than v2.41.0
upon a database upgrade the user won't see the database version updated automatically unless they remove and then re-add the service.
AFFECTED CS IDs
Attachments
- 11 Oct 2023, 04:35 PM
- 31 Jul 2023, 11:20 AM
relates to
Activity
vasyl.yurkovych October 24, 2023 at 2:17 PM
verified using server docker - perconalab/pmm-server-fb:PR-3397-987dfa0
client docker - perconalab/pmm-client-fb:PR-3397-987dfa0
client - https://s3.us-east-2.amazonaws.com/pmm-build-cache/PR-BUILDS/pmm2-client/pmm2-client-PR-3397-987dfa0.tar.gz
Alex Demidoff October 20, 2023 at 5:53 PM
@vasyl.yurkovych I bumped up the version in the regexp - it simply went out of date since this PR didn't make it to 2.40.0.
It's verified on agent versions: 2.41.0, 2.40.0, and 2.36 as per the logs below:
[root@pmm-server pmm] # pmm-admin add mysql --cluster=mysql-dev --environment=dev --username=root --password=***redacted*** --service-name=mysql-svc --host=mysql --port=3306 --query-source=perfschema
MySQL Service added.
Service ID : /service_id/1d885e51-bf86-473b-bbb4-dc4937748ccd
Service name: mysql-svcTable statistics collection enabled (the limit is 1000, the actual table count is 329).
[root@pmm-server pmm] # pmm-agent --version
ProjectName: pmm-agent
Version: 2.41.0
PMMVersion: 2.41.0
Timestamp: 2023-10-20 16:36:26 (UTC)
FullCommit: fe5999c1f56fb84cf226fe3f6aae4e4491362c9c
Branch: PMM-12375-add-database-version-to-services2root@pmm2-worker $ pmm-admin add mysql --cluster=mysql-dev --environment=dev --username=root --password=***redacted*** --service-name=mysql-svc --host=127.0.0.1 --port=3306 --query-source=perfschema
MySQL Service added. Service ID : /service_id/22a9feeb-6db7-4d25-a5bc-2a0e6d5016d1
Service name: mysql-svcTable statistics collection enabled (the limit is 1000, the actual table count is 329).
root@pmm2-worker $ pmm-agent --version
ProjectName: pmm-agent
Version: 2.40.0
PMMVersion: 2.40.0
Timestamp: 2023-09-28 22:11:44 (UTC)
FullCommit: 29fbba7984b26fb68ecfe65e44c1c6b761c14e28root@pmm2-worker $ pmm-admin add mysql --cluster=mysql-dev --environment=dev --username=root --password=***redacted*** --service-name=mysql-svc --host=127.0.0.1 --port=3306 --query-source=perfschema
MySQL Service added.
Service ID : /service_id/50b09cda-745d-4e1a-bf85-2b4e56a742fa
Service name: mysql-svcTable statistics collection enabled (the limit is 1000, the actual table count is 329).
root@pmm2-worker $ pmm-agent --version
ProjectName: pmm-agent
Version: 2.16.0-release-2.16-ebcf4316
PMMVersion: 2.16.0-release-2.16-ebcf4316
Timestamp: 2021-04-15 11:18:35 (UTC)
FullCommit: 57abfccdb08319f708320199b89803967910ffb7I gave mysql a thorough test because it's special in that the agent must return the table count, while the others don't. However, it's a great idea to test adding other databases as well 🙂
vasyl.yurkovych October 11, 2023 at 4:35 PMEdited
User impact:
The user is not able to add any database to monitoring using released pmm-client
Preconditions:
Start PMM Server (perconalab/pmm-server-fb:PR-3397-aecc08f)
Setup pmm-client 2.40.0
Setup Percona server DB
Steps to reproduce:
run pmm-admin add mysql --username={username} --password={password} --port={port}
Actual results:
Internal server error. is shown to the user
Expected result:
The user should see a success message and should see service details.
Note:
attached logs from pmm-server
[root@rs101 /]# pmm-admin version
ProjectName: pmm-admin
Version: 2.40.0
PMMVersion: 2.40.0
Timestamp: 2023-09-28 22:11:09 (UTC)
FullCommit: 29fbba7984b26fb68ecfe65e44c1c6b761c14e28Alex Demidoff August 1, 2023 at 2:24 PMEdited
A quick note on possible implementation
An ad-hoc investigation revealed that the database engine version is available from metrics. The following metrics are currently provided by the exporters:
mongodb_version_info
mysql_version_info
pg_static
However, when we query the information from the database, we would need to make as many calls to VictoriaMetrics as there are services, which would be too slow on a system with a good number of monitored services. Therefore, from a performance standpoint it would be nice to store the database engine version in the state. To avoid staleness, we can re-query the version from VM whenever an inventory endpoint that mutates the service record is called.
If not the above, then we could ask pmm-agent for the database version. However, it seems like we still need to figure out how pmm-agent can reliably query it from different db engines.
It's good to have database version details in PMM Invertory --> Services
Currently, it has the below information for database service,