Add readme

oavdeev · oavdeev · commit 82f8cb381aa5 · 2020-07-24T19:23:46.000+08:00
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Feast Load Test Proxy
+
+This is simple Go service generates load as part of the Feast testing suite. It sits between an HTTP based load testing tool as follows:
+
+```
+[Load Testing Tool] --(http)--> [Feast Load Test Proxy] --(grpc)--> [Feast Serving]
+```
+
+### Usage
+Start the proxy
+```
+LOAD_FEAST_SERVING_HOST=feast.serving.example.com LOAD_FEAST_SERVING_PORT=6566 go run main.go
+```
+```
+2020/07/24 14:00:02 Creating client to connect to Feast Serving at localhost:6566
+2020/07/24 14:00:02 Starting server on port:8080
+```
+
+The following command simply echos the version of Feast Serving. Useful for testing network latency
+```
+curl localhost:8080/echo
+```
+
+This command will send a single GetOnlineFeatures request to the configured Feast serving instance. The `entity_count` parameter is used to set how many entities will be sent (unique users in this case). The higher the number of entities the higher the expected latency.
+
+```
+curl localhost:8080/send?entity_count=30
+```
diff --git a/main.go b/main.go
@@ -26,12 +26,12 @@ func main() {
 		log.Fatal(err.Error())
 	}
 
+	log.Printf("Creating client to connect to Feast Serving at %s:%d", c.FeastServingHost, c.FeastServingPort)
 	client, err := feast.NewGrpcClient(c.FeastServingHost, c.FeastServingPort)
 	if err != nil {
 		log.Fatalf("Could not connect to: %v", err)
 	}
 
-
 	http.HandleFunc("/send", func(w http.ResponseWriter, r *http.Request) {
 		entityCountParam := r.URL.Query().Get("entity_count")
 		if len(entityCountParam) < 1 {
@@ -63,8 +63,7 @@ func main() {
 		w.WriteHeader(200)
 	})
 
-	log.Printf("Starting server on port: %s\n", c.ListenPort)
-
+	log.Printf("Starting server on port %s\n", c.ListenPort)
 	err = http.ListenAndServe(":"+c.ListenPort, nil)
 	if err != nil {
 		log.Fatalf("could not start server")
