basic telemetry

Author: jgoux

apps/browser-proxy/.env.example

@@ -3,6 +3,7 @@ AWS_ENDPOINT_URL_S3="<aws-endpoint-url-s3>"
 AWS_S3_BUCKET=storage
 AWS_SECRET_ACCESS_KEY="<aws-secret-access-key>"
 AWS_REGION=us-east-1
+LOGFLARE_SOURCE_URL="<logflare-source-url>"
 # enable PROXY protocol support
 #PROXIED=true
 WILDCARD_DOMAIN=browser.staging.db.build

apps/browser-proxy/src/index.ts

@@ -8,6 +8,13 @@ import { extractDatabaseId, isValidServername } from './servername.ts'
 import { getTls, setSecureContext } from './tls.ts'
 import { createStartupMessage } from './create-message.ts'
 import { extractIP } from './extract-ip.ts'
+import {
+  DatabaseShared,
+  DatabaseUnshared,
+  logEvent,
+  UserConnected,
+  UserDisconnected,
+} from './telemetry.ts'
 
 const debug = makeDebug('browser-proxy')
 
@@ -59,6 +66,8 @@ websocketServer.on('connection', (socket, request) => {
 
   websocketConnections.set(databaseId, socket)
 
+  logEvent(new DatabaseShared({ databaseId }))
+
   socket.on('message', (data: Buffer) => {
     debug('websocket message', data.toString('hex'))
     const tcpConnection = tcpConnections.get(databaseId)
@@ -67,6 +76,7 @@ websocketServer.on('connection', (socket, request) => {
 
   socket.on('close', () => {
     websocketConnections.delete(databaseId)
+    logEvent(new DatabaseUnshared({ databaseId }))
   })
 })
 
@@ -112,6 +122,7 @@ tcpServer.on('connection', async (socket) => {
       // only set the databaseId after we've verified the connection
       databaseId = _databaseId
       tcpConnections.set(databaseId!, connection)
+      logEvent(new UserConnected({ databaseId }))
     },
     serverVersion() {
       return '16.3'
@@ -158,6 +169,7 @@ tcpServer.on('connection', async (socket) => {
   socket.on('close', () => {
     if (databaseId) {
       tcpConnections.delete(databaseId)
+      logEvent(new UserDisconnected({ databaseId }))
       const websocket = websocketConnections.get(databaseId)
       websocket?.send(createStartupMessage('postgres', 'postgres', { client_ip: '' }))
     }

apps/browser-proxy/src/telemetry.ts

@@ -0,0 +1,50 @@
+class BaseEvent {
+  event_message: string
+  metadata: Record<string, unknown>
+  constructor(event_message: string, metadata: Record<string, unknown>) {
+    this.event_message = event_message
+    this.metadata = metadata
+  }
+}
+
+export class DatabaseShared extends BaseEvent {
+  constructor(metadata: { databaseId: string }) {
+    super('database-shared', metadata)
+  }
+}
+
+export class DatabaseUnshared extends BaseEvent {
+  constructor(metadata: { databaseId: string }) {
+    super('database-unshared', metadata)
+  }
+}
+
+export class UserConnected extends BaseEvent {
+  constructor(metadata: { databaseId: string }) {
+    super('user-connected', metadata)
+  }
+}
+
+export class UserDisconnected extends BaseEvent {
+  constructor(metadata: { databaseId: string }) {
+    super('user-disconnected', metadata)
+  }
+}
+
+type Event = DatabaseShared | DatabaseUnshared | UserConnected | UserDisconnected
+
+export async function logEvent(event: Event) {
+  if (process.env.LOGFLARE_SOURCE_URL) {
+    fetch(process.env.LOGFLARE_SOURCE_URL, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(event),
+    }).catch((err) => {
+      console.error(err)
+    })
+  } else if (process.env.DEBUG) {
+    console.log(event)
+  }
+}