Add tracing sample and update functions-framework-go to "v0.2.2"

tpiperatgod · tpiperatgod · commit 935029d09f19 · 2022-03-24T16:02:40.000+08:00
Signed-off-by: laminar &lt;fangtian@kubesphere.io&gt;
diff --git a/README.md b/README.md
@@ -26,6 +26,10 @@ We currently support two kinds of runtime, knative and async.
 - Async pubsub sample in [go](functions/async/pubsub)
 - Logs handler function [go](functions/async/logs-handler-function)
 
+### Other samples
+
+- [Tracing sample](functions/tracing/README.md)
+
 ## Application samples
 
 - [Java App](apps/sample-apps-java-maven.yaml)
diff --git a/functions-framework/golang/Async/bindings/with-output/go.mod b/functions-framework/golang/Async/bindings/with-output/go.mod
@@ -3,7 +3,7 @@ module main.go
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/fatih/structs v1.1.0
 	k8s.io/klog/v2 v2.40.1
 )
diff --git a/functions-framework/golang/Async/bindings/without-output/go.mod b/functions-framework/golang/Async/bindings/without-output/go.mod
@@ -3,7 +3,7 @@ module main.go
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/fatih/structs v1.1.0
 	k8s.io/klog/v2 v2.40.1
 )
diff --git a/functions-framework/golang/Async/pubsub/pub/go.mod b/functions-framework/golang/Async/pubsub/pub/go.mod
@@ -3,7 +3,7 @@ module main.go
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	k8s.io/klog/v2 v2.40.1
 )
 
diff --git a/functions-framework/golang/Async/pubsub/sub/go.mod b/functions-framework/golang/Async/pubsub/sub/go.mod
@@ -3,7 +3,7 @@ module main.go
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	k8s.io/klog/v2 v2.40.1
 )
 
diff --git a/functions-framework/golang/Knative/cloudevents/go.mod b/functions-framework/golang/Knative/cloudevents/go.mod
@@ -4,7 +4,7 @@ go 1.16
 
 require (
 	github.com/cloudevents/sdk-go/v2 v2.4.1
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/fatih/structs v1.1.0
 	k8s.io/klog/v2 v2.30.0
 )
diff --git a/functions-framework/golang/Knative/http/go.mod b/functions-framework/golang/Knative/http/go.mod
@@ -3,7 +3,7 @@ module main.go
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/fatih/structs v1.1.0
 	k8s.io/klog/v2 v2.30.0
 )
diff --git a/functions/async/bindings/cron-input-kafka-output/go.mod b/functions/async/bindings/cron-input-kafka-output/go.mod
@@ -2,4 +2,4 @@ module example.com/bindings
 
 go 1.16
 
-require github.com/OpenFunction/functions-framework-go v0.2.1
+require github.com/OpenFunction/functions-framework-go v0.2.2
diff --git a/functions/async/bindings/cron-input/go.mod b/functions/async/bindings/cron-input/go.mod
@@ -2,4 +2,4 @@ module example.com/bindings
 
 go 1.16
 
-require github.com/OpenFunction/functions-framework-go v0.2.1
+require github.com/OpenFunction/functions-framework-go v0.2.2
diff --git a/functions/async/bindings/kafka-input/go.mod b/functions/async/bindings/kafka-input/go.mod
@@ -2,4 +2,4 @@ module example.com/bindings
 
 go 1.16
 
-require github.com/OpenFunction/functions-framework-go v0.2.1
+require github.com/OpenFunction/functions-framework-go v0.2.2
diff --git a/functions/async/logs-handler-function/go.mod b/functions/async/logs-handler-function/go.mod
@@ -3,6 +3,6 @@ module example.com/logshandler
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/prometheus/alertmanager v0.22.2
 )
diff --git a/functions/async/pubsub/subscriber/go.mod b/functions/async/pubsub/subscriber/go.mod
@@ -2,4 +2,4 @@ module example.com/subscriber
 
 go 1.16
 
-require github.com/OpenFunction/functions-framework-go v0.2.1
+require github.com/OpenFunction/functions-framework-go v0.2.2
diff --git a/functions/knative/with-output-binding/go.mod b/functions/knative/with-output-binding/go.mod
@@ -3,6 +3,6 @@ module example.com/bindings
 go 1.16
 
 require (
-	github.com/OpenFunction/functions-framework-go v0.2.1
+	github.com/OpenFunction/functions-framework-go v0.2.2
 	github.com/fatih/structs v1.1.0
 )
