[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>
gravitational · Feb 3, 2025 · 556d5de · 556d5de
1 parent a628541
commit 556d5de
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 9 deletions.
diff --git a/gen/proto/go/prehog/v1alpha/teleport.pb.go b/gen/proto/go/prehog/v1alpha/teleport.pb.go
diff --git a/gen/proto/ts/prehog/v1alpha/teleport_pb.ts b/gen/proto/ts/prehog/v1alpha/teleport_pb.ts
diff --git 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
@@ -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
@@ -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
@@ -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