Refactoring tracing

Signed-off-by: Michal Baczun <[email protected]>

Author: MBaczun

.github/dependabot.yml

@@ -1,25 +1,37 @@
+# Use https://dependabot.com/docs/config-file/validator/ to check for errors.
 version: 2
 updates:
   - package-ecosystem: "gomod"
     directory: "/"
     schedule:
       interval: "weekly"
 
-updates:
   - package-ecosystem: "gomod"
     directory: "/function-images/tests/chained-function-serving"
     schedule:
       interval: "weekly"
+
   - package-ecosystem: "gomod"
     directory: "/function-images/tests/chained-function-eventing"
     schedule:
       interval: "weekly"
+
   - package-ecosystem: "gomod"
     directory: "/utils/benchmarking/eventing"
     schedule:
       interval: "weekly"
-updates:
+
   - package-ecosystem: "gomod"
     directory: "/utils/tracing/go"
     schedule:
       interval: "weekly"
+
+  - package-ecosystem: "gomod"
+    directory: "/examples/deployer"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "gomod"
+    directory: "/examples/invoker"
+    schedule:
+      interval: "weekly"

.github/workflows/function-composition-push.yml

@@ -72,10 +72,10 @@ jobs:
       uses: docker/setup-buildx-action@v1
 
     - name: Build and push
-      working-directory: .
+      working-directory: ./function-images/tests/chained-function-serving
       run: |
-        make serving-all-image
-        make serving-all-image-push
+        make all-image
+        make all-image-push
 
   push-chained-functions-eventing:
       name: Push chained-functions-eventing-*

Makefile

@@ -138,22 +138,5 @@ test-cri:
 
 test-cri-travis: # Testing in travis is deprecated
 	$(MAKE) -C cri test-travis
-    
-serving-all-image: serving-producer-image serving-consumer-image
-
-serving-all-image-push: serving-producer-image-push serving-consumer-image-push
-    
-serving-producer-image: ./function-images/tests/chained-function-serving/Dockerfile ./function-images/tests/chained-function-serving/producer/producer.go ./function-images/tests/chained-function-serving/proto/prodcon.pb.go ./function-images/tests/chained-function-serving/proto/prodcon_grpc.pb.go
-	docker build --tag vhiveease/chained-functions-serving-producer:latest --build-arg target_arg=producer -f ./function-images/tests/chained-function-serving/Dockerfile .
-
-serving-producer-image-push: serving-producer-image
-	docker push vhiveease/chained-functions-serving-producer:latest
-
-
-serving-consumer-image: ./function-images/tests/chained-function-serving/Dockerfile ./function-images/tests/chained-function-serving/consumer/consumer.go ./function-images/tests/chained-function-serving/proto/prodcon.pb.go ./function-images/tests/chained-function-serving/proto/prodcon_grpc.pb.go
-	docker build --tag vhiveease/chained-functions-serving-consumer:latest --build-arg target_arg=consumer -f ./function-images/tests/chained-function-serving/Dockerfile .
-
-serving-consumer-image-push: serving-consumer-image
-	docker push vhiveease/chained-functions-serving-consumer:latest
 
 .PHONY: test-orch $(SUBDIRS) test-subdirs

configs/.wordlist.txt

@@ -89,6 +89,7 @@ crccheck
 cri
 CRI
 csv
+ctrdlog
 Ctrl
 Daglis
 datacenter
@@ -146,6 +147,7 @@ filesystem
 fmt
 Frontend
 fullstorydev
+FullTimestamp
 funcNames
 FunctionBench
 Fytraki
@@ -240,6 +242,7 @@ linux
 LLC
 loadStep
 localhost
+logrus
 Lorem
 Lotfi
 lsi
@@ -277,6 +280,7 @@ Nagarajan
 namespace
 namespaces
 namespacing
+NanoFixed
 nd
 Netrace
 NEURALWALKER
@@ -386,6 +390,7 @@ Seiculescu
 Sep
 serverfull
 serverless
+SetFormatter
 SGD
 sha
 shahab
@@ -426,10 +431,12 @@ TCO
 TempReader
 TestProfileIncrementConfiguration
 TestProfileSingleConfiguration
+TextFormatter
 th
 Timeseries
 timeseriesdb
 TimeseriesDB
+TimestampFormat
 TLB
 tmp
 tmux

docs/adding_benchmarks_guide.md

