Skip to content
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.

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

Added initial support for -t flag to show timings #428

Merged
merged 4 commits into from
Jan 24, 2024
Merged
Changes from 1 commit
Commits
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
54 changes: 54 additions & 0 deletions cmd/grpcurl/grpcurl.go
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ var (
Enable verbose output.`))
veryVerbose = flags.Bool("vv", false, prettify(`
Enable very verbose output.`))
showTimings = flags.Bool("t", false, prettify(`
Display debug timings.`))
serverName = flags.String("servername", "", prettify(`
Override server name when validating TLS certificate. This flag is
ignored if -plaintext or -insecure is used.
Expand Down Expand Up @@ -274,6 +276,12 @@ func (cs compositeSource) AllExtensionsForType(typeName string) ([]*desc.FieldDe
return exts, nil
}

type TimingData struct {
Title string
Value time.Duration
Sub []TimingData
}

func main() {
flags.Usage = usage
flags.Parse(os.Args[1:])
Expand Down Expand Up @@ -362,6 +370,9 @@ func main() {
if *veryVerbose {
verbosityLevel = 2
}
timingData := []TimingData{}
startTime := time.Now()
s := startTime

var symbol string
if invoke {
Expand Down Expand Up @@ -419,12 +430,20 @@ func main() {
}

dial := func() *grpc.ClientConn {
s := time.Now()
td := TimingData{
Title: "Dial",
}
dialTime := 10 * time.Second
if *connectTimeout > 0 {
dialTime = time.Duration(*connectTimeout * float64(time.Second))
}
ctx, cancel := context.WithTimeout(ctx, dialTime)
defer cancel()
defer func() {
td.Value = time.Now().Sub(s)
timingData = append(timingData, td)
}()
var opts []grpc.DialOption
if *keepaliveTime > 0 {
timeout := time.Duration(*keepaliveTime * float64(time.Second))
Expand All @@ -451,6 +470,7 @@ func main() {
}
creds = alts.NewClientCreds(clientOptions)
} else if usetls {
s := time.Now()
tlsConf, err := grpcurl.ClientTLSConfig(*insecure, *cacert, *cert, *key)
if err != nil {
fail(err, "Failed to create TLS config")
Expand Down Expand Up @@ -483,6 +503,10 @@ func main() {
if overrideName != "" {
opts = append(opts, grpc.WithAuthority(overrideName))
}
td.Sub = append(td.Sub, TimingData{
Title: "TLS Setup",
Value: time.Now().Sub(s),
})
} else {
panic("Should have defaulted to use TLS.")
}
Expand All @@ -500,10 +524,15 @@ func main() {
if isUnixSocket != nil && isUnixSocket() {
network = "unix"
}
s = time.Now()
cc, err := grpcurl.BlockingDial(ctx, network, target, creds, opts...)
if err != nil {
fail(err, "Failed to dial target host %q", target)
}
td.Sub = append(td.Sub, TimingData{
Title: "BlockingDial",
Value: time.Now().Sub(s),
})
return cc
}
printFormattedStatus := func(w io.Writer, stat *status.Status, formatter grpcurl.Formatter) {
Expand Down Expand Up @@ -747,6 +776,7 @@ func main() {
VerbosityLevel: verbosityLevel,
}

s = time.Now()
err = grpcurl.InvokeRPC(ctx, descSource, cc, symbol, append(addlHeaders, rpcHeaders...), h, rf.Next)
if err != nil {
if errStatus, ok := status.FromError(err); ok && *formatError {
Expand All @@ -755,6 +785,10 @@ func main() {
fail(err, "Error invoking method %q", symbol)
}
}
timingData = append(timingData, TimingData{
Title: "InvokeRPC",
Value: time.Now().Sub(s),
})
reqSuffix := ""
respSuffix := ""
reqCount := rf.NumRequests()
Expand All @@ -767,6 +801,15 @@ func main() {
if verbosityLevel > 0 {
fmt.Printf("Sent %d request%s and received %d response%s\n", reqCount, reqSuffix, h.NumResponses, respSuffix)
}
if *showTimings {
defer func() {
fmt.Printf("== Timing Data == \n")
for _, td := range timingData {
dumpTiming(td, 1)
}
fmt.Printf("\n Total time: %v\n", time.Now().Sub(startTime))
}()
}
if h.Status.Code() != codes.OK {
if *formatError {
printFormattedStatus(os.Stderr, h.Status, formatter)
Expand All @@ -778,6 +821,17 @@ func main() {
}
}

func dumpTiming(td TimingData, lvl int) {
indent := " "
for x := 0; x < lvl - 1; x++ {
indent += indent
}
fmt.Printf("%s%s: %s\n", indent, td.Title, td.Value)
for _, sd := range td.Sub {
dumpTiming(sd, lvl + 1)
}
}

func usage() {
fmt.Fprintf(os.Stderr, `Usage:
%s [flags] [address] [list|describe] [symbol]
Expand Down