PMM-10974 Fallback to PGSS in case of not available PGSM. (#2827) (#2846

) * PMM-12872 Fallback to PGSS in case of not available PGSM. * PMM-12872 Lint. * PMM-12872 Lint. * PMM-12872 Add test for PostgreSQLOptions. * PMM-12872 Small change in if. * Update api/agentpb/agent.proto * Update managed/services/management/postgresql.go * PMM-12872 Remove nil check in if. * PMM-12872 Gen. * PMM-10974 Warning message on pmm-admin side. * PMM-10974 Change warning message. --------- Co-authored-by: Alex Demidoff <alexander.demidoff@percona.com>
percona · Feb 26, 2024 · f9ce3d8 · f9ce3d8
1 parent 29e7cde
commit f9ce3d8
Show file tree

Hide file tree

Showing 16 changed files with 542 additions and 455 deletions.
diff --git a/admin/commands/management/add_postgresql.go b/admin/commands/management/add_postgresql.go
@@ -30,10 +30,14 @@ var addPostgreSQLResultT = commands.ParseTemplate(`
 PostgreSQL Service added.
 Service ID  : {{ .Service.ServiceID }}
 Service name: {{ .Service.ServiceName }}
+{{ if .Warning }}
+Warning: {{ .Warning }}
+{{- end -}}
 `)
 
 type addPostgreSQLResult struct {
 	Service *postgresql.AddPostgreSQLOKBodyService `json:"service"`
+	Warning string                                 `json:"warning"`
 }
 
 func (res *addPostgreSQLResult) Result() {}
@@ -223,5 +227,6 @@ func (cmd *AddPostgreSQLCommand) RunCmd() (commands.Result, error) {
 
 	return &addPostgreSQLResult{
 		Service: resp.Payload.Service,
+		Warning: resp.Payload.Warning,
 	}, nil
 }
diff --git a/agent/serviceinfobroker/service_info_broker.go b/agent/serviceinfobroker/service_info_broker.go
@@ -26,6 +26,7 @@ import (
 
 	"github.com/go-sql-driver/mysql"
 	"github.com/lib/pq"
+	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"go.mongodb.org/mongo-driver/mongo"
 
@@ -231,6 +232,13 @@ func (sib *ServiceInfoBroker) getPostgreSQLInfo(ctx context.Context, dsn string,
 	}
 	res.Version = version
 
+	var pgsmVersion string
+	err = db.QueryRowContext(ctx, "SELECT /* agent='serviceinfobroker' */ extversion FROM pg_extension WHERE extname = 'pg_stat_monitor';").Scan(&pgsmVersion)
+	if err != nil && !errors.Is(err, sql.ErrNoRows) {
+		res.Error = err.Error()
+	}
+	res.PgsmVersion = pgsmVersion
+
 	return &res
 }
 

diff --git a/agent/serviceinfobroker/service_info_broker_test.go b/agent/serviceinfobroker/service_info_broker_test.go
@@ -249,6 +249,20 @@ func TestServiceInfoBroker(t *testing.T) {
 		assert.InDelta(t, 250, resp.TableCount, 150)
 	})
 
+	t.Run("PostgreSQLOptions", func(t *testing.T) {
+		cfgStorage := config.NewStorage(&config.Config{
+			Paths: config.Paths{TempDir: t.TempDir()},
+		})
+		c := New(cfgStorage)
+		resp := c.GetInfoFromService(context.Background(), &agentpb.ServiceInfoRequest{
+			Dsn:  tests.GetTestPostgreSQLDSN(t),
+			Type: inventorypb.ServiceType_POSTGRESQL_SERVICE,
+		}, 0)
+		require.NotNil(t, resp)
+		assert.Equal(t, []string{"postgres", "pmm-agent"}, resp.DatabaseList)
+		assert.Equal(t, "", resp.PgsmVersion)
+	})
+
 	t.Run("MongoDBWithSSL", func(t *testing.T) {
 		mongoDBDSNWithSSL, mongoDBTextFiles := tests.GetTestMongoDBWithSSLDSN(t, "../")
 

diff --git a/api/agentpb/agent.pb.go b/api/agentpb/agent.pb.go
diff --git a/api/agentpb/agent.pb.validate.go b/api/agentpb/agent.pb.validate.go
diff --git a/api/agentpb/agent.proto b/api/agentpb/agent.proto
@@ -474,6 +474,8 @@ message ServiceInfoResponse {
   string version = 3;
   // A list of PostgreSQL databases.
   repeated string database_list = 4;
+  // A version of pg_stat_monitor, empty if unavailable.
+  string pgsm_version = 5;
 }
 
 // JobStatusRequest is a ServerMessage asking pmm-agent for job status.

diff --git a/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go b/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go
diff --git a/api/managementpb/json/managementpb.json b/api/managementpb/json/managementpb.json
@@ -4626,6 +4626,11 @@
                     }
                   },
                   "x-order": 0
+                },
+                "warning": {
+                  "description": "Warning message.",
+                  "type": "string",
+                  "x-order": 4
                 }
               }
             }

diff --git a/api/managementpb/postgresql.pb.go b/api/managementpb/postgresql.pb.go
diff --git a/api/managementpb/postgresql.pb.validate.go b/api/managementpb/postgresql.pb.validate.go
diff --git a/api/managementpb/postgresql.proto b/api/managementpb/postgresql.proto
@@ -95,6 +95,8 @@ message AddPostgreSQLResponse {
   inventory.PostgresExporter postgres_exporter = 2;
   inventory.QANPostgreSQLPgStatementsAgent qan_postgresql_pgstatements_agent = 3;
   inventory.QANPostgreSQLPgStatMonitorAgent qan_postgresql_pgstatmonitor_agent = 4;
+  // Warning message.
+  string warning = 5;
 }
 
 // PostgreSQL service provides public Management API methods for PostgreSQL Service.

