DOC-12541 new query report generation tool #3905

Pallavi-Janardhan · 2025-09-30T17:14:00Z

Added info about the new utility, cbqueryreportgen, to the CLI Reference doc.

simon-dew · 2025-10-03T12:48:52Z

This PR targets release/8.0 but I think it must have been based on release/7.6 originally. I'll try to sort this out.

simon-dew · 2025-10-03T13:10:44Z

Okay I have recreated this PR to start from release/8.0, and cherry-picked the new changes on top. @Pallavi-Janardhan please do git pull origin DOC-12541_new_query_report_generation_tool before you do any further work on this branch locally.

simon-dew

Hi @Pallavi-Janardhan , as well as addressing the comments below, please can you add a link to the cbqueryreportgen.adoc file in the server navigation file /modules/ROOT/nav.adoc? Put the link in the Reference section, after cbq and before cbrecovery:

 ** xref:cli:cbq-tool.adoc[cbq]
 ** xref:cli:cbqueryreportgen.adoc[cbqueryreportgen]
 ** xref:cli:cbtools/cbrecovery.adoc[cbrecovery]

modules/cli/pages/cbqueryreportgen.adoc

Co-authored-by: Simon Dew <[email protected]>

simon-dew

LGTM! 👍

Thanks @Pallavi-Janardhan ! 🎉

safianalicb

Please correct the flags given under the "Syntax" section

modules/cli/pages/cbqueryreportgen.adoc

safianalicb

There are still some mistakes here e.g. long option flags that don't exist.

safianalicb · 2025-10-09T08:41:47Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `cbqueryreportgen` command connects to a Couchbase cluster and generates performance reports based on the Query Service's AWR statistics.
+
+The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.


This is not true. The only output format is HTML

safianalicb · 2025-10-09T08:42:14Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `cbqueryreportgen` command connects to a Couchbase cluster and generates performance reports based on the Query Service's AWR statistics.
+
+The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.


This is also not true. You must specify an output file

safianalicb · 2025-10-09T08:43:24Z

modules/cli/pages/cbqueryreportgen.adoc

+                  [ -u, --username <username> ]
+                  [ -p, --password <password> ]
+                  [ -k, --keyspace <keyspace> ]
+                  [ -t1, --start-time <start-time> ]


Both -t1 and -t2 have their own separate start-time and end-time values

safianalicb · 2025-10-09T08:44:30Z

modules/cli/pages/cbqueryreportgen.adoc

+----
+====
+
+The output of the command is a report in HTML format, saved to the file `cbqueryreportgen.html`.


The example above would save the report at report.html

safianalicb · 2025-10-09T08:45:54Z

modules/cli/pages/cbqueryreportgen.adoc

+                  [ -u, --username <username> ]
+                  [ -p, --password <password> ]
+                  [ -k, --keyspace <keyspace> ]
+                  [ -t1, --start-time <start-time> ]


There is no long option for either t1 or t2

safianalicb · 2025-10-09T08:46:26Z

modules/cli/pages/cbqueryreportgen.adoc

+                  [ -c, --cluster <cluster> ]
+                  [ -u, --username <username> ]
+                  [ -p, --password <password> ]
+                  [ -k, --keyspace <keyspace> ]


There is no long option for --k.

simon-dew

Added some suggested changes following Safian's review

modules/cli/pages/cbqueryreportgen.adoc

simon-dew · 2025-10-09T10:24:56Z

modules/cli/pages/cbqueryreportgen.adoc

+                  [ -u, --username <username> ]
+                  [ -p, --password <password> ]
+                  [ -k, --keyspace <keyspace> ]
+                  [ -t1, --start-time <start-time> ]


Suggested change

[ -t1, --start-time <start-time> ]

[ -t1 <start-time>,<end-time> ]

simon-dew · 2025-10-09T10:25:45Z

modules/cli/pages/cbqueryreportgen.adoc

+                  [ -p, --password <password> ]
+                  [ -k, --keyspace <keyspace> ]
+                  [ -t1, --start-time <start-time> ]
+                  [ -t2, --end-time <end-time> ]


Suggested change

[ -t2, --end-time <end-time> ]

[ -t2 <start-time>,<end-time> ]

