Added docs for DB query logging commands (#263)

yugabyte · Oct 28, 2024 · 63b5bb5 · 63b5bb5
1 parent c9cbe3b
commit 63b5bb5
Show file tree

Hide file tree

Showing 6 changed files with 211 additions and 0 deletions.
diff --git a/docs/ybm_cluster.md b/docs/ybm_cluster.md
@@ -34,6 +34,7 @@ ybm cluster [flags]
 * [ybm](ybm.md)	 - ybm - Effortlessly manage your DB infrastructure on YugabyteDB Aeon (DBaaS) from command line!
 * [ybm cluster cert](ybm_cluster_cert.md)	 - Get the root CA certificate
 * [ybm cluster create](ybm_cluster_create.md)	 - Create a cluster
+* [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md)	 - Configure Database Query Logging for your Cluster.
 * [ybm cluster delete](ybm_cluster_delete.md)	 - Delete a cluster
 * [ybm cluster describe](ybm_cluster_describe.md)	 - Describe a cluster
 * [ybm cluster encryption](ybm_cluster_encryption.md)	 - Manage Encryption at Rest (EaR) for a cluster

diff --git a/docs/ybm_cluster_db-query-logging.md b/docs/ybm_cluster_db-query-logging.md
@@ -0,0 +1,41 @@
+## ybm cluster db-query-logging
+
+Configure Database Query Logging for your Cluster.
+
+### Synopsis
+
+Configure Database Query Logging for your Cluster.
+
+```
+ybm cluster db-query-logging [flags]
+```
+
+### Options
+
+```
+  -c, --cluster-name string   [REQUIRED] The name of the cluster.
+  -h, --help                  help for db-query-logging
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+      --host string        YugabyteDB Aeon Api hostname
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm cluster](ybm_cluster.md)	 - Manage cluster operations
+* [ybm cluster db-query-logging describe](ybm_cluster_db-query-logging_describe.md)	 - Describe Database Query Logging config
+* [ybm cluster db-query-logging disable](ybm_cluster_db-query-logging_disable.md)	 - Disable Database Query Logging
+* [ybm cluster db-query-logging enable](ybm_cluster_db-query-logging_enable.md)	 - Enable Database Query Logging
+* [ybm cluster db-query-logging update](ybm_cluster_db-query-logging_update.md)	 - Update Database Query Logging config
+
diff --git a/docs/ybm_cluster_db-query-logging_describe.md b/docs/ybm_cluster_db-query-logging_describe.md
@@ -0,0 +1,37 @@
+## ybm cluster db-query-logging describe
+
+Describe Database Query Logging config
+
+### Synopsis
+
+Describe Database Query Logging config
+
+```
+ybm cluster db-query-logging describe [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for describe
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string         YugabyteDB Aeon account API key
+  -c, --cluster-name string   [REQUIRED] The name of the cluster.
+      --config string         config file (default is $HOME/.ybm-cli.yaml)
+      --debug                 Use debug mode, same as --logLevel debug
+      --host string           YugabyteDB Aeon Api hostname
+  -l, --logLevel string       Select the desired log level format(info). Default to info
+      --no-color              Disable colors in output , default to false
+  -o, --output string         Select the desired output format (table, json, pretty). Default to table
+      --timeout duration      Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait                  Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md)	 - Configure Database Query Logging for your Cluster.
+
diff --git a/docs/ybm_cluster_db-query-logging_disable.md b/docs/ybm_cluster_db-query-logging_disable.md
@@ -0,0 +1,38 @@
+## ybm cluster db-query-logging disable
+
+Disable Database Query Logging
+
+### Synopsis
+
+Disable Database Query Logging, if enabled
+
+```
+ybm cluster db-query-logging disable [flags]
+```
+
+### Options
+
+```
+  -f, --force   Bypass the prompt for non-interactive usage
+  -h, --help    help for disable
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string         YugabyteDB Aeon account API key
+  -c, --cluster-name string   [REQUIRED] The name of the cluster.
+      --config string         config file (default is $HOME/.ybm-cli.yaml)
+      --debug                 Use debug mode, same as --logLevel debug
+      --host string           YugabyteDB Aeon Api hostname
+  -l, --logLevel string       Select the desired log level format(info). Default to info
+      --no-color              Disable colors in output , default to false
+  -o, --output string         Select the desired output format (table, json, pretty). Default to table
+      --timeout duration      Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait                  Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md)	 - Configure Database Query Logging for your Cluster.
+
diff --git a/docs/ybm_cluster_db-query-logging_enable.md b/docs/ybm_cluster_db-query-logging_enable.md
@@ -0,0 +1,47 @@
+## ybm cluster db-query-logging enable
+
+Enable Database Query Logging
+
+### Synopsis
+
+Enable Database Query Logging
+
+```
+ybm cluster db-query-logging enable [flags]
+```
+
+### Options
+
+```
+      --integration-name string            [REQUIRED] Name of the Integration
+      --debug-print-plan string            [OPTIONAL] Enables various debugging output to be emitted. (default "false")
+      --log-min-duration-statement int32   [OPTIONAL] Duration(in ms) of each completed statement to be logged if the statement ran for at least the specified amount of time. Default -1 (log all statements). (default -1)
+      --log-connections string             [OPTIONAL] Log connection attempts. (default "false")
+      --log-disconnections string          [OPTIONAL] Log session disconnections. (default "false")
+      --log-duration string                [OPTIONAL] Log the duration of each completed statement. (default "false")
+      --log-error-verbosity string         [OPTIONAL] Controls the amount of detail written in the server log for each message that is logged. Options: DEFAULT, TERSE, VERBOSE. (default "DEFAULT")
+      --log-statement string               [OPTIONAL] Log all statements or specific types of statements. Options: NONE, DDL, MOD, ALL. (default "NONE")
+      --log-min-error-statement string     [OPTIONAL] Minimum error severity for logging the statement that caused it. Options: ERROR. (default "ERROR")
+      --log-line-prefix string             [OPTIONAL] A printf-style format string for log line prefixes. (default "%m :%r :%u @ %d :[%p] :")
+  -h, --help                               help for enable
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string         YugabyteDB Aeon account API key
+  -c, --cluster-name string   [REQUIRED] The name of the cluster.
+      --config string         config file (default is $HOME/.ybm-cli.yaml)
+      --debug                 Use debug mode, same as --logLevel debug
+      --host string           YugabyteDB Aeon Api hostname
+  -l, --logLevel string       Select the desired log level format(info). Default to info
+      --no-color              Disable colors in output , default to false
+  -o, --output string         Select the desired output format (table, json, pretty). Default to table
+      --timeout duration      Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait                  Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md)	 - Configure Database Query Logging for your Cluster.
+
diff --git a/docs/ybm_cluster_db-query-logging_update.md b/docs/ybm_cluster_db-query-logging_update.md
@@ -0,0 +1,47 @@
+## ybm cluster db-query-logging update
+
+Update Database Query Logging config
+
+### Synopsis
+
+Update Database Query Logging config. Only the config values that are passed in args will be updated, the remaining one's will remain same as existing config.
+
+```
+ybm cluster db-query-logging update [flags]
+```
+
+### Options
+
+```
+      --debug-print-plan string            [OPTIONAL] Enables various debugging output to be emitted.
+  -h, --help                               help for update
+      --integration-name string            [OPTIONAL] Name of the Integration
+      --log-connections string             [OPTIONAL] Log connection attempts.
+      --log-disconnections string          [OPTIONAL] Log session disconnections.
+      --log-duration string                [OPTIONAL] Log the duration of each completed statement.
+      --log-error-verbosity string         [OPTIONAL] Controls the amount of detail written in the server log for each message that is logged. Options: DEFAULT, TERSE, VERBOSE.
+      --log-line-prefix string             [OPTIONAL] A printf-style format string for log line prefixes.
+      --log-min-duration-statement int32   [OPTIONAL] Duration(in ms) of each completed statement to be logged if the statement ran for at least the specified amount of time. (default -1)
+      --log-min-error-statement string     [OPTIONAL] Minimum error severity for logging the statement that caused it. Options: ERROR.
+      --log-statement string               [OPTIONAL] Log all statements or specific types of statements. Options: NONE, DDL, MOD, ALL.
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string         YugabyteDB Aeon account API key
+  -c, --cluster-name string   [REQUIRED] The name of the cluster.
+      --config string         config file (default is $HOME/.ybm-cli.yaml)
+      --debug                 Use debug mode, same as --logLevel debug
+      --host string           YugabyteDB Aeon Api hostname
+  -l, --logLevel string       Select the desired log level format(info). Default to info
+      --no-color              Disable colors in output , default to false
+  -o, --output string         Select the desired output format (table, json, pretty). Default to table
+      --timeout duration      Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait                  Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm cluster db-query-logging](ybm_cluster_db-query-logging.md)	 - Configure Database Query Logging for your Cluster.
+