diff --git a/functions/tracing/README.md b/functions/tracing/README.md
@@ -0,0 +1,128 @@
+# Function tracing sample
+
+It is well known that FaaS often blocks some of the underlying implementations for developers to allow them to focus on their business code. This makes it difficult to troubleshoot the service system. So we tried to introduce observable capabilities to OpenFunction to improve its usability and stability.
+
+SkyWalking provides solutions for observing and monitoring distributed systems, in many different scenarios. 
+
+We have now introduced SkyWalking (go2sky) for OpenFunction as a distributed tracing solution for Go language functions. We will demonstrate it in this sample.
+
+## Prerequisites
+
+The design of this sample is the same as sample [with-output-binding](https://github.com/OpenFunction/samples/blob/main/functions/knative/with-output-binding/README.md), but with some minor changes, which we will explain in the process.
+
+![](../../images/knative-dapr.png)
+
+
+Follow [this guide](https://github.com/OpenFunction/samples/blob/main/Prerequisites.md#openfunction) to install OpenFunction.
+
+Follow [this guide](https://github.com/apache/skywalking-kubernetes#apache-skywalking-kubernetes) to install SkyWalking.
+
+Follow [this guide](https://github.com/OpenFunction/samples/blob/main/Prerequisites.md#kafka) to install a Kafka server named `kafka-server` and a Topic named `sample-topic`.
+
+Follow [this guide](https://github.com/OpenFunction/samples/blob/main/Prerequisites.md#registry-credential) to create a registry credential.
+
+## Tracing parameters
+
+| Name               | Description                                                  | Example                |
+| ------------------ | ------------------------------------------------------------ | ---------------------- |
+| enabled            | Switch for tracing, default to `false`                       | true, false            |
+| provider.name      | Provider name can be set to "skywalking", "opentelemetry" (pending) | "skywalking"           |
+| provider.oapServer | The oap server address                                       | "skywalking-opa:11800" |
+| tags               | A collection of key-value pairs for Span custom tags in tracing |                        |
+| tags.func          | The name of function. It will be automatically filled        | "function-a"           |
+| tags.layer         | Indicates the type of service being tracked. It should be set to "faas" when you use the function | "faas"                 |
+| baggage            | A collection of key-value pairs, exists in the tracing and also needs to be transferred across process boundaries |                        |
+
+The following is a JSON formatted configuration reference that will guide the formatting structure of the tracing configuration:
+
+```json
+{
+  "enabled": true,
+  "provider": {
+    "name": "skywalking",
+    "oapServer": "skywalking-oap:11800"
+  },
+  "tags": {
+    "func": "function-a",
+    "layer": "faas",
+    "tag1": "value1",
+    "tag2": "value2"
+  },
+  "baggage": {
+    "key": "key1",
+    "value": "value1"
+  }
+}
+```
+
+## Deployment
+
+First, we need to enable OpenFunction's tracing configuration.
+
+We provide two ways to enable the function tracing capability:
+
+> Here we assume that the skywalking-opa address in your cluster is `skywalking-opa.default:11800`
+
+- Global configuration
+
+  Modify the ConfigMap resource `openfunction-config` in the `openfunction` namespace.
+
+  You should add `data.plugins.tracing` as follows:
+
+  ```yaml
+  data:
+    plugins.tracing: |
+      enabled: true
+      provider:
+        name: "skywalking"
+        oapServer: "skywalking-oap:11800"
+      tags:
+        func: tracing-function
+        layer: faas
+        tag1: value1
+        tag2: value2
+      baggage:
+        key: "key1"
+        value: "value1"
+  ```
+  
+- Function-level configuration
+
+  You should add `plugins.tracing` in the `metadata.annotations` in Function spec.
+
+  ```yaml
+  metadata:
+    name: tracing-function
+    annotations:
+      plugins.tracing: |
+        enabled: true
+        provider:
+          name: "skywalking"
+          oapServer: "skywalking-oap:11800"
+        tags:
+          func: tracing-function
+          layer: faas
+          tag1: value1
+          tag2: value2
+        baggage:
+          key: "key1"
+          value: "value1"
+  ```
+
+Then we can follow [this guide](https://github.com/OpenFunction/samples/blob/main/functions/knative/with-output-binding/README.md#deployment) (it recommends using the global tracing configuration, otherwise, you need to add function-level tracing configuration for both functions based on this sample) to deploy two functions for demonstrating the tracing effect of the entire link. 
+
+## Result
+
+Once it's all done, you can observe the flow of entire link on the SkyWalking UI.
+
+![](../../images/tracing-topology.gif)
+
+We can also observe the comparison of the response time of the Knative runtime function (function-front) in the running state and under cold start:
+
+In cold start:
+
+![](../../images/tracing-time-in-cold-start.png)
+
+In running:
+
+![](../../images/tracing-time-in-running.png)
diff --git a/images/tracing-time-in-cold-start.png b/images/tracing-time-in-cold-start.png
diff --git a/images/tracing-time-in-running.png b/images/tracing-time-in-running.png
diff --git a/images/tracing-topology.gif b/images/tracing-topology.gif

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ module main.go`
`3`	`3`	`go 1.16`
`4`	`4`
`5`	`5`	`require (`
`6`		`- github.com/OpenFunction/functions-framework-go v0.2.1`
	`6`	`+ github.com/OpenFunction/functions-framework-go v0.2.2`
`7`	`7`	`github.com/fatih/structs v1.1.0`
`8`	`8`	`k8s.io/klog/v2 v2.40.1`
`9`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ go 1.16`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/cloudevents/sdk-go/v2 v2.4.1`
`7`		`- github.com/OpenFunction/functions-framework-go v0.2.1`
	`7`	`+ github.com/OpenFunction/functions-framework-go v0.2.2`
`8`	`8`	`github.com/fatih/structs v1.1.0`
`9`	`9`	`k8s.io/klog/v2 v2.30.0`
`10`	`10`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@ module example.com/bindings`
`2`	`2`
`3`	`3`	`go 1.16`
`4`	`4`
`5`		`-require github.com/OpenFunction/functions-framework-go v0.2.1`
	`5`	`+require github.com/OpenFunction/functions-framework-go v0.2.2`