Add user agent metrics

admin/auth.go

@@ -21,6 +21,9 @@ import (
 
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
+
+	"github.com/yorkie-team/yorkie/api/types"
+	"github.com/yorkie-team/yorkie/internal/version"
 )
 
 // AuthInterceptor is an interceptor for authentication.
@@ -52,7 +55,8 @@ func (i *AuthInterceptor) Unary() grpc.UnaryClientInterceptor {
 		opts ...grpc.CallOption,
 	) error {
 		ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs(
-			"authorization", i.token,
+			types.AuthorizationKey, i.token,
+			types.UserAgentKey, types.GoSDKType+"/"+version.Version,
 		))
 		return invoker(ctx, method, req, reply, cc, opts...)
 	}
@@ -69,7 +73,8 @@ func (i *AuthInterceptor) Stream() grpc.StreamClientInterceptor {
 		opts ...grpc.CallOption,
 	) (grpc.ClientStream, error) {
 		ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs(
-			"authorization", i.token,
+			types.AuthorizationKey, i.token,
+			types.UserAgentKey, types.GoSDKType+"/"+version.Version,
 		))
 		return streamer(ctx, desc, cc, method, opts...)
 	}

api/types/metadata.go

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2023 The Yorkie Authors. All rights reserved.
+ *
+ * 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 types
+
+// AuthorizationKey is the key of the authorization header.
+const AuthorizationKey = "authorization"
+
+// UserAgentKey is the key of the user agent header.
+const UserAgentKey = "x-yorkie-user-agent"
+
+// APIKeyKey is the key of the api key header.
+const APIKeyKey = "x-api-key"
+
+// GoSDKType is the type part of Go SDK in value of UserAgent.
+const GoSDKType = "yorkie-go-sdk"

client/auth.go

@@ -21,6 +21,9 @@ import (
 
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
+
+	"github.com/yorkie-team/yorkie/api/types"
+	"github.com/yorkie-team/yorkie/internal/version"
 )
 
 // AuthInterceptor is an interceptor for authentication.
@@ -49,8 +52,9 @@ func (i *AuthInterceptor) Unary() grpc.UnaryClientInterceptor {
 		opts ...grpc.CallOption,
 	) error {
 		ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs(
-			"x-api-key", i.apiKey,
-			"authorization", i.token,
+			types.APIKeyKey, i.apiKey,
+			types.AuthorizationKey, i.token,
+			types.UserAgentKey, types.GoSDKType+"/"+version.Version,
 		))
 		return invoker(ctx, method, req, reply, cc, opts...)
 	}
@@ -67,8 +71,9 @@ func (i *AuthInterceptor) Stream() grpc.StreamClientInterceptor {
 		opts ...grpc.CallOption,
 	) (grpc.ClientStream, error) {
 		ctx = metadata.NewOutgoingContext(ctx, metadata.Pairs(
-			"x-api-key", i.apiKey,
-			"authorization", i.token,
+			types.APIKeyKey, i.apiKey,
+			types.AuthorizationKey, i.token,
+			types.UserAgentKey, types.GoSDKType+"/"+version.Version,
 		))
 		return streamer(ctx, desc, cc, method, opts...)
 	}

cmd/yorkie/server.go

@@ -372,6 +372,12 @@ func init() {
 		server.DefaultAuthWebhookCacheUnauthTTL,
 		"TTL value to set when caching unauthorized webhook response.",
 	)
+	cmd.Flags().StringVar(
+		&conf.Backend.Hostname,
+		"hostname",
+		server.DefaultHostname,
+		"Yorkie Server Hostname",
+	)
 
 	rootCmd.AddCommand(cmd)
 }

server/admin/interceptors/auth.go

@@ -29,6 +29,7 @@ import (
 	"github.com/yorkie-team/yorkie/api/types"
 	"github.com/yorkie-team/yorkie/server/admin/auth"
 	"github.com/yorkie-team/yorkie/server/backend"
+	"github.com/yorkie-team/yorkie/server/grpchelper"
 	"github.com/yorkie-team/yorkie/server/users"
 )
 
@@ -59,11 +60,24 @@ func (i *AuthInterceptor) Unary() grpc.UnaryServerInterceptor {
 			if err != nil {
 				return nil, err
 			}
+			ctx = users.With(ctx, user)
+		}
 
-			return handler(users.With(ctx, user), req)
+		resp, err = handler(ctx, req)
+
+		// TODO(hackerwins, emplam27): Consider splitting between admin and sdk metrics.
+		data, ok := grpcmetadata.FromIncomingContext(ctx)
+		if ok {
+			sdkType, sdkVersion := grpchelper.SDKTypeAndVersion(data)
+			i.backend.Metrics.AddUserAgentWithEmptyProject(
+				i.backend.Config.Hostname,
+				sdkType,
+				sdkVersion,
+				info.FullMethod,
+			)
 		}
 