diff --git a/api/swagger/swagger-dev.json b/api/swagger/swagger-dev.json
@@ -22963,6 +22963,11 @@
                     }
                   },
                   "x-order": 3
+                },
+                "warning": {
+                  "description": "Warning message.",
+                  "type": "string",
+                  "x-order": 4
                 }
               }
             }

diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json
@@ -19291,6 +19291,11 @@
                     }
                   },
                   "x-order": 3
+                },
+                "warning": {
+                  "description": "Warning message.",
+                  "type": "string",
+                  "x-order": 4
                 }
               }
             }

diff --git a/managed/models/agent_model.go b/managed/models/agent_model.go
@@ -129,6 +129,7 @@ type PostgreSQLOptions struct {
 	SSLKey             string `json:"ssl_key"`
 	AutoDiscoveryLimit int32  `json:"auto_discovery_limit"`
 	DatabaseCount      int32  `json:"database_count"`
+	PGSMVersion        string `json:"pgsm_version"`
 }
 
 // Value implements database/sql/driver.Valuer interface. Should be defined on the value.

diff --git a/managed/services/agents/service_info_broker.go b/managed/services/agents/service_info_broker.go
@@ -211,6 +211,7 @@ func (c *ServiceInfoBroker) GetInfoFromService(ctx context.Context, q *reform.Qu
 				}
 			}
 		}
+		agent.PostgreSQLOptions.PGSMVersion = sInfo.PgsmVersion
 		agent.PostgreSQLOptions.DatabaseCount = int32(databaseCount - excludedDatabaseCount)
 
 		l.Debugf("Updating PostgreSQL options, database count: %d.", agent.PostgreSQLOptions.DatabaseCount)

diff --git a/managed/services/management/postgresql.go b/managed/services/management/postgresql.go
@@ -19,6 +19,7 @@ import (
 	"context"
 
 	"github.com/AlekSi/pointer"
+	"github.com/sirupsen/logrus"
 	"gopkg.in/reform.v1"
 
 	"github.com/percona/pmm/api/inventorypb"
@@ -37,6 +38,7 @@ type PostgreSQLService struct {
 	state agentsStateUpdater
 	cc    connectionChecker
 	sib   serviceInfoBroker
+	l     *logrus.Entry
 }
 
 // NewPostgreSQLService creates new PostgreSQL Management Service.
@@ -46,6 +48,7 @@ func NewPostgreSQLService(db *reform.DB, state agentsStateUpdater, cc connection
 		state: state,
 		cc:    cc,
 		sib:   sib,
+		l:     logrus.WithField("component", "postgresql"),
 	}
 }
 
@@ -93,6 +96,7 @@ func (s *PostgreSQLService) Add(ctx context.Context, req *managementpb.AddPostgr
 			return err
 		}
 
+		options := models.PostgreSQLOptionsFromRequest(req)
 		row, err := models.CreateAgent(tx.Querier, models.PostgresExporterType, &models.CreateAgentParams{
 			PMMAgentID:        req.PmmAgentId,
 			ServiceID:         service.ServiceID,
@@ -104,7 +108,7 @@ func (s *PostgreSQLService) Add(ctx context.Context, req *managementpb.AddPostgr
 			PushMetrics:       isPushMode(req.MetricsMode),
 			ExposeExporter:    req.ExposeExporter,
 			DisableCollectors: req.DisableCollectors,
-			PostgreSQLOptions: models.PostgreSQLOptionsFromRequest(req),
+			PostgreSQLOptions: options,
 			LogLevel:          services.SpecifyLogLevel(req.LogLevel, inventorypb.LogLevel_error),
 		})
 		if err != nil {
@@ -119,6 +123,13 @@ func (s *PostgreSQLService) Add(ctx context.Context, req *managementpb.AddPostgr
 			if err = s.sib.GetInfoFromService(ctx, tx.Querier, service, row); err != nil {
 				return err
 			}
+
+			// In case of not available PGSM extension it is switch to PGSS.
+			if req.QanPostgresqlPgstatmonitorAgent && row.PostgreSQLOptions.PGSMVersion == "" {
+				res.Warning = "Could not to detect the pg_stat_monitor extension on your system. Falling back to the pg_stat_statements."
+				req.QanPostgresqlPgstatementsAgent = true
+				req.QanPostgresqlPgstatmonitorAgent = false
+			}
 		}
 
 		agent, err := services.ToAPIAgent(tx.Querier, row)
@@ -138,7 +149,7 @@ func (s *PostgreSQLService) Add(ctx context.Context, req *managementpb.AddPostgr
 				CommentsParsingDisabled: req.DisableCommentsParsing,
 				TLS:                     req.Tls,
 				TLSSkipVerify:           req.TlsSkipVerify,
-				PostgreSQLOptions:       models.PostgreSQLOptionsFromRequest(req),
+				PostgreSQLOptions:       options,
 				LogLevel:                services.SpecifyLogLevel(req.LogLevel, inventorypb.LogLevel_fatal),
 			})
 			if err != nil {
@@ -163,7 +174,7 @@ func (s *PostgreSQLService) Add(ctx context.Context, req *managementpb.AddPostgr
 				CommentsParsingDisabled: req.DisableCommentsParsing,
 				TLS:                     req.Tls,
 				TLSSkipVerify:           req.TlsSkipVerify,
-				PostgreSQLOptions:       models.PostgreSQLOptionsFromRequest(req),
+				PostgreSQLOptions:       options,
 				LogLevel:                services.SpecifyLogLevel(req.LogLevel, inventorypb.LogLevel_fatal),
 			})
 			if err != nil {