From 994fc85650cbe27d803eccf73d3f6718d5dba9a3 Mon Sep 17 00:00:00 2001
From: Sameer Ajmani <sameer@golang.org>
Date: Sun, 9 Aug 2015 23:07:37 -0400
Subject: [PATCH] grpc: add trace.EventLog to ClientConn.

This event log records events that are interesting for live debugging
of a gRPC client.  In particular, this records when a connection is
established, broken, and reestablished.  The log is displayed on the
HTTP endpoint /debug/events in the family named "grpc.ClientConn".

Tested using a version of the route guide client modified to serve
HTTP and block at the end of main.
---
 clientconn.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/clientconn.go b/clientconn.go
index 52d47a57..f94d83b8 100644
--- a/clientconn.go
+++ b/clientconn.go
@@ -42,6 +42,7 @@ import (
 	"time"
 
 	"golang.org/x/net/context"
+	"golang.org/x/net/trace"
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/grpclog"
 	"google.golang.org/grpc/transport"
@@ -131,6 +132,7 @@ func Dial(target string, opts ...DialOption) (*ClientConn, error) {
 	}
 	cc := &ClientConn{
 		target:       target,
+		events:       trace.NewEventLog("grpc.ClientConn", target),
 		shutdownChan: make(chan struct{}),
 	}
 	for _, opt := range opts {
@@ -157,6 +159,7 @@ func Dial(target string, opts ...DialOption) (*ClientConn, error) {
 		// Start a goroutine connecting to the server asynchronously.
 		go func() {
 			if err := cc.resetTransport(false); err != nil {
+				cc.events.Errorf("dial failed: %v", err)
 				grpclog.Printf("Failed to dial %s: %v; please retry.", target, err)
 				cc.Close()
 				return
@@ -206,6 +209,7 @@ type ClientConn struct {
 	authority    string
 	dopts        dialOptions
 	shutdownChan chan struct{}
+	events       trace.EventLog
 
 	mu      sync.Mutex
 	state   ConnectivityState
@@ -320,9 +324,11 @@ func (cc *ClientConn) resetTransport(closeTransport bool) error {
 			closeTransport = false
 			time.Sleep(sleepTime)
 			retries++
+			cc.events.Errorf("connection failed, will retry: %v", err)
 			grpclog.Printf("grpc: ClientConn.resetTransport failed to create client transport: %v; Reconnecting to %q", err, cc.target)
 			continue
 		}
+		cc.events.Printf("connection established")
 		cc.mu.Lock()
 		if cc.state == Shutdown {
 			// cc.Close() has been invoked.
@@ -359,6 +365,7 @@ func (cc *ClientConn) transportMonitor() {
 			cc.mu.Unlock()
 			if err := cc.resetTransport(true); err != nil {
 				// The ClientConn is closing.
+				cc.events.Printf("transport exiting: %v", err)
 				grpclog.Printf("grpc: ClientConn.transportMonitor exits due to: %v", err)
 				return
 			}
@@ -411,6 +418,7 @@ func (cc *ClientConn) Close() error {
 	}
 	cc.state = Shutdown
 	cc.stateCV.Broadcast()
+	cc.events.Finish()
 	if cc.ready != nil {
 		close(cc.ready)
 		cc.ready = nil