@@ -118,6 +118,18 @@ both for code maintenance and in demonstrating how the workload should be deploy
 to as an example in which the demo serving and eventing workloads are ran both "locally" and on
 a Knative cluster.
 
+### Logging
+When including logging within functions, please use `logrus` with the following format:
+```
+log.SetFormatter(&log.TextFormatter{
+		TimestampFormat: ctrdlog.RFC3339NanoFixed,
+		FullTimestamp:   true,
+	})
+```
+See 
+[this code snippet](https://github.com/ease-lab/vhive/blob/dfa0d400e17595a5fb0009ec8ab3211b5b4b7f9f/vhive.go#L102)
+for an example.
+
 ## Serving
 To compose functions with serving we make use of the 
 [Knative Serving component](https://knative.dev/docs/serving/). Each of the functions will 

examples/deployer/go.mod

@@ -0,0 +1,5 @@
+module github.com/ease-lab/vhive/examples/deployer
+
+go 1.16
+
+require github.com/sirupsen/logrus v1.8.1

examples/deployer/go.sum

@@ -0,0 +1,10 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
+github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
+github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

examples/invoker/client.go

@@ -33,6 +33,7 @@ import (
 	"sync/atomic"
 	"time"
 
+	ctrdlog "github.com/containerd/containerd/log"
 	pb "github.com/ease-lab/vhive/examples/protobuf/helloworld"
 	log "github.com/sirupsen/logrus"
 	"google.golang.org/grpc"
@@ -44,7 +45,7 @@ import (
 var (
 	completed   int64
 	latSlice    LatencySlice
-	port        int
+	portFlag    *int
 	withTracing *bool
 )
 
@@ -53,12 +54,24 @@ func main() {
 	rps := flag.Int("rps", 1, "Target requests per second")
 	runDuration := flag.Int("time", 5, "Run the benchmark for X seconds")
 	latencyOutputFile := flag.String("latf", "lat.csv", "CSV file for the latency measurements in microseconds")
-	portFlag := flag.Int("port", 80, "The port to use for all function invokations")
+	portFlag = flag.Int("port", 80, "The port that functions listen to")
 	withTracing = flag.Bool("trace", false, "Enable tracing in the client")
 	zipkin := flag.String("zipkin", "http://localhost:9411/api/v2/spans", "zipkin url")
+	debug := flag.Bool("dbg", false, "Enable debug logging")
 
 	flag.Parse()
-	port = *portFlag
+
+	log.SetFormatter(&log.TextFormatter{
+		TimestampFormat: ctrdlog.RFC3339NanoFixed,
+		FullTimestamp:   true,
+	})
+	log.SetOutput(os.Stdout)
+	if *debug {
+		log.SetLevel(log.DebugLevel)
+		log.Debug("Debug logging is enabled")
+	} else {
+		log.SetLevel(log.InfoLevel)
+	}
 
 	log.Info("Reading the URLs from the file: ", *urlFile)
 
@@ -68,7 +81,10 @@ func main() {
 	}
 
 	if *withTracing {
-		shutdown := tracing.InitBasicTracer(*zipkin, "invoker")
+		shutdown, err := tracing.InitBasicTracer(*zipkin, "invoker")
+		if err != nil {
+			log.Print(err)
+		}
 		defer shutdown()
 	}
 
@@ -122,9 +138,8 @@ func runBenchmark(urls []string, runDuration, targetRPS int) (realRPS float64) {
 func invokeFunction(url string) {
 	defer getDuration(startMeasurement(url)) // measure entire invocation time
 
-	address := fmt.Sprintf("%s:%d", url, port)
-
-	fmt.Printf("Address used: %v\n", address)
+	address := fmt.Sprintf("%s:%d", url, *portFlag)
+	log.Debug("Invoking by the address: %v", address)
 
 	var conn *grpc.ClientConn
 	var err error

examples/invoker/go.mod

@@ -0,0 +1,14 @@
+module github.com/ease-lab/vhive/examples/invoker
+
+go 1.16
+
+replace github.com/ease-lab/vhive/utils/tracing/go => ../../utils/tracing/go
+
+require (
+	github.com/containerd/containerd v1.5.2
+	github.com/ease-lab/vhive/examples/protobuf/helloworld v0.0.0-20210621160829-cea81c4fff31
+	github.com/ease-lab/vhive/utils/tracing/go v0.0.0-00010101000000-000000000000
+	github.com/sirupsen/logrus v1.8.1
+	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.20.0
+	google.golang.org/grpc v1.37.0
+)