Skip to content

Migrates cmd/vtbench to pflags #11366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frouioui merged 4 commits into from
Sep 29, 2022
Merged

Migrates cmd/vtbench to pflags #11366

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
49b1f34
migrates cmd/vtbench to pflags
frouioui Sep 27, 2022
f283159
Finish moving to pflags in vtbench
frouioui Sep 28, 2022
b4b5957
Merge remote-tracking branch 'origin/main' into switch-pflag-vtbench
frouioui Sep 29, 2022
9f46586
Improve flags usage and logging in vtbench
frouioui Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 39 additions & 29 deletions go/cmd/vtbench/vtbench.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,22 +86,32 @@ import (
*/

var (
// connection flags
host = flag.String("host", "", "vtgate host(s) in the form 'host1,host2,...'")
port = flag.Int("port", 0, "vtgate port")
unixSocket = flag.String("unix_socket", "", "vtgate unix socket")
protocol = flag.String("protocol", "mysql", "client protocol, either mysql (default), grpc-vtgate, or grpc-vttablet")
user = flag.String("user", "", "username to connect using mysql (password comes from the db-credentials-file)")
db = flag.String("db", "", "db name to use when connecting / running the queries (e.g. @replica, keyspace, keyspace/shard etc)")

// test flags
deadline = flag.Duration("deadline", 5*time.Minute, "maximum duration for the test run (default 5 minutes)")
sql = flag.String("sql", "", "sql statement to execute")
threads = flag.Int("threads", 2, "number of parallel threads to run")
count = flag.Int("count", 1000, "number of queries per thread")
host, unixSocket, user, db, sql string
port int
protocol = "mysql"
deadline = 5 * time.Minute
threads = 2
count = 1000
)

func initFlags() {
pflag.StringVar(&host, "host", "", "vtgate host(s) in the form 'host1,host2,...'")
pflag.IntVar(&port, "port", 0, "vtgate port")
pflag.StringVar(&unixSocket, "unix_socket", "", "vtgate unix socket")
pflag.StringVar(&protocol, "protocol", protocol, "client protocol, either mysql (default), grpc-vtgate, or grpc-vttablet")
pflag.StringVar(&user, "user", "", "username to connect using mysql (password comes from the db-credentials-file)")
pflag.StringVar(&db, "db", "", "db name to use when connecting / running the queries (e.g. @replica, keyspace, keyspace/shard etc)")

pflag.DurationVar(&deadline, "deadline", deadline, "maximum duration for the test run (default 5 minutes)")
pflag.StringVar(&sql, "sql", "", "sql statement to execute")
pflag.IntVar(&threads, "threads", threads, "number of parallel threads to run")
pflag.IntVar(&count, "count", count, "number of queries per thread")
}

func main() {
servenv.OnParse(func(fs *pflag.FlagSet) {
initFlags()
})
logger := logutil.NewConsoleLogger()
flag.CommandLine.SetOutput(logutil.NewLoggerWriter(logger))

@frouioui frouioui Sep 27, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ajm188, I was not sure whether this needs to be removed or not. I can see that #11364 is getting rid of it. Let me know what I should follow :)

@ajm188 ajm188 Sep 27, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, it depends on what you want 😅

if you want to keep the behavior, you want to something like:

servenv.OnParse(func(fs *pflag.FlagSet) {
    fs.SetOutput(logutil.NewLoggerWriter(logger))
}

Comment thread
frouioui marked this conversation as resolved.

Expand All @@ -116,59 +126,59 @@ func main() {
_flag.Parse(fs)

clientProto := vtbench.MySQL
switch *protocol {
switch protocol {
case "", "mysql":
clientProto = vtbench.MySQL
case "grpc-vtgate":
clientProto = vtbench.GRPCVtgate
case "grpc-vttablet":
clientProto = vtbench.GRPCVttablet
default:
log.Exitf("invalid client protocol %s", *protocol)
log.Exitf("invalid client protocol %s", protocol)
}

if (*host != "" || *port != 0) && *unixSocket != "" {
if (host != "" || port != 0) && unixSocket != "" {
log.Exitf("can't specify both host:port and unix_socket")
}

if *host != "" && *port == 0 {
if host != "" && port == 0 {
log.Exitf("must specify port when using host")
}

if *host == "" && *port != 0 {
if host == "" && port != 0 {
log.Exitf("must specify host when using port")
}

if *host == "" && *port == 0 && *unixSocket == "" {
if host == "" && port == 0 && unixSocket == "" {
log.Exitf("vtbench requires either host/port or unix_socket")
}

if *sql == "" {
if sql == "" {
log.Exitf("must specify sql")
}

var password string
if clientProto == vtbench.MySQL {
var err error
_, password, err = dbconfigs.GetCredentialsServer().GetUserAndPassword(*user)
_, password, err = dbconfigs.GetCredentialsServer().GetUserAndPassword(user)
if err != nil {
log.Exitf("error reading password for user %v from file: %v", *user, err)
log.Exitf("error reading password for user %v from file: %v", user, err)
}
}

connParams := vtbench.ConnParams{
Hosts: strings.Split(*host, ","),
Port: *port,
UnixSocket: *unixSocket,
Hosts: strings.Split(host, ","),
Port: port,
UnixSocket: unixSocket,
Protocol: clientProto,
DB: *db,
Username: *user,
DB: db,
Username: user,
Password: password,
}

b := vtbench.NewBench(*threads, *count, connParams, *sql)
b := vtbench.NewBench(threads, count, connParams, sql)

ctx, cancel := context.WithTimeout(context.Background(), *deadline)
ctx, cancel := context.WithTimeout(context.Background(), deadline)
defer cancel()

fmt.Printf("Initializing test with %s protocol / %d threads / %d iterations\n",
Expand Down