PostgreSQL backup tool with Point-In-Time-Recovery and restore verification
TypeScript backupbackupsdatabasedatabase-backupdevopsdockergolangkubernetesmariadbmongodbmysqlpgpostgrespostgresqls3self-hostedsystem-administrationtoolsweb-ui
FEATURE (ssh): Collect stats about SSH usage
Rostislav Dugindc50ff7c7792
diff --git a/backend/internal/features/telemetry/dto.go b/backend/internal/features/telemetry/dto.goindex 1e8b6aef..bb1438e0 100644--- a/backend/internal/features/telemetry/dto.go+++ b/backend/internal/features/telemetry/dto.go@@ -15,12 +15,13 @@ import ()type DatabaseEntry struct {- Type string `json:"type"`- Version string `json:"version"`- BackupType string `json:"backupType,omitzero"`- RawSizeMb int64 `json:"rawSizeMb,omitzero"`- BackupSizeMb int64 `json:"backupSizeMb,omitzero"`- Verification *DatabaseVerificationEntry `json:"verification,omitempty"`+ Type string `json:"type"`+ Version string `json:"version"`+ BackupType string `json:"backupType,omitzero"`+ IsSshTunnelEnabled bool `json:"isSshTunnelEnabled"`+ RawSizeMb int64 `json:"rawSizeMb,omitzero"`+ BackupSizeMb int64 `json:"backupSizeMb,omitzero"`+ Verification *DatabaseVerificationEntry `json:"verification,omitempty"`}type DatabaseVerificationEntry struct {diff --git a/backend/internal/features/telemetry/service.go b/backend/internal/features/telemetry/service.goindex 3e0238f6..20626e3d 100644--- a/backend/internal/features/telemetry/service.go+++ b/backend/internal/features/telemetry/service.go@@ -319,31 +319,53 @@ func buildDatabaseEntry(db *databases.Database) (DatabaseEntry, bool) {if db.PostgresqlLogical == nil {return DatabaseEntry{}, false}- return DatabaseEntry{Type: string(db.Type), Version: string(db.PostgresqlLogical.Version)}, true++ return DatabaseEntry{+ Type: string(db.Type),+ Version: string(db.PostgresqlLogical.Version),+ IsSshTunnelEnabled: db.PostgresqlLogical.SshTunnel.IsEnabled,+ }, truecase databases.DatabaseTypePostgresPhysical:if db.PostgresqlPhysical == nil {return DatabaseEntry{}, false}+return DatabaseEntry{- Type: string(db.Type),- Version: string(db.PostgresqlPhysical.Version),- BackupType: string(db.PostgresqlPhysical.BackupType),+ Type: string(db.Type),+ Version: string(db.PostgresqlPhysical.Version),+ BackupType: string(db.PostgresqlPhysical.BackupType),+ IsSshTunnelEnabled: db.PostgresqlPhysical.SshTunnel.IsEnabled,}, truecase databases.DatabaseTypeMysql:if db.Mysql == nil {return DatabaseEntry{}, false}- return DatabaseEntry{Type: string(db.Type), Version: string(db.Mysql.Version)}, true++ return DatabaseEntry{+ Type: string(db.Type),+ Version: string(db.Mysql.Version),+ IsSshTunnelEnabled: db.Mysql.SshTunnel.IsEnabled,+ }, truecase databases.DatabaseTypeMariadb:if db.Mariadb == nil {return DatabaseEntry{}, false}- return DatabaseEntry{Type: string(db.Type), Version: string(db.Mariadb.Version)}, true++ return DatabaseEntry{+ Type: string(db.Type),+ Version: string(db.Mariadb.Version),+ IsSshTunnelEnabled: db.Mariadb.SshTunnel.IsEnabled,+ }, truecase databases.DatabaseTypeMongodb:if db.Mongodb == nil {return DatabaseEntry{}, false}- return DatabaseEntry{Type: string(db.Type), Version: string(db.Mongodb.Version)}, true++ return DatabaseEntry{+ Type: string(db.Type),+ Version: string(db.Mongodb.Version),+ IsSshTunnelEnabled: db.Mongodb.SshTunnel.IsEnabled,+ }, true}return DatabaseEntry{}, falsediff --git a/backend/internal/features/telemetry/service_test.go b/backend/internal/features/telemetry/service_test.goindex e8502650..39201146 100644--- a/backend/internal/features/telemetry/service_test.go+++ b/backend/internal/features/telemetry/service_test.go@@ -27,6 +27,7 @@ import (postgresql_physical "databasus-backend/internal/features/databases/databases/postgresql/physical""databasus-backend/internal/features/intervals""databasus-backend/internal/features/notifiers"+ "databasus-backend/internal/features/sshtunnel""databasus-backend/internal/features/storages"verification_agents "databasus-backend/internal/features/verification/agents"verification_config "databasus-backend/internal/features/verification/config"@@ -275,6 +276,99 @@ func physicalDatabase(}}+func databasesForEveryEngine(isSshTunnelEnabled bool) []*databases.Database {+ tunnel := sshtunnel.Config{+ IsEnabled: isSshTunnelEnabled,+ Host: "bastion.internal",+ Port: 22,+ Username: "backup",+ }++ logicalPostgresDatabase := postgresDatabase("pg-logical", availableStatus())+ logicalPostgresDatabase.PostgresqlLogical.SshTunnel = tunnel++ physicalPostgresDatabase := physicalDatabase(+ "pg-physical", postgresql_physical.BackupTypeFullOnly, availableStatus())+ physicalPostgresDatabase.PostgresqlPhysical.SshTunnel = tunnel++ return []*databases.Database{+ logicalPostgresDatabase,+ physicalPostgresDatabase,+ {+ ID: uuid.New(),+ Name: "my",+ Type: databases.DatabaseTypeMysql,+ HealthStatus: availableStatus(),+ Mysql: &mysql.MysqlDatabase{Version: tools.MysqlVersion("8.0"), SshTunnel: tunnel},+ },+ {+ ID: uuid.New(),+ Name: "maria",+ Type: databases.DatabaseTypeMariadb,+ HealthStatus: availableStatus(),+ Mariadb: &mariadb.MariadbDatabase{Version: tools.MariadbVersion("10.6"), SshTunnel: tunnel},+ },+ {+ ID: uuid.New(),+ Name: "mongo",+ Type: databases.DatabaseTypeMongodb,+ HealthStatus: availableStatus(),+ Mongodb: &mongodb.MongodbDatabase{Version: tools.MongodbVersion("6.0"), SshTunnel: tunnel},+ },+ }+}++func assertEveryEntrySerializesSshTunnelEnabled(+ t *testing.T,+ sender *fakeSender,+ isSshTunnelEnabled bool,+) {+ t.Helper()++ require.Len(t, sender.calls, 1)+ require.Len(t, sender.calls[0].Databases, 5)++ for _, databaseEntry := range sender.calls[0].Databases {+ assert.Equal(t, isSshTunnelEnabled, databaseEntry.IsSshTunnelEnabled, databaseEntry.Type)++ encodedEntry, err := json.Marshal(databaseEntry)+ require.NoError(t, err)++ var decodedEntry map[string]any+ require.NoError(t, json.Unmarshal(encodedEntry, &decodedEntry))++ assert.Equal(t, isSshTunnelEnabled, decodedEntry["isSshTunnelEnabled"], databaseEntry.Type)+ }+}++func Test_BuildAndSend_WhenSshTunnelEnabled_EveryEngineSerializesIsSshTunnelEnabledAsTrue(+ t *testing.T,+) {+ sender := &fakeSender{}+ service := newServiceUnderTest(t, serviceDependencies{+ databaseLister: &fakeDatabaseLister{databases: databasesForEveryEngine(true)},+ sender: sender,+ })++ require.NoError(t, service.BuildAndSend(t.Context()))++ assertEveryEntrySerializesSshTunnelEnabled(t, sender, true)+}++func Test_BuildAndSend_WhenSshTunnelDisabled_EveryEngineSerializesIsSshTunnelEnabledAsFalse(+ t *testing.T,+) {+ sender := &fakeSender{}+ service := newServiceUnderTest(t, serviceDependencies{+ databaseLister: &fakeDatabaseLister{databases: databasesForEveryEngine(false)},+ sender: sender,+ })++ require.NoError(t, service.BuildAndSend(t.Context()))++ assertEveryEntrySerializesSshTunnelEnabled(t, sender, false)+}+func Test_BuildAndSend_ProducesExpectedRequest(t *testing.T) {pgDB := postgresDatabase("pg", availableStatus())mysqlDB := &databases.Database{@@ -1006,6 +1100,7 @@ func Test_BuildAndSend_WhenPayloadSerialized_ContainsDocumentedContractKeys(t *t"type","version","backupType",+ "isSshTunnelEnabled","rawSizeMb","backupSizeMb",}, slices.Collect(maps.Keys(databaseEntry)))