-		return handler(ctx, req)
+		return resp, err
 	}
 }
 
@@ -74,20 +88,34 @@ func (i *AuthInterceptor) Stream() grpc.StreamServerInterceptor {
 		stream grpc.ServerStream,
 		info *grpc.StreamServerInfo,
 		handler grpc.StreamHandler,
-	) error {
+	) (err error) {
+		ctx := stream.Context()
 		if isRequiredAuth(info.FullMethod) {
-			ctx := stream.Context()
 			user, err := i.authenticate(ctx, info.FullMethod)
 			if err != nil {
 				return err
 			}
 
 			wrapped := grpcmiddleware.WrapServerStream(stream)
 			wrapped.WrappedContext = users.With(ctx, user)
-			return handler(srv, wrapped)
+			stream = wrapped
+		}
+
+		err = handler(srv, stream)
+
+		// TODO(hackerwins, emplam27): Consider splitting between admin and sdk metrics.
+		data, ok := grpcmetadata.FromIncomingContext(ctx)
+		if ok {
+			sdkType, sdkVersion := grpchelper.SDKTypeAndVersion(data)
+			i.backend.Metrics.AddUserAgentWithEmptyProject(
+				i.backend.Config.Hostname,
+				sdkType,
+				sdkVersion,
+				info.FullMethod,
+			)
 		}
 
-		return handler(srv, stream)
+		return err
 	}
 }
 
@@ -113,7 +141,7 @@ func (i *AuthInterceptor) authenticate(
 		return nil, grpcstatus.Errorf(codes.Unauthenticated, "metadata is not provided")
 	}
 
-	authorization := data["authorization"]
+	authorization := data[types.AuthorizationKey]
 	if len(authorization) == 0 {
 		return nil, grpcstatus.Errorf(codes.Unauthenticated, "authorization is not provided")
 	}

server/admin/server.go

