Merge pull request #574 from uber/lu.l

Provide solution to filter log fields by user demand
uber · Mar 4, 2019 · fcbf945 · fcbf945
2 parents eba639c + b9af148
commit fcbf945
Show file tree

Hide file tree

Showing 44 changed files with 725 additions and 382 deletions.
diff --git a/codegen/template_bundle/template_files.go b/codegen/template_bundle/template_files.go
diff --git a/codegen/templates/http_client.tmpl b/codegen/templates/http_client.tmpl
@@ -49,6 +49,7 @@ type {{$clientName}} struct {
 	clientID string
 	httpClient   *zanzibar.HTTPClient
 	circuitBreakerDisabled bool
+	requestUUIDHeaderKey string
 
 	{{if $sidecarRouter -}}
 	calleeHeader string
@@ -80,6 +81,10 @@ func {{$exportName}}(deps *module.Dependencies) Client {
 	if deps.Default.Config.ContainsKey("clients.{{$clientID}}.defaultHeaders") {
 		deps.Default.Config.MustGetStruct("clients.{{$clientID}}.defaultHeaders", &defaultHeaders)
 	}
+	var requestUUIDHeaderKey string
+	if deps.Default.Config.ContainsKey("http.clients.requestUUIDHeaderKey") {
+		requestUUIDHeaderKey = deps.Default.Config.MustGetString("http.clients.requestUUIDHeaderKey")
+	}
 
 
 	circuitBreakerDisabled := configureCicruitBreaker(deps, timeoutVal)
@@ -105,6 +110,7 @@ func {{$exportName}}(deps *module.Dependencies) Client {
 			timeout,
 		),
 		circuitBreakerDisabled: circuitBreakerDisabled,
+		requestUUIDHeaderKey: requestUUIDHeaderKey,
 	}
 }
 
@@ -169,6 +175,14 @@ func (c *{{$clientName}}) {{$methodName}}(
 	r {{.RequestType}},
 	{{end -}}
 ) ({{- if ne .ResponseType "" -}} {{.ResponseType}}, {{- end -}}map[string]string, error) {
+	reqUUID := zanzibar.RequestUUIDFromCtx(ctx)
+	if reqUUID != "" {
+		if headers == nil {
+			headers = make(map[string]string)
+		}
+		headers[c.requestUUIDHeaderKey] = reqUUID
+	}
+
 	{{if .ResponseType -}}
 	var defaultRes  {{.ResponseType}}
 	{{end -}}

diff --git a/codegen/templates/tchannel_client.tmpl b/codegen/templates/tchannel_client.tmpl
@@ -55,6 +55,10 @@ func {{$exportName}}(deps *module.Dependencies) Client {
 	if deps.Default.Config.ContainsKey("clients.{{$clientID}}.routingKey") {
 		routingKey = deps.Default.Config.MustGetString("clients.{{$clientID}}.routingKey")
 	}
+	var requestUUIDHeaderKey string
+	if deps.Default.Config.ContainsKey("tchannel.clients.requestUUIDHeaderKey") {
+		requestUUIDHeaderKey = deps.Default.Config.MustGetString("tchannel.clients.requestUUIDHeaderKey")
+	}
 	sc := deps.Default.Channel.GetSubChannel(serviceName, tchannel.Isolated)
 
 	{{if $sidecarRouter -}}
@@ -111,13 +115,14 @@ func {{$exportName}}(deps *module.Dependencies) Client {
 		deps.Default.Logger,
 		deps.Default.ContextMetrics,
 		&zanzibar.TChannelClientOption{
-			ServiceName:       serviceName,
-			ClientID:          "{{$clientID}}",
-			MethodNames:       methodNames,
-			Timeout:           timeout,
-			TimeoutPerAttempt: timeoutPerAttempt,
-			RoutingKey:        &routingKey,
-			AltSubchannelName: scAltName,
+			ServiceName:          serviceName,
+			ClientID:             "{{$clientID}}",
+			MethodNames:          methodNames,
+			Timeout:              timeout,
+			TimeoutPerAttempt:    timeoutPerAttempt,
+			RoutingKey:           &routingKey,
+			AltSubchannelName:    scAltName,
+			RequestUUIDHeaderKey: requestUUIDHeaderKey,
 		},
 	)
 

diff --git a/codegen/templates/workflow_mock.tmpl b/codegen/templates/workflow_mock.tmpl
@@ -49,8 +49,7 @@ func New{{$workflowInterface}}Mock(t *testing.T) (workflow.{{$workflowInterface}
 		Scope: tally.NewTestScope("", make(map[string]string)),
 	}
 	initializedDefaultDependencies.ContextLogger = zanzibar.NewContextLogger(initializedDefaultDependencies.Logger)
-	contextExtractors := &zanzibar.ContextExtractors{}
-	initializedDefaultDependencies.ContextExtractor = contextExtractors.MakeContextExtractor()
+	initializedDefaultDependencies.ContextExtractor = &zanzibar.ContextExtractors{}
 
 	{{range $idx, $className := $instance.DependencyOrder}}
 	{{- $moduleInstances := (index $instance.RecursiveDependencies $className)}}

diff --git a/examples/example-gateway/app.go b/examples/example-gateway/app.go
@@ -62,6 +62,11 @@ func getRequestTags(ctx context.Context) map[string]string {
 func getRequestFields(ctx context.Context) []zap.Field {
 	var fields []zap.Field
 	headers := zanzibar.GetEndpointRequestHeadersFromCtx(ctx)
+	uuid, ok := headers["X-Uuid"]
+	if !ok {
+		uuid = headers["x-uuid"]
+	}
+	fields = append(fields, zap.String("x-uuid", uuid))
 	fields = append(fields, zap.String("regionname", headers["Regionname"]))
 	fields = append(fields, zap.String("device", headers["Device"]))
 	fields = append(fields, zap.String("deviceversion", headers["Deviceversion"]))

diff --git a/...e-gateway/build/app/demo/endpoints/abc/mock-workflow/appdemoservice_call_workflow_mock.go b/...e-gateway/build/app/demo/endpoints/abc/mock-workflow/appdemoservice_call_workflow_mock.go