Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC-580][CLOUDGA-24950][ybm][cli] DB Query logging cli commands #25213

Merged
merged 7 commits into from
Jan 10, 2025
Merged

[DOC-580][CLOUDGA-24950][ybm][cli] DB Query logging cli commands #25213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift click to select a range
3154341
add doc for db query logging cli command
sudhanshu456 Dec 9, 2024
84cd732
add prerequisite
sudhanshu456 Dec 16, 2024
bbfff8f
Apply suggestions from dwight review
sudhanshu456 Dec 17, 2024
3cde8aa
add to global and remove quotes
sudhanshu456 Dec 17, 2024
8b5799a
Apply suggestions from dwight review
sudhanshu456 Dec 19, 2024
4b0817a
order alphabetically
sudhanshu456 Dec 19, 2024
22eedf7
fix bad url
sudhanshu456 Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...w/yugabyte-cloud/managed-automation/managed-cli/managed-cli-reference/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 69,7 @@ You can manage the following resources using ybm:
| [cluster](managed-cli-cluster/) | cert download, create, delete, describe,</br>encryption list, encryption update,</br>list, node list, pause, resume, update |
| [cluster network](managed-cli-network/) | allow-list assign, allow-list unassign,</br>endpoint create, endpoint delete , endpoint describe,</br>endpoint list, endpoint update |
| [cluster read-replica](managed-cli-read-replica/) | create, delete, list, update |
| [cluster db-query-logging](managed-cli-db-query-logging/) | enable, disable, describe, update |
| [integration](managed-cli-integration/) | create, delete, list |
| [metrics-exporter](managed-cli-metrics-exporter/) [deprecated] | assign, create, delete, describe, list, pause, unassign, update |
| [network-allow-list](managed-cli-network-allow-list/) | create, delete, list |
Expand Down Expand Up @@ -105,6 106,9 @@ The following flags can be passed in with any command. These flags can also be a
--debug
: Use debug mode, same as `--logLevel debug`.

-h, --help
: Displays help information for ybm CLI commands.

<!--
--host string
: Host address of YugabyteDB Aeon (this should always be cloud.yugabyte.com). -->
Expand Down
123 changes: 123 additions & 0 deletions ...ed-automation/managed-cli/managed-cli-reference/managed-cli-db-query-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,123 @@
---
title: ybm CLI cluster db-query-logging
headerTitle: ybm cluster db-query-logging
linkTitle: cluster db-query-logging
description: YugabyteDB Aeon CLI reference Cluster Database Query Logging Resource.
headcontent: Manage cluster database query logging
menu:
preview_yugabyte-cloud:
identifier: managed-cli-db-query-logging
parent: managed-cli-reference
weight: 20
type: docs
---

Use the `cluster db-query-logging` resource to perform operations on a YugabyteDB Aeon cluster, including the following:

- enable, disable, and update db query logging
- get information about db query logging

## Prerequisite