@@ -217,6 +217,7 @@ func (s *Server) CreateProject(
 	if err != nil {
 		return nil, err
 	}
+
 	return &api.CreateProjectResponse{
 		Project: pbProject,
 	}, nil
@@ -225,7 +226,7 @@ func (s *Server) CreateProject(
 // ListProjects lists all projects.
 func (s *Server) ListProjects(
 	ctx context.Context,
-	req *api.ListProjectsRequest,
+	_ *api.ListProjectsRequest,
 ) (*api.ListProjectsResponse, error) {
 	user := users.From(ctx)
 	projectList, err := projects.ListProjects(ctx, s.backend, user.ID)
@@ -258,6 +259,7 @@ func (s *Server) GetProject(
 	if err != nil {
 		return nil, err
 	}
+
 	return &api.GetProjectResponse{
 		Project: pbProject,
 	}, nil

server/backend/backend.go

@@ -65,9 +65,13 @@ func New(
 	clusterAddr string,
 	metrics *prometheus.Metrics,
 ) (*Backend, error) {
-	hostname, err := os.Hostname()
-	if err != nil {
-		return nil, fmt.Errorf("get hostname: %w", err)
+	hostname := conf.Hostname
+	if hostname == "" {
+		hostname, err := os.Hostname()
+		if err != nil {
+			return nil, fmt.Errorf("os.Hostname: %w", err)
+		}
+		conf.Hostname = hostname
 	}
 
 	serverInfo := &sync.ServerInfo{
@@ -80,6 +84,7 @@ func New(
 	bg := background.New()
 
 	var db database.Database
+	var err error
 	if mongoConf != nil {
 		db, err = mongo.Dial(mongoConf)
 		if err != nil {

server/backend/config.go

@@ -68,6 +68,9 @@ type Config struct {
 
 	// AuthWebhookCacheUnauthTTL is the TTL value to set when caching the unauthorized result.
 	AuthWebhookCacheUnauthTTL string `yaml:"AuthWebhookCacheUnauthTTL"`
+
+	// Hostname is yorkie server hostname. hostname is used by metrics.
+	Hostname string `yaml:"Hostname"`
 }
 
 // Validate validates this config.

server/config.go

@@ -65,6 +65,8 @@ const (
 	DefaultAuthWebhookCacheSize       = 5000
 	DefaultAuthWebhookCacheAuthTTL    = 10 * time.Second
 	DefaultAuthWebhookCacheUnauthTTL  = 10 * time.Second
+
+	DefaultHostname = ""
 )
 
 // Config is the configuration for creating a Yorkie instance.

server/config.sample.yml

@@ -71,6 +71,10 @@ Backend:
   # AuthWebhookCacheUnauthTTL is the TTL value to set when caching the unauthorized result.
   AuthWebhookCacheUnauthTTL: "10s"
 
+  # Hostname is the hostname of the server. If not provided, the hostname will be
+  # determined automatically by the OS (Optional, default: os.Hostname()).
+  Hostname: ""
+
 # Mongo is the MongoDB configuration (Optional).
 Mongo:
   # ConnectionTimeout is the timeout for connecting to MongoDB.

server/grpchelper/useragent.go

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2023 The Yorkie Authors. All rights reserved.
+ *
+ * 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 grpchelper
+
+import (
+	"strings"
+
+	grpcmetadata "google.golang.org/grpc/metadata"
+
+	"github.com/yorkie-team/yorkie/api/types"
+)
+
+// SDKTypeAndVersion returns the type and version of the SDK from the given
+// metadata.
+func SDKTypeAndVersion(data grpcmetadata.MD) (string, string) {
+	yorkieUserAgentSlice := data[types.UserAgentKey]
+	if len(yorkieUserAgentSlice) == 0 {
+		return "", ""
+	}
+
+	yorkieUserAgent := yorkieUserAgentSlice[0]
+	agent := strings.Split(yorkieUserAgent, "/")
+	return agent[0], agent[1]
+}

server/profiling/prometheus/metrics.go

@@ -26,11 +26,26 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promauto"
 	"google.golang.org/grpc"
 
+	"github.com/yorkie-team/yorkie/api/types"
 	"github.com/yorkie-team/yorkie/internal/version"
 )
 
 const (
-	namespace = "yorkie"
+	namespace        = "yorkie"
+	sdkTypeLabel     = "sdk_type"
+	sdkVersionLabel  = "sdk_version"
+	methodLabel      = "grpc_method"
+	projectIDLabel   = "project_id"
+	projectNameLabel = "project_name"
+	hostnameLabel    = "hostname"
+)
+
+var (
+	// emptyProject is used when the project is not specified.
+	emptyProject = &types.Project{
+		Name: "",
+		ID:   types.ID(""),
+	}
 )
 
 // Metrics manages the metric information that Yorkie is trying to measure.
@@ -47,6 +62,8 @@ type Metrics struct {
 	pushPullSentOperationsTotal     prometheus.Counter
 	pushPullSnapshotDurationSeconds prometheus.Histogram
 	pushPullSnapshotBytesTotal      prometheus.Counter
+
+	userAgentTotal *prometheus.CounterVec
 }
 
 // NewMetrics creates a new instance of Metrics.
@@ -118,6 +135,19 @@ func NewMetrics() (*Metrics, error) {
 			Name:      "snapshot_bytes_total",
 			Help:      "The total bytes of snapshots for response packs in PushPull.",
 		}),
+		userAgentTotal: promauto.With(reg).NewCounterVec(prometheus.CounterOpts{
+			Namespace: namespace,
+			Subsystem: "user_agent",
+			Name:      "total",
+			Help:      "description",
+		}, []string{
+			sdkTypeLabel,
+			sdkVersionLabel,
+			methodLabel,
+			projectIDLabel,
+			projectNameLabel,
+			hostnameLabel,
+		}),
 	}
 
 	metrics.serverVersion.With(prometheus.Labels{
@@ -168,6 +198,28 @@ func (m *Metrics) AddPushPullSnapshotBytes(bytes int) {
 	m.pushPullSnapshotBytesTotal.Add(float64(bytes))
 }
 
+// AddUserAgent adds the number of user agent.
+func (m *Metrics) AddUserAgent(
+	hostname string,
+	project *types.Project,
+	sdkType, sdkVersion string,
+	methodName string,
+) {
+	m.userAgentTotal.With(prometheus.Labels{
+		sdkTypeLabel:     sdkType,
+		sdkVersionLabel:  sdkVersion,
+		methodLabel:      methodName,
+		projectIDLabel:   project.ID.String(),
+		projectNameLabel: project.Name,
+		hostnameLabel:    hostname,
+	}).Inc()
+}
+
+// AddUserAgentWithEmptyProject adds the number of user agent with empty project.
+func (m *Metrics) AddUserAgentWithEmptyProject(hostname string, sdkType, sdkVersion, methodName string) {
+	m.AddUserAgent(hostname, emptyProject, sdkType, sdkVersion, methodName)
+}
+
 // RegisterGRPCServer registers the given gRPC server.
 func (m *Metrics) RegisterGRPCServer(server *grpc.Server) {
 	m.serverMetrics.InitializeMetrics(server)