From 556d5dec05e4ec82deae5e477afcdff8fbd5e2e1 Mon Sep 17 00:00:00 2001
From: Gabriel Corado <gabriel.oliveira@goteleport.com>
Date: Mon, 3 Feb 2025 14:06:49 -0300
Subject: [PATCH] [v17] Add database User Agent to session start usage event
 (#51705)

* feat(usagereporter): add user agent to database session start usage event (#51591)

* Reconcile prehog protos (#51563)

---------

Co-authored-by: Noah Stride <noah.stride@goteleport.com>
---
 gen/proto/go/prehog/v1alpha/teleport.pb.go | 27 ++++++++++-----
 gen/proto/ts/prehog/v1alpha/teleport_pb.ts | 16 ++++++++-
 lib/usagereporter/teleport/audit.go        |  1 +
 lib/usagereporter/teleport/audit_test.go   | 39 ++++++++++++++++++++++
 lib/usagereporter/teleport/types.go        |  1 +
 proto/prehog/v1alpha/teleport.proto        |  2 ++
 6 files changed, 77 insertions(+), 9 deletions(-)

diff --git a/gen/proto/go/prehog/v1alpha/teleport.pb.go b/gen/proto/go/prehog/v1alpha/teleport.pb.go
index b8a734f93a883..4eb575cc171ec 100644
--- a/gen/proto/go/prehog/v1alpha/teleport.pb.go
+++ b/gen/proto/go/prehog/v1alpha/teleport.pb.go
@@ -1665,6 +1665,8 @@ type SessionStartDatabaseMetadata struct {
 	DbProtocol string `protobuf:"bytes,2,opt,name=db_protocol,json=dbProtocol,proto3" json:"db_protocol,omitempty"`
 	// database origin source.
 	DbOrigin string `protobuf:"bytes,3,opt,name=db_origin,json=dbOrigin,proto3" json:"db_origin,omitempty"`
+	// Indicates the client used on the session.
+	UserAgent string `protobuf:"bytes,4,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
 }
 
 func (x *SessionStartDatabaseMetadata) Reset() {
@@ -1718,6 +1720,13 @@ func (x *SessionStartDatabaseMetadata) GetDbOrigin() string {
 	return ""
 }
 
+func (x *SessionStartDatabaseMetadata) GetUserAgent() string {
+	if x != nil {
+		return x.UserAgent
+	}
+	return ""
+}
+
 // SessionStartDesktop Metadata contains additional information about
 // a desktop session.
 type SessionStartDesktopMetadata struct {
@@ -9529,14 +9538,16 @@ var file_prehog_v1alpha_teleport_proto_rawDesc = []byte{
 	0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x27, 0x2e, 0x70, 0x72, 0x65, 0x68, 0x6f, 0x67, 0x2e, 0x76,
 	0x31, 0x61, 0x6c, 0x70, 0x68, 0x61, 0x2e, 0x53, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x53, 0x74,
 	0x61, 0x72, 0x74, 0x41, 0x70, 0x70, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0x52, 0x03,
-	0x61, 0x70, 0x70, 0x22, 0x75, 0x0a, 0x1c, 0x53, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x53, 0x74,
-	0x61, 0x72, 0x74, 0x44, 0x61, 0x74, 0x61, 0x62, 0x61, 0x73, 0x65, 0x4d, 0x65, 0x74, 0x61, 0x64,
-	0x61, 0x74, 0x61, 0x12, 0x17, 0x0a, 0x07, 0x64, 0x62, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x01,
-	0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x64, 0x62, 0x54, 0x79, 0x70, 0x65, 0x12, 0x1f, 0x0a, 0x0b,
-	0x64, 0x62, 0x5f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x18, 0x02, 0x20, 0x01, 0x28,
-	0x09, 0x52, 0x0a, 0x64, 0x62, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x12, 0x1b, 0x0a,
-	0x09, 0x64, 0x62, 0x5f, 0x6f, 0x72, 0x69, 0x67, 0x69, 0x6e, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09,
-	0x52, 0x08, 0x64, 0x62, 0x4f, 0x72, 0x69, 0x67, 0x69, 0x6e, 0x22, 0xc1, 0x01, 0x0a, 0x1b, 0x53,
+	0x61, 0x70, 0x70, 0x22, 0x94, 0x01, 0x0a, 0x1c, 0x53, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x53,
+	0x74, 0x61, 0x72, 0x74, 0x44, 0x61, 0x74, 0x61, 0x62, 0x61, 0x73, 0x65, 0x4d, 0x65, 0x74, 0x61,
+	0x64, 0x61, 0x74, 0x61, 0x12, 0x17, 0x0a, 0x07, 0x64, 0x62, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18,
+	0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x64, 0x62, 0x54, 0x79, 0x70, 0x65, 0x12, 0x1f, 0x0a,
+	0x0b, 0x64, 0x62, 0x5f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x18, 0x02, 0x20, 0x01,
+	0x28, 0x09, 0x52, 0x0a, 0x64, 0x62, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x6f, 0x6c, 0x12, 0x1b,
+	0x0a, 0x09, 0x64, 0x62, 0x5f, 0x6f, 0x72, 0x69, 0x67, 0x69, 0x6e, 0x18, 0x03, 0x20, 0x01, 0x28,
+	0x09, 0x52, 0x08, 0x64, 0x62, 0x4f, 0x72, 0x69, 0x67, 0x69, 0x6e, 0x12, 0x1d, 0x0a, 0x0a, 0x75,
+	0x73, 0x65, 0x72, 0x5f, 0x61, 0x67, 0x65, 0x6e, 0x74, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09, 0x52,
+	0x09, 0x75, 0x73, 0x65, 0x72, 0x41, 0x67, 0x65, 0x6e, 0x74, 0x22, 0xc1, 0x01, 0x0a, 0x1b, 0x53,
 	0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x53, 0x74, 0x61, 0x72, 0x74, 0x44, 0x65, 0x73, 0x6b, 0x74,
 	0x6f, 0x70, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0x12, 0x21, 0x0a, 0x0c, 0x64, 0x65,
 	0x73, 0x6b, 0x74, 0x6f, 0x70, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09,
diff --git a/gen/proto/ts/prehog/v1alpha/teleport_pb.ts b/gen/proto/ts/prehog/v1alpha/teleport_pb.ts
index 07701164559c8..e9a89c0d86438 100644
--- a/gen/proto/ts/prehog/v1alpha/teleport_pb.ts
+++ b/gen/proto/ts/prehog/v1alpha/teleport_pb.ts
@@ -303,6 +303,12 @@ export interface SessionStartDatabaseMetadata {
      * @generated from protobuf field: string db_origin = 3;
      */
     dbOrigin: string;
+    /**
+     * Indicates the client used on the session.
+     *
+     * @generated from protobuf field: string user_agent = 4;
+     */
+    userAgent: string;
 }
 /**
  * SessionStartDesktop Metadata contains additional information about
@@ -4478,7 +4484,8 @@ class SessionStartDatabaseMetadata$Type extends MessageType<SessionStartDatabase
         super("prehog.v1alpha.SessionStartDatabaseMetadata", [
             { no: 1, name: "db_type", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
             { no: 2, name: "db_protocol", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-            { no: 3, name: "db_origin", kind: "scalar", T: 9 /*ScalarType.STRING*/ }
+            { no: 3, name: "db_origin", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 4, name: "user_agent", kind: "scalar", T: 9 /*ScalarType.STRING*/ }
         ]);
     }
     create(value?: PartialMessage<SessionStartDatabaseMetadata>): SessionStartDatabaseMetadata {
@@ -4486,6 +4493,7 @@ class SessionStartDatabaseMetadata$Type extends MessageType<SessionStartDatabase
         message.dbType = "";
         message.dbProtocol = "";
         message.dbOrigin = "";
+        message.userAgent = "";
         if (value !== undefined)
             reflectionMergePartial<SessionStartDatabaseMetadata>(this, message, value);
         return message;
@@ -4504,6 +4512,9 @@ class SessionStartDatabaseMetadata$Type extends MessageType<SessionStartDatabase
                 case /* string db_origin */ 3:
                     message.dbOrigin = reader.string();
                     break;
+                case /* string user_agent */ 4:
+                    message.userAgent = reader.string();
+                    break;
                 default:
                     let u = options.readUnknownField;
                     if (u === "throw")
@@ -4525,6 +4536,9 @@ class SessionStartDatabaseMetadata$Type extends MessageType<SessionStartDatabase
         /* string db_origin = 3; */
         if (message.dbOrigin !== "")
             writer.tag(3, WireType.LengthDelimited).string(message.dbOrigin);
+        /* string user_agent = 4; */
+        if (message.userAgent !== "")
+            writer.tag(4, WireType.LengthDelimited).string(message.userAgent);
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
diff --git a/lib/usagereporter/teleport/audit.go b/lib/usagereporter/teleport/audit.go
index a1108374bb3fc..b492b40a56855 100644
--- a/lib/usagereporter/teleport/audit.go
+++ b/lib/usagereporter/teleport/audit.go
@@ -110,6 +110,7 @@ func ConvertAuditEvent(event apievents.AuditEvent) Anonymizable {
 				DbType:     e.DatabaseType,
 				DbProtocol: e.DatabaseProtocol,
 				DbOrigin:   e.DatabaseOrigin,
+				UserAgent:  e.UserAgent,
 			},
 			UserKind: prehogUserKindFromEventKind(e.UserKind),
 		}
diff --git a/lib/usagereporter/teleport/audit_test.go b/lib/usagereporter/teleport/audit_test.go
index 982b046b54d1a..4a63f10b13615 100644
--- a/lib/usagereporter/teleport/audit_test.go
+++ b/lib/usagereporter/teleport/audit_test.go
@@ -238,6 +238,45 @@ func TestConvertAuditEvent(t *testing.T) {
 				},
 			},
 		},
+		{
+			desc: "DatabaseSessionStart",
+			event: &apievents.DatabaseSessionStart{
+				UserMetadata: apievents.UserMetadata{User: "alice"},
+				DatabaseMetadata: apievents.DatabaseMetadata{
+					DatabaseService:  "postgres-local",
+					DatabaseProtocol: "postgres",
+					DatabaseName:     "postgres",
+					DatabaseUser:     "alice",
+					DatabaseType:     "self-hosted",
+					DatabaseOrigin:   "config-file",
+				},
+				ClientMetadata: apievents.ClientMetadata{UserAgent: "psql"},
+			},
+			expected: &SessionStartEvent{
+				SessionType: string(types.DatabaseSessionKind),
+				Database: &prehogv1a.SessionStartDatabaseMetadata{
+					DbType:     "self-hosted",
+					DbProtocol: "postgres",
+					DbOrigin:   "config-file",
+					UserAgent:  "psql",
+				},
+				UserName: "alice",
+			},
+			expectedAnonymized: &prehogv1a.SubmitEventRequest{
+				Event: &prehogv1a.SubmitEventRequest_SessionStartV2{
+					SessionStartV2: &prehogv1a.SessionStartEvent{
+						SessionType: string(types.DatabaseSessionKind),
+						Database: &prehogv1a.SessionStartDatabaseMetadata{
+							DbType:     "self-hosted",
+							DbProtocol: "postgres",
+							DbOrigin:   "config-file",
+							UserAgent:  "psql",
+						},
+						UserName: anonymizer.AnonymizeString("alice"),
+					},
+				},
+			},
+		},
 	}
 
 	for _, tt := range cases {
diff --git a/lib/usagereporter/teleport/types.go b/lib/usagereporter/teleport/types.go
index 3b783f73b55e1..57ac851f8792c 100644
--- a/lib/usagereporter/teleport/types.go
+++ b/lib/usagereporter/teleport/types.go
@@ -105,6 +105,7 @@ func (u *SessionStartEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventR
 			DbType:     u.Database.DbType,
 			DbProtocol: u.Database.DbProtocol,
 			DbOrigin:   u.Database.DbOrigin,
+			UserAgent:  u.Database.UserAgent,
 		}
 	}
 	if u.Desktop != nil {
diff --git a/proto/prehog/v1alpha/teleport.proto b/proto/prehog/v1alpha/teleport.proto
index 01b0f63b65598..2c83c29946388 100644
--- a/proto/prehog/v1alpha/teleport.proto
+++ b/proto/prehog/v1alpha/teleport.proto
@@ -232,6 +232,8 @@ message SessionStartDatabaseMetadata {
   string db_protocol = 2;
   // database origin source.
   string db_origin = 3;
+  // Indicates the client used on the session.
+  string user_agent = 4;
 }
 
 // SessionStartDesktop Metadata contains additional information about