Skip to content

Commit

Permalink
Added support for wait in Database query logging subcommands (#264)
Browse files Browse the repository at this point in the history 
* Add support for wait in Database query logging subcommands
* Abstract repetitive code to functions
  • Loading branch information
@bhupendray-yb
bhupendray-yb authored Oct 30, 2024
1 parent 18dfe83 commit 5456807
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 45 deletions.
102 changes: 59 additions & 43 deletions cmd/cluster/log-exporter/query_log_exporter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,21 @@ var enableDbQueryLoggingCmd = &cobra.Command{

resp, r, err := authApi.EnableDbQueryLogging(clusterId).PgLogExporterConfigSpec(
ybmclient.PgLogExporterConfigSpec{ExportConfig: exportConfig, ExporterId: integrationId}).Execute()
dqlConfig := resp.GetData()

if err != nil {
logrus.Debugf("Full HTTP response: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

formatter.DbQueryLoggingWriteFull(resp.GetData(), integrationName)
msg := fmt.Sprintf("The db query logging for cluster %s is being enabled", clusterName)
if viper.GetBool("wait") {
waitForDbLoggingTaskCompletion(clusterId, ybmclient.TASKTYPEENUM_ENABLE_DATABASE_QUERY_LOGGING, msg, authApi)
fmt.Printf("DB query logging has been enabled for the cluster %v\n", formatter.Colorize(clusterName, formatter.GREEN_COLOR))
dqlConfig = *getDbLoggingConfig(clusterId, authApi)
}

formatter.DbQueryLoggingWriteFull(dqlConfig, integrationName)
},
}

Expand All @@ -95,26 +103,15 @@ var describeLogExporterCmd = &cobra.Command{
logrus.Fatalf("%s", ybmAuthClient.GetApiErrorDetails(err))
}

resp, r, err := authApi.GetDbLoggingConfig(clusterId).Execute()
if err != nil {
logrus.Debugf("Full HTTP response for Query Log Exporter Config: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

if len(resp.GetData()) < 1 {
fmt.Printf("DB query logs are not enabled for cluster: %s\n", clusterName)
return
}

pgLogExporterConfigData := resp.GetData()[0]
pgLogExporterConfigData := *getDbLoggingConfig(clusterId, authApi)
integrationName, integrationId := "", pgLogExporterConfigData.Spec.ExporterId

integrationName, err = authApi.GetIntegrationNameFromId(integrationId)
if err != nil {
logrus.Debugf("could not fetch associated name for integration id: %s", integrationId)
}

formatter.DbQueryLoggingWriteFull(resp.GetData()[0], integrationName)
formatter.DbQueryLoggingWriteFull(pgLogExporterConfigData, integrationName)
},
}

Expand Down Expand Up @@ -148,29 +145,24 @@ var disableLogExporterCmd = &cobra.Command{
}

// Fetch existing log exporter config
resp, r, err := authApi.GetDbLoggingConfig(clusterId).Execute()
if err != nil {
logrus.Debugf("Full HTTP response for Query Log Exporter Config: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

if len(resp.GetData()) < 1 {
fmt.Printf("DB query logs are not enabled for cluster: %s\n", clusterName)
return
}

logExporterData := resp.GetData()[0]
logExporterData := *getDbLoggingConfig(clusterId, authApi)
exporterConfigId := logExporterData.Info.Id

r, err = authApi.RemoveDbQueryLoggingConfig(clusterId, exporterConfigId).Execute()
r, err := authApi.RemoveDbQueryLoggingConfig(clusterId, exporterConfigId).Execute()

if err != nil {
logrus.Debugf("Full HTTP response for disable query logging config: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

fmt.Printf(`Request submitted to disable DB query logging for the cluster, this may take a few minutes...
msg := fmt.Sprintf("The db query logging for cluster %s is being disabled", clusterName)
if viper.GetBool("wait") {
waitForDbLoggingTaskCompletion(clusterId, ybmclient.TASKTYPEENUM_DISABLE_DATABASE_QUERY_LOGGING, msg, authApi)
fmt.Printf("DB query logging has been disabled for the cluster %v\n", formatter.Colorize(clusterName, formatter.GREEN_COLOR))
} else {
fmt.Printf(`Request submitted to disable DB query logging for the cluster, this may take a few minutes...
You can check the status via $ ybm cluster db-query-logging describe --cluster-name %s%s`, formatter.Colorize(clusterName, formatter.GREEN_COLOR), "\n")
}
},
}

Expand All @@ -196,18 +188,7 @@ var updateLogExporterConfigCmd = &cobra.Command{
}

// Fetch existing log exporter config
resp, r, err := authApi.GetDbLoggingConfig(clusterId).Execute()
if err != nil {
logrus.Debugf("Full HTTP response for Query Log Exporter Config: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

if len(resp.GetData()) < 1 {
fmt.Printf("DB query logs are not enabled for cluster: %s\n", clusterName)
return
}

logExporterData := resp.GetData()[0]
logExporterData := *getDbLoggingConfig(clusterId, authApi)
exporterConfigId := logExporterData.Info.Id

var integrationId string = ""
Expand All @@ -231,19 +212,54 @@ var updateLogExporterConfigCmd = &cobra.Command{
newExportConfig := BuildNewPgExportConfigFromExistingConfig(cmd, existingExportConfig)

var pgLogExporterConfigResponse ybmclient.PgLogExporterConfigResponse
pgLogExporterConfigResponse, r, err = authApi.EditDbQueryLoggingConfig(clusterId, exporterConfigId).PgLogExporterConfigSpec(
pgLogExporterConfigResponse, r, err := authApi.EditDbQueryLoggingConfig(clusterId, exporterConfigId).PgLogExporterConfigSpec(
ybmclient.PgLogExporterConfigSpec{ExportConfig: newExportConfig, ExporterId: integrationId}).Execute()

if err != nil {
logrus.Debugf("Full HTTP response for update DB Query logging config: %v\n", r)
logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
}

fmt.Println("Request submitted to edit DB query log config for the cluster, this may take a few minutes...")
formatter.DbQueryLoggingWriteFull(pgLogExporterConfigResponse.GetData(), integrationName)
dqlConfig := pgLogExporterConfigResponse.Data

msg := fmt.Sprintf("The db query logging config for cluster %s is being updated", clusterName)
if viper.GetBool("wait") {
waitForDbLoggingTaskCompletion(clusterId, ybmclient.TASKTYPEENUM_EDIT_DATABASE_QUERY_LOGGING, msg, authApi)
fmt.Printf("DB query logging config has been updated for the cluster %v\n", formatter.Colorize(clusterName, formatter.GREEN_COLOR))

dqlConfig = *getDbLoggingConfig(clusterId, authApi)
} else {
fmt.Println("Request submitted to edit DB query log config for the cluster, this may take a few minutes...")
}

formatter.DbQueryLoggingWriteFull(dqlConfig, integrationName)
},
}

func getDbLoggingConfig(clusterId string, authApi *ybmAuthClient.AuthApiClient) *ybmclient.PgLogExporterConfigData {
respC, r, err := authApi.GetDbLoggingConfig(clusterId).Execute()
if err != nil {
logrus.Debugf("Full HTTP response: %v", r)
logrus.Fatalf("could not fetch DB query logging config " + ybmAuthClient.GetApiErrorDetails(err))
}
if len(respC.Data) < 1 {
logrus.Fatalf("DB query logging is not enabled for the cluster")
}
return &respC.Data[0]
}

func waitForDbLoggingTaskCompletion(clusterId string, taskType ybmclient.TaskTypeEnum,
message string, authApi *ybmAuthClient.AuthApiClient) {
completionStatus := []string{"FAILED", "SUCCEEDED"}
returnStatus, err := authApi.WaitForTaskCompletion(clusterId, ybmclient.ENTITYTYPEENUM_CLUSTER, taskType, completionStatus, message)
if err != nil {
logrus.Fatalf("error when getting task status: %s", err)
}
if returnStatus != "SUCCEEDED" {
logrus.Fatalf("Operation failed with error: %s", returnStatus)
}
}

func init() {

DbQueryLoggingCmd.AddCommand(enableDbQueryLoggingCmd)
Expand Down
2 changes: 1 addition & 1 deletion cmd/db_query_logs_exporter_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var _ = Describe("DB Query Logging", func() {
Expect(err).ToNot(HaveOccurred())
os.Setenv("YBM_HOST", fmt.Sprintf("http://%s", server.Addr()))
os.Setenv("YBM_APIKEY", "test-token")
os.Setenv("YBM_FF_DB_QUERY_LOGS", "true")
os.Setenv("YBM_FF_DB_QUERY_LOGGING", "true")
statusCode = 200
err = loadJson("./test/fixtures/list-clusters.json", &responseListClusters)
Expect(err).ToNot(HaveOccurred())
Expand Down
2 changes: 1 addition & 1 deletion cmd/util/feature_flags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const (
CONNECTION_POOLING FeatureFlag = "CONNECTION_POOLING"
GOOGLECLOUD_INTEGRATION FeatureFlag = "GOOGLECLOUD_INTEGRATION"
DR FeatureFlag = "DR"
DB_QUERY_LOGS FeatureFlag = "DB_QUERY_LOGS"
DB_QUERY_LOGS FeatureFlag = "DB_QUERY_LOGGING"
)

func (f FeatureFlag) String() string {
Expand Down

0 comments on commit 5456807

Please sign in to comment.