simon-dew · 2025-10-09T10:26:07Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `cbqueryreportgen` command connects to a Couchbase cluster and generates performance reports based on the Query Service's AWR statistics.
+
+The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.


Suggested change

The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.

The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. The output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.

simon-dew · 2025-10-09T10:26:30Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `-p, --password` flag specifies the password of the Couchbase cluster. Example: `cbqueryreportgen --password password`.
+
+The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.


Suggested change

The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.

The `-k` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.

simon-dew · 2025-10-09T10:27:07Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.
+
+The `-t1` and `-t2` flags specify the start-time and end-time for the report. Enter both start-time and end-time as `t1,t2` in the `YYYY-MM-DDTHH:MM:SS` format. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.


Suggested change

The `-t1` and `-t2` flags specify the start-time and end-time for the report. Enter both start-time and end-time as `t1,t2` in the `YYYY-MM-DDTHH:MM:SS` format. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.

The `-t1` flag specifies the start-time and end-time for the report. Enter both start-time and end-time in the `YYYY-MM-DDTHH:MM:SS` format, separated by a comma. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.

simon-dew · 2025-10-09T10:27:42Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `-o, --output` flag specifies the output file to write the report to. Example: `cbqueryreportgen.html`.
+
+Optional flags:


Need to explain the -t2 flag in this section

simon-dew · 2025-10-09T10:28:04Z

modules/cli/pages/cbqueryreportgen.adoc

+----
+====
+
+The output of the command is a report in HTML format, saved to the file `cbqueryreportgen.html`.


Suggested change

The output of the command is a report in HTML format, saved to the file `cbqueryreportgen.html`.

The output of the command is a report in HTML format, saved to the file `report.html`.

Pallavi-Janardhan · 2025-10-09T18:01:40Z

Have made all the required/suggested changes. The preview link is
https://preview.docs-test.couchbase.com/docs-server-DOC-12541_new_query_report_generation_tool/server/current/cli/cbqueryreportgen.html

safianalicb · 2025-10-10T17:21:26Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `-k` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.
+
+The `-t1` flag specifies the start-time and end-time for the report. Enter both start-time and end-time in the `YYYY-MM-DDTHH:MM:SS` format, separated by a comma. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.


Please mention here and for t2 that the times need to be in the local timezone

safianalicb · 2025-10-10T17:22:14Z

modules/cli/pages/cbqueryreportgen.adoc

+
+The `-u, --username` flag specifies the username of the Couchbase cluster. Example: `-u Administrator`.
+
+The `-p, --password` flag specifies the password of the Couchbase cluster. Example: `cbqueryreportgen -p password`.


inconsistency in around whether cbqueryreportgen is prepended to examples. I'd prefer without it, but regardless you should be consistent

Pallavi-Janardhan requested review from RichardSmedley, safianalicb and simon-dew September 30, 2025 17:14

simon-dew changed the title ~~Doc 12541 new query report generation tool~~ DOC-12541 new query report generation tool Oct 3, 2025

simon-dew changed the base branch from release/8.0 to release/7.6 October 3, 2025 12:44

simon-dew force-pushed the DOC-12541_new_query_report_generation_tool branch from e2b7465 to 3d84a55 Compare October 3, 2025 12:45

simon-dew changed the base branch from release/7.6 to release/8.0 October 3, 2025 12:46

simon-dew changed the base branch from release/8.0 to release/7.6 October 3, 2025 12:47

Pallavi-Janardhan added 4 commits October 3, 2025 13:51

DOC-12541 Added a new file and modified the cli-intro file

b07178f

DOC-12541 Added a new file and modified the cli-intro file

4f13f6e

DOC-12541 Added a new file and modified the cli-intro file

86e58c0

DOC-12541 Added a new file and modified the cli-intro file

c0e0e5f

simon-dew force-pushed the DOC-12541_new_query_report_generation_tool branch from 3d84a55 to c0e0e5f Compare October 3, 2025 13:03

simon-dew changed the base branch from release/7.6 to release/8.0 October 3, 2025 13:03

simon-dew requested changes Oct 3, 2025

View reviewed changes

modules/cli/pages/cbqueryreportgen.adoc Outdated Show resolved Hide resolved

modules/cli/pages/cbqueryreportgen.adoc Outdated Show resolved Hide resolved