Before using these commands, you must have an [integration configuration](../../../../cloud-monitor/logging-export#prerequisites) already set up. This configuration defines the authentication and connection details for the third-party tool where logs will be exported.

## Syntax

```text
Usage: ybm cluster db-query-logging [command] [flags]
```

## Examples

Enable database query logging for a cluster:

```sh
ybm cluster db-query-logging enable \
--cluster-name your-cluster \
--integration-name your-integration \
--log-line-prefix "%m :%r :%u @ %d :[%p] : " \
--log-min-duration-statement -1 \
--log-connections false \
--log-duration false \
--log-error-verbosity DEFAULT \
--log-statement NONE
```

Disable database query logging for a cluster.

```sh
ybm cluster db-query-logging disable \
--cluster-name your-cluster
```

Get information about database query logging for a cluster.

```sh
ybm cluster db-query-logging describe --cluster-name your-cluster
```

Update some fields of the log configuration.

```sh
ybm cluster db-query-logging update \
--cluster-name "your-cluster" \
--integration-name your-integration \
--log-line-prefix "%m :%r :%u @ %d :[%p] :" \
--log-min-duration-statement 60
```

## Commands

### enable

Enable database query logging for a cluster and export the logs to the integration passed in the flag `--integration-name`.

| Flag | Description |
| :--- | :--- |
| --cluster-name | Required. Name of the cluster whose database logging you want to enable. |
| --integration-name | Required. Name of the integration that you want to use to export the logs. |
| --debug-print-plan | Optional. Enables output of debugging output. Default is `false`. |
| --log-min-duration-statement | Optional. Duration (in ms) of each completed statement to be logged if the statement ran for at least the specified amount of time. Default is `-1` (log all statements). |
| --log-connections | Optional. Log connection attempts. Default is `false`. |
| --log-disconnections | Optional. Log session disconnections. Default is `false`. |
| --log-duration | Optional. Log the duration of each completed statement. Default is `false`. |
| --log-error-verbosity | Optional. Controls the amount of detail written in the server log for each message that is logged.<br>Arguments:<br><ul><li>`DEFAULT` - Standard verbosity level.</li><li>`TERSE` - Minimal detail.</li><li>`VERBOSE` - Maximum detail.</li></ul>Default is `DEFAULT`. |
| --log-statement | Optional. Log all statements or specific types of statements.<br>Arguments:<br><ul><li>`NONE` - Do not log any statements.</li><li>`DDL` - Log data definition language statements.</li><li>`MOD` - Log data modification statements.</li><li>`ALL` - Log all statements.</li></ul>Default is `NONE`. |
| --log-min-error-statement | Optional. Minimum error severity for logging the statement that caused it.<br>Arguments:<br><ul><li>`ERROR` - Log statements causing errors.</li></ul>Default is `ERROR`. |
| --log-line-prefix | Optional. A printf-style format string for [log line prefixes](../../../../cloud-monitor/logging-export/#include-in-the-log-prefix-log-line-prefix). Default is `%m :%r :%u @ %d :[%p] :`. |

### disable

Disable database query logging for a cluster.

| Flag | Description |
| :--- | :--- |
| --cluster-name | Required. Name of the cluster whose database logging you want to disable. |
| -f, --force | Optional. Bypass the prompt for non-interactive usage. |
sudhanshu456 marked this conversation as resolved.
Show resolved Hide resolved

### Describe

Fetch detailed information about the logging configuration for a cluster.

| Flag | Description |
| :--- | :--- |
| --cluster-name | Required. Name of the cluster for which you want to fetch the database query logging configuration. |

### update

Update the database query logging configuration of a cluster.


| Flag | Description |
ddhodge marked this conversation as resolved.
Show resolved Hide resolved
| :--- | :--- |
| --cluster-name | Required. Name of the cluster with database query logging configuration you want to update. |
| --debug-print-plan | Optional. Enables output of debugging output. |
| --integration-name | Optional. Name of the Integration. |
| --log-connections | Optional. Log connection attempts. |
| --log-disconnections | Optional. Log session disconnections. |
| --log-duration | Optional. Log the duration of each completed statement. |
| --log-error-verbosity | Optional. Controls the amount of detail written in the server log for each message that is logged.<br>Arguments:<br><ul><li>`DEFAULT` - Standard verbosity level.</li><li>`TERSE` - Minimal detail.</li><li>`VERBOSE` - Maximum detail.</li></ul> |
| --log-line-prefix | Optional. A printf-style format string for log line prefixes. |
| --log-min-duration-statement | Optional. Duration (in ms) of each completed statement to be logged if the statement ran for at least the specified amount of time. Default is `-1` (log all statements). |
| --log-min-error-statement | Optional. Minimum error severity for logging the statement that caused it.<br>Arguments:<br><ul><li>`ERROR`</li></ul> |
| --log-statement | Optional. Log all statements or specific types of statements.<br>Arguments:<br><ul><li>`NONE` - Do not log any statements.</li><li>`DDL` - Log data definition language statements.</li><li>`MOD` - Log data modification statements.</li><li>`ALL` - Log all statements.</li></ul> |