From adc2e8873f0bf6f62e0cc4127f20c808d3b732aa Mon Sep 17 00:00:00 2001
From: "stonezdj(Daojun Zhang)" <stonezdj@gmail.com>
Date: Mon, 25 Oct 2021 17:09:59 +0800
Subject: [PATCH] Add hostname to trace span name (#15806)

Fixes #15726, unify the trace span name in all components

Signed-off-by: stonezdj <stonezdj@gmail.com>
---
 src/lib/trace/helper.go      | 17 ++++++-
 src/lib/trace/helper_test.go | 90 ++++++++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+), 2 deletions(-)
 create mode 100644 src/lib/trace/helper_test.go

diff --git a/src/lib/trace/helper.go b/src/lib/trace/helper.go
index bd947d490..f6800e2cf 100644
--- a/src/lib/trace/helper.go
+++ b/src/lib/trace/helper.go
@@ -16,6 +16,7 @@ package trace
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 
 	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
@@ -51,8 +52,20 @@ func RecordError(span oteltrace.Span, err error, description string) {
 
 // HarborSpanNameFormatter common span name formatter in Harbor
 func HarborSpanNameFormatter(operation string, r *http.Request) string {
-	if len(r.URL.Path) != 0 {
-		return r.Method + "_" + r.URL.Path
+	schema := "http"
+	if r.URL != nil && len(r.URL.Scheme) != 0 {
+		schema = r.URL.Scheme
+	}
+	host := "host_unknown"
+	if len(r.Host) != 0 {
+		host = r.Host
+	}
+	path := ""
+	if r.URL != nil && len(r.URL.Path) != 0 {
+		path = r.URL.Path
+	}
+	if len(path) != 0 {
+		return fmt.Sprintf("%s %s://%s%s", r.Method, schema, host, path)
 	}
 	return operation
 }
diff --git a/src/lib/trace/helper_test.go b/src/lib/trace/helper_test.go
new file mode 100644
index 000000000..fb47cf8a9
--- /dev/null
+++ b/src/lib/trace/helper_test.go
@@ -0,0 +1,90 @@
+//  Copyright Project Harbor Authors
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+package trace
+
+import (
+	"net/http"
+	"net/url"
+	"testing"
+)
+
+func TestHarborSpanNameFormatter(t *testing.T) {
+	type args struct {
+		operation string
+		request   *http.Request
+	}
+	normalReq, err := http.NewRequest("GET", "http://10.192.168.1/api/v2.0/configuration", nil)
+	if err != nil {
+		t.Error(err)
+	}
+	normalReqWithHTTPS, err := http.NewRequest("GET", "https://10.192.168.1/api/v2.0/configuration", nil)
+	if err != nil {
+		t.Error(err)
+	}
+	cases := []struct {
+		name string
+		in   args
+		want string
+	}{
+		{
+			name: `normal`,
+			in:   args{"sample", &http.Request{Host: "10.192.168.1", Method: http.MethodGet, URL: &url.URL{Scheme: "http", Path: "/api/v2.0/configuration"}}},
+			want: "GET http://10.192.168.1/api/v2.0/configuration",
+		},
+		{
+			name: `normal request `,
+			in:   args{"sample", normalReq},
+			want: "GET http://10.192.168.1/api/v2.0/configuration",
+		},
+		{
+			name: `normal request with https `,
+			in:   args{"sample", normalReqWithHTTPS},
+			want: "GET https://10.192.168.1/api/v2.0/configuration",
+		},
+		{
+			name: `no host`,
+			in:   args{"sample", &http.Request{Method: http.MethodGet, URL: &url.URL{Scheme: "http", Path: "/api/v2.0/configuration"}}},
+			want: "GET http://host_unknown/api/v2.0/configuration",
+		},
+		{
+			name: `no schema`,
+			in:   args{"sample", &http.Request{Host: "10.192.168.1", Method: http.MethodGet, URL: &url.URL{Path: "/api/v2.0/configuration"}}},
+			want: "GET http://10.192.168.1/api/v2.0/configuration",
+		},
+		{
+			name: `https`,
+			in:   args{"sample", &http.Request{Host: "10.192.168.1", Method: http.MethodGet, URL: &url.URL{Scheme: "https", Path: "/api/v2.0/configuration"}}},
+			want: "GET https://10.192.168.1/api/v2.0/configuration",
+		},
+		{
+			name: `empty path`,
+			in:   args{"sample", &http.Request{Host: "10.192.168.1", Method: http.MethodGet, URL: &url.URL{Scheme: "http"}}},
+			want: "sample",
+		},
+		{
+			name: `nil url`,
+			in:   args{"sample", &http.Request{Host: "10.192.168.1", Method: http.MethodGet}},
+			want: "sample",
+		},
+	}
+	for _, tt := range cases {
+		t.Run(tt.name, func(t *testing.T) {
+			got := HarborSpanNameFormatter(tt.in.operation, tt.in.request)
+			if got != tt.want {
+				t.Errorf(`(%v) = %v; want "%v"`, tt.in, got, tt.want)
+			}
+		})
+	}
+}