modules/cli/pages/cbqueryreportgen.adoc Show resolved Hide resolved

rakhi-prathap mentioned this pull request Oct 7, 2025

[DOC-13581] AWR Improvements couchbaselabs/docs-devex#430

Merged

Pallavi-Janardhan and others added 3 commits October 7, 2025 13:16

Update modules/cli/pages/cbqueryreportgen.adoc

d837ae4

Co-authored-by: Simon Dew <[email protected]>

Update modules/cli/pages/cbqueryreportgen.adoc

5da7b6a

Co-authored-by: Simon Dew <[email protected]>

Incorporating review comments

de8e253

Pallavi-Janardhan requested review from osfameron, rakhi-prathap and simon-dew October 7, 2025 13:47

simon-dew approved these changes Oct 8, 2025

View reviewed changes

safianalicb suggested changes Oct 8, 2025

View reviewed changes

Incorporating SME tech review comments

92a7f0b

Pallavi-Janardhan requested review from safianalicb and simon-dew October 9, 2025 06:56

Made few corrections to the doc

9220009

safianalicb suggested changes Oct 9, 2025

View reviewed changes

simon-dew requested changes Oct 9, 2025

View reviewed changes

Made the suggested corrections by the SME lead to the doc

2d5117e

Pallavi-Janardhan force-pushed the DOC-12541_new_query_report_generation_tool branch from 441bc76 to 2d5117e Compare October 9, 2025 17:51

Pallavi-Janardhan requested review from safianalicb and simon-dew October 9, 2025 18:01

safianalicb suggested changes Oct 10, 2025

View reviewed changes


		The `cbqueryreportgen` command connects to a Couchbase cluster and generates performance reports based on the Query Service's AWR statistics.

		The tool allows you to specify a time range for the report. You can specify 2 different time periods, allowing a report to be generated that compares query statistics over the different time periods. You can also specify the type of report and the output format. By default, the output of the command is a report in HTML format. You can save the generated report to a file or print it to the standard output.

	[ -t1, --start-time <start-time> ]
	[ -t1 <start-time>,<end-time> ]

	[ -t2, --end-time <end-time> ]
	[ -t2 <start-time>,<end-time> ]


		The `-p, --password` flag specifies the password of the Couchbase cluster. Example: `cbqueryreportgen --password password`.

		The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.

	The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.
	The `-k` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.


		The `-k, --keyspace` flag specifies the keyspace. The keyspace is the AWR repository in the `bucket.scope.collection` format. Example: `travel-sample._default.awr`.

		The `-t1` and `-t2` flags specify the start-time and end-time for the report. Enter both start-time and end-time as `t1,t2` in the `YYYY-MM-DDTHH:MM:SS` format. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.

	The `-t1` and `-t2` flags specify the start-time and end-time for the report. Enter both start-time and end-time as `t1,t2` in the `YYYY-MM-DDTHH:MM:SS` format. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.
	The `-t1` flag specifies the start-time and end-time for the report. Enter both start-time and end-time in the `YYYY-MM-DDTHH:MM:SS` format, separated by a comma. Example: `2025-09-01T00:00:00,2025-09-02T00:00:00`.


		The `-o, --output` flag specifies the output file to write the report to. Example: `cbqueryreportgen.html`.

		Optional flags:

	The output of the command is a report in HTML format, saved to the file `cbqueryreportgen.html`.
	The output of the command is a report in HTML format, saved to the file `report.html`.


		The `-u, --username` flag specifies the username of the Couchbase cluster. Example: `-u Administrator`.

		The `-p, --password` flag specifies the password of the Couchbase cluster. Example: `cbqueryreportgen -p password`.

DOC-12541 new query report generation tool #3905

Are you sure you want to change the base?

DOC-12541 new query report generation tool #3905

Conversation

Pallavi-Janardhan commented Sep 30, 2025 • edited by simon-dew Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simon-dew commented Oct 3, 2025

Uh oh!

simon-dew commented Oct 3, 2025

Uh oh!

simon-dew left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

simon-dew left a comment

Choose a reason for hiding this comment

Uh oh!

safianalicb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

safianalicb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon-dew left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pallavi-Janardhan commented Oct 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Pallavi-Janardhan commented Sep 30, 2025 •

edited by simon-dew

Loading