PMM-10231 Service Params Source

admin/commands/management/add.go

@@ -97,3 +97,27 @@ func processGlobalAddFlagsWithSocket(cmd connectionGetter, opts AddCommonFlags)
 
 	return serviceName, socket, host, uint16(portI), nil
 }
+
+// Determine if parameters were passed.
+var (
+	usernameParameterSpecified = false
+	passwordParameterSpecified = false
+)
+
+// Types for username and password
+type (
+	username string
+	password string
+)
+
+// AfterApply Change usernameParameterSpecified flag if argument was passed
+func (u username) AfterApply() error {
+	usernameParameterSpecified = true
+	return nil
+}
+
+// AfterApply Change passwordParameterSpecified flag if argument was passed
+func (p password) AfterApply() error {
+	passwordParameterSpecified = true
+	return nil
+}

admin/commands/management/add_external.go

@@ -57,7 +57,7 @@ type AddExternalCommand struct {
 	RunsOnNodeID        string            `name:"agent-node-id" help:"Node ID where agent runs (default is autodetected)"`
 	Username            string            `help:"External username"`
 	Password            string            `help:"External password"`
-	CredentialsSource   string            `type:"existingfile" help:"Credentials provider"`
+	ServiceParamsSource string            `help:"Path to file with service parameters"`
 	Scheme              string            `placeholder:"http or https" help:"Scheme to generate URI to exporter metrics endpoints"`
 	MetricsPath         string            `placeholder:"/metrics" help:"Path under which metrics are exposed, used to generate URI"`
 	ListenPort          uint16            `placeholder:"port" required:"" help:"Listen port of external exporter for scraping metrics. (Required)"`
@@ -71,18 +71,6 @@ type AddExternalCommand struct {
 	SkipConnectionCheck bool              `help:"Skip exporter connection checks"`
 }
 
-func (cmd *AddExternalCommand) GetCredentials() error {
-	creds, err := commands.ReadFromSource(cmd.CredentialsSource)
-	if err != nil {
-		return fmt.Errorf("%w", err)
-	}
-
-	cmd.Password = creds.Password
-	cmd.Username = creds.Username
-
-	return nil
-}
-
 func (cmd *AddExternalCommand) RunCmd() (commands.Result, error) {
 	customLabels := commands.ParseCustomLabels(cmd.CustomLabels)
 
@@ -110,12 +98,6 @@ func (cmd *AddExternalCommand) RunCmd() (commands.Result, error) {
 		cmd.MetricsPath = fmt.Sprintf("/%s", cmd.MetricsPath)
 	}
 
-	if cmd.CredentialsSource != "" {
-		if err := cmd.GetCredentials(); err != nil {
-			return nil, fmt.Errorf("failed to retrieve credentials from %s: %w", cmd.CredentialsSource, err)
-		}
-	}
-
 	params := &external.AddExternalParams{
 		Body: external.AddExternalBody{
 			RunsOnNodeID:        cmd.RunsOnNodeID,
@@ -133,6 +115,7 @@ func (cmd *AddExternalCommand) RunCmd() (commands.Result, error) {
 			MetricsMode:         pointer.ToString(strings.ToUpper(cmd.MetricsMode)),
 			Group:               cmd.Group,
 			SkipConnectionCheck: cmd.SkipConnectionCheck,
+			ServiceParamsSource: cmd.ServiceParamsSource,
 		},
 		Context: commands.Ctx,
 	}

admin/commands/management/add_external_serverless.go

@@ -53,7 +53,7 @@ type AddExternalServerlessCommand struct {
 	Scheme              string            `placeholder:"https" help:"Scheme to generate URI to exporter metrics endpoints"`
 	Username            string            `help:"External username"`
 	Password            string            `help:"External password"`
-	CredentialsSource   string            `type:"existingfile" help:"Credentials provider"`
+	ServiceParamsSource string            `help:"Path to file with service parameters"`
 	Address             string            `placeholder:"1.2.3.4:9000" help:"External exporter address and port"`
 	Host                string            `placeholder:"1.2.3.4" help:"External exporters hostname or IP address"`
 	ListenPort          uint16            `placeholder:"9999" help:"Listen port of external exporter for scraping metrics"`
@@ -88,18 +88,6 @@ or even you can specify --address instead of host and port as individual paramet
 `
 }
 
-func (cmd *AddExternalServerlessCommand) GetCredentials() error {
-	creds, err := commands.ReadFromSource(cmd.CredentialsSource)
-	if err != nil {
-		return fmt.Errorf("%w", err)
-	}
-
-	cmd.Password = creds.Password
-	cmd.Username = creds.Username
-
-	return nil
-}
-
 func (cmd *AddExternalServerlessCommand) RunCmd() (commands.Result, error) {
 	customLabels := commands.ParseCustomLabels(cmd.CustomLabels)
 
@@ -117,12 +105,6 @@ func (cmd *AddExternalServerlessCommand) RunCmd() (commands.Result, error) {
 		cmd.MetricsPath = fmt.Sprintf("/%s", cmd.MetricsPath)
 	}
 
-	if cmd.CredentialsSource != "" {
-		if err := cmd.GetCredentials(); err != nil {
-			return nil, fmt.Errorf("failed to retrieve credentials from %s: %w", cmd.CredentialsSource, err)
-		}
-	}
-
 	params := &external.AddExternalParams{
 		Body: external.AddExternalBody{
 			AddNode: &external.AddExternalParamsBodyAddNode{
@@ -151,6 +133,7 @@ func (cmd *AddExternalServerlessCommand) RunCmd() (commands.Result, error) {
 			MetricsMode:         pointer.ToString(external.AddExternalBodyMetricsModePULL),
 			Group:               cmd.Group,
 			SkipConnectionCheck: cmd.SkipConnectionCheck,
+			ServiceParamsSource: cmd.ServiceParamsSource,
 		},
 		Context: commands.Ctx,
 	}

admin/commands/management/add_haproxy.go

@@ -48,7 +48,7 @@ type AddHAProxyCommand struct {
 	ServiceName         string            `name:"name" arg:"" default:"${hostname}-haproxy" help:"Service name (autodetected default: ${hostname}-haproxy)"`
 	Username            string            `help:"HAProxy username"`
 	Password            string            `help:"HAProxy password"`
-	CredentialsSource   string            `type:"existingfile" help:"Credentials provider"`
+	ServiceParamsSource string            `help:"Path to file with service parameters"`
 	Scheme              string            `placeholder:"http or https" help:"Scheme to generate URI to exporter metrics endpoints"`
 	MetricsPath         string            `placeholder:"/metrics" help:"Path under which metrics are exposed, used to generate URI"`
 	ListenPort          uint16            `placeholder:"port" required:"" help:"Listen port of haproxy exposing the metrics for scraping metrics (Required)"`
@@ -61,18 +61,6 @@ type AddHAProxyCommand struct {
 	SkipConnectionCheck bool              `help:"Skip connection check"`
 }
 
-func (cmd *AddHAProxyCommand) GetCredentials() error {
-	creds, err := commands.ReadFromSource(cmd.CredentialsSource)
-	if err != nil {
-		return fmt.Errorf("%w", err)
-	}
-
-	cmd.Password = creds.Password
-	cmd.Username = creds.Username
-
-	return nil
-}
-
 func (cmd *AddHAProxyCommand) RunCmd() (commands.Result, error) {
 	isSupported, err := helpers.IsHAProxySupported()
 	if !isSupported {
@@ -95,12 +83,6 @@ func (cmd *AddHAProxyCommand) RunCmd() (commands.Result, error) {
 		cmd.MetricsPath = fmt.Sprintf("/%s", cmd.MetricsPath)
 	}
 
-	if cmd.CredentialsSource != "" {
-		if err := cmd.GetCredentials(); err != nil {
-			return nil, fmt.Errorf("failed to retrieve credentials from %s: %w", cmd.CredentialsSource, err)
-		}
-	}
-
 	params := &ha_proxy.AddHAProxyParams{
 		Body: ha_proxy.AddHAProxyBody{
 			ServiceName:         cmd.ServiceName,
@@ -116,6 +98,7 @@ func (cmd *AddHAProxyCommand) RunCmd() (commands.Result, error) {
 			CustomLabels:        customLabels,
 			MetricsMode:         pointer.ToString(strings.ToUpper(cmd.MetricsMode)),
 			SkipConnectionCheck: cmd.SkipConnectionCheck,
+			ServiceParamsSource: cmd.ServiceParamsSource,
 		},
 		Context: commands.Ctx,
 	}

admin/commands/management/add_mongodb.go

@@ -15,7 +15,6 @@
 package management
 
 import (
-	"fmt"
 	"strings"
 
 	"github.com/AlekSi/pointer"
@@ -51,15 +50,15 @@ func (res *addMongoDBResult) String() string {
 
 // AddMongoDBCommand is used by Kong for CLI flags and commands.
 type AddMongoDBCommand struct {
-	ServiceName       string `name:"name" arg:"" default:"${hostname}-mongodb" help:"Service name (autodetected default: ${hostname}-mongodb)"`
-	Address           string `arg:"" optional:"" help:"MongoDB address and port (default: 127.0.0.1:27017)"`
-	Socket            string `help:"Path to socket"`
-	NodeID            string `help:"Node ID (default is autodetected)"`
-	PMMAgentID        string `help:"The pmm-agent identifier which runs this instance (default is autodetected)"`
-	Username          string `help:"MongoDB username"`
-	Password          string `help:"MongoDB password"`
-	AgentPassword     string `help:"Custom password for /metrics endpoint"`
-	CredentialsSource string `type:"existingfile" help:"Credentials provider"`
+	ServiceName         string `name:"name" arg:"" default:"${hostname}-mongodb" help:"Service name (autodetected default: ${hostname}-mongodb)"`
+	Address             string `arg:"" optional:"" help:"MongoDB address and port (default: 127.0.0.1:27017)"`
+	Socket              string `help:"Path to socket"`
+	NodeID              string `help:"Node ID (default is autodetected)"`
+	PMMAgentID          string `help:"The pmm-agent identifier which runs this instance (default is autodetected)"`
+	Username            string `help:"MongoDB username"`
+	Password            string `help:"MongoDB password"`
+	AgentPassword       string `help:"Custom password for /metrics endpoint"`
+	ServiceParamsSource string `help:"Path to file with service parameters"`
 	// TODO add "auto"
 	QuerySource                   string            `default:"${mongoDbQuerySourceDefault}" enum:"${mongoDbQuerySourcesEnum}" help:"Source of queries, one of: ${mongoDbQuerySourcesEnum} (default: ${mongoDbQuerySourceDefault})"`
 	Environment                   string            `help:"Environment name"`
@@ -101,19 +100,6 @@ func (cmd *AddMongoDBCommand) GetSocket() string {
 	return cmd.Socket
 }
 
-func (cmd *AddMongoDBCommand) GetCredentials() error {
-	creds, err := commands.ReadFromSource(cmd.CredentialsSource)
-	if err != nil {
-		return fmt.Errorf("%w", err)
-	}
-
-	cmd.AgentPassword = creds.AgentPassword
-	cmd.Password = creds.Password
-	cmd.Username = creds.Username
-
-	return nil
-}
-
 func (cmd *AddMongoDBCommand) RunCmd() (commands.Result, error) {
 	customLabels := commands.ParseCustomLabels(cmd.CustomLabels)
 
@@ -144,26 +130,21 @@ func (cmd *AddMongoDBCommand) RunCmd() (commands.Result, error) {
 		return nil, err
 	}
 
-	if cmd.CredentialsSource != "" {
-		if err := cmd.GetCredentials(); err != nil {
-			return nil, fmt.Errorf("failed to retrieve credentials from %s: %w", cmd.CredentialsSource, err)
-		}
-	}
-
 	params := &mongodb.AddMongoDBParams{
 		Body: mongodb.AddMongoDBBody{
-			NodeID:         cmd.NodeID,
-			ServiceName:    serviceName,
-			Address:        host,
-			Port:           int64(port),
-			Socket:         socket,
-			PMMAgentID:     cmd.PMMAgentID,
-			Environment:    cmd.Environment,
-			Cluster:        cmd.Cluster,
-			ReplicationSet: cmd.ReplicationSet,
-			Username:       cmd.Username,
-			Password:       cmd.Password,
-			AgentPassword:  cmd.AgentPassword,
+			NodeID:              cmd.NodeID,
+			ServiceName:         serviceName,
+			Address:             host,
+			Port:                int64(port),
+			Socket:              socket,
+			PMMAgentID:          cmd.PMMAgentID,
+			Environment:         cmd.Environment,
+			Cluster:             cmd.Cluster,
+			ReplicationSet:      cmd.ReplicationSet,
+			Username:            cmd.Username,
+			Password:            cmd.Password,
+			AgentPassword:       cmd.AgentPassword,
+			ServiceParamsSource: cmd.ServiceParamsSource,
 
 			QANMongodbProfiler: cmd.QuerySource == MongodbQuerySourceProfiler,
 

admin/commands/management/add_mysql.go

@@ -89,14 +89,15 @@ func (res *addMySQLResult) TablestatStatus() string {
 
 // AddMySQLCommand is used by Kong for CLI flags and commands.
 type AddMySQLCommand struct {
-	ServiceName   string `name:"name" arg:"" default:"${hostname}-mysql" help:"Service name (autodetected default: ${hostname}-mysql)"`
-	Address       string `arg:"" optional:"" help:"MySQL address and port (default: 127.0.0.1:3306)"`
-	Socket        string `help:"Path to MySQL socket"`
-	NodeID        string `help:"Node ID (default is autodetected)"`
-	PMMAgentID    string `help:"The pmm-agent identifier which runs this instance (default is autodetected)"`
-	Username      string `default:"root" help:"MySQL username"`
-	Password      string `help:"MySQL password"`
-	AgentPassword string `help:"Custom password for /metrics endpoint"`
+	ServiceName         string   `name:"name" arg:"" default:"${hostname}-mysql" help:"Service name (autodetected default: ${hostname}-mysql)"`
+	Address             string   `arg:"" optional:"" help:"MySQL address and port (default: 127.0.0.1:3306)"`
+	Socket              string   `help:"Path to MySQL socket"`
+	NodeID              string   `help:"Node ID (default is autodetected)"`
+	PMMAgentID          string   `help:"The pmm-agent identifier which runs this instance (default is autodetected)"`
+	Username            username `help:"MySQL username"`
+	Password            string   `help:"MySQL password"`
+	AgentPassword       string   `help:"Custom password for /metrics endpoint"`
+	ServiceParamsSource string   `help:"Path to file with service parameters"`
 	// TODO add "auto", make it default
 	QuerySource            string            `default:"${mysqlQuerySourceDefault}" enum:"${mysqlQuerySourcesEnum}" help:"Source of SQL queries, one of: ${mysqlQuerySourcesEnum} (default: ${mysqlQuerySourceDefault})"`
 	MaxQueryLength         int32             `placeholder:"NUMBER" help:"Limit query length in QAN (default: server-defined; -1: no limit)"`
@@ -126,6 +127,11 @@ func (cmd *AddMySQLCommand) GetServiceName() string {
 	return cmd.ServiceName
 }
 
+// GetDefaultUsername Default username for mysql connections.
+func (cmd *AddMySQLCommand) GetDefaultUsername() string {
+	return "root"
+}
+
 func (cmd *AddMySQLCommand) GetAddress() string {
 	return cmd.Address
 }
@@ -180,6 +186,10 @@ func (cmd *AddMySQLCommand) RunCmd() (commands.Result, error) {
 		}
 	}
 
+	if cmd.ServiceParamsSource == "" && !usernameParameterSpecified {
+		cmd.Username = username(cmd.GetDefaultUsername())
+	}
+
 	serviceName, socket, host, port, err := processGlobalAddFlagsWithSocket(cmd, cmd.AddCommonFlags)
 	if err != nil {
 		return nil, err
@@ -196,19 +206,20 @@ func (cmd *AddMySQLCommand) RunCmd() (commands.Result, error) {
 
 	params := &mysql.AddMySQLParams{
 		Body: mysql.AddMySQLBody{
-			NodeID:         cmd.NodeID,
-			ServiceName:    serviceName,
-			Address:        host,
-			Socket:         socket,
-			Port:           int64(port),
-			PMMAgentID:     cmd.PMMAgentID,
-			Environment:    cmd.Environment,
-			Cluster:        cmd.Cluster,
-			ReplicationSet: cmd.ReplicationSet,
-			Username:       cmd.Username,
-			Password:       cmd.Password,
-			AgentPassword:  cmd.AgentPassword,
-			CustomLabels:   customLabels,
+			NodeID:              cmd.NodeID,
+			ServiceName:         serviceName,
+			Address:             host,
+			Socket:              socket,
+			Port:                int64(port),
+			PMMAgentID:          cmd.PMMAgentID,
+			Environment:         cmd.Environment,
+			Cluster:             cmd.Cluster,
+			ReplicationSet:      cmd.ReplicationSet,
+			Username:            string(cmd.Username),
+			Password:            cmd.Password,
+			AgentPassword:       cmd.AgentPassword,
+			CustomLabels:        customLabels,
+			ServiceParamsSource: cmd.ServiceParamsSource,
 
 			QANMysqlSlowlog:    cmd.QuerySource == MysqlQuerySourceSlowLog,
 			QANMysqlPerfschema: cmd.QuerySource == MysqlQuerySourcePerfSchema,