DOC-12541 new query report generation tool

modules/ROOT/nav.adoc

@@ -285,6 +285,7 @@ include::cli:partial$cbcli/nav.adoc[]
   *** xref:cli:cbft-bleve-zap.adoc[cbft-bleve: Zap Files]
  ** xref:cli:cbcli/cblogredaction.adoc[cblogredaction]
  ** xref:cli:cbq-tool.adoc[cbq]
+ ** xref:cli:cbqueryreportgen.adoc[cbqueryreportgen]
  ** xref:cli:cbtools/cbrecovery.adoc[cbrecovery]
  ** xref:cli:cbstats-intro.adoc[cbstats]
   *** xref:cli:cbstats/cbstats-all.adoc[all]

modules/cli/pages/cbqueryreportgen.adoc

@@ -0,0 +1,106 @@
+= cbqueryreportgen
+:description: pass:q[The `cbqueryreportgen` tool returns the complete details of any Query service to generate reports.]
+:page-status: Couchbase Server 8.0
+:page-component: Query
+ifndef::doctype-manpage[:doctitle: cbqueryreportgen]
+:page-component-version: 8.0
+:page-topic-type: reference
+
+[abstract]
+A query tool that returns the complete details of any Query Service to generate reports.
+
+== Syntax
+
+----
+cbqueryreportgen [-<args>
+                  [ -c, --cluster <cluster> ]
+                  [ -u, --username <username> ]
+                  [ -p, --password <password> ]
+                  [ -k, <keyspace> ]
+                  [ -t1, <start-time>,<end-time> ]
+                  [ -t2, <start-time>,<end-time> ]
+                  [ -o, --output <output> ]
+                  [ -l, --limit <limit> ]
+                  [ -v, --verbose ]
+                  [ -h, --help ] 
+                 ]
+----
+
+
+== Description
+
+ifeval::['{page-component-version}' == '8.0'] 
+This tool is only available in Couchbase Server 8.0 and later.
+endif::[]
+
+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 output file where the report must be saved. The output of the command is a report in HTML format.
+
+Depending upon your platform, this tool is at the following locations:
+
+[cols="1,3"]
+|===
+| Operating system | Location
+
+| Linux
+| [.path]`/opt/couchbase/bin/`
+
+| Windows
+| [.path]`C:\Program Files\Couchbase\Server\bin\`
+
+| Mac OS X
+| [.path]`/Applications/CouchbaseServer.app/Contents/Resources/couchbase-core/bin/`
+|===
+
+== Options 
+
+Required flags: 
+
+The following flags are required to run the `cbqueryreportgen` command.
+
+The `-c, --cluster` flag specifies the hostname of the Couchbase cluster. Example: `couchbase://localhost`.
+
+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: `-p password`.
+
+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, in the local timezone. 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 for the report. Example: `report.html`.
+
+Optional flags:
+
+The `-t2` flag specifies the start-time and end-time of the second time period, in the local timezone. Enter both start-time and end-time in the `YYYY-MM-DDTHH:MM:SS` format, separated by a comma. Example: `2025-09-02T00:00:00,2025-09-03T00:00:00`.
+
+The `-l, --limit` flag specifies the maximum number of results to include for every query. The default is `1000`.
+
+The `-v, --verbose` flag enables verbose logging for debugging purposes.
+
+The `-h, --help` flag prints the help information.
+
+For more information about how the specific command works, run `cbqueryreportgen --help`.
+
+== Example
+
+This example creates a report showing all of the statistics for a single day.
+The AWR repository is `travel-sample._default.awr`. It's assumed that you have already specified this as the AWR repository, and created an index on the document key in the configured AWR location.
+
+====
+[source,sh]
+----
+cbqueryreportgen -c couchbase://localhost \
+-u Administrator -p password \
+-k travel-sample._default.awr \
+-o report.html \
+-t1 '2025-09-01T00:00:00,2025-09-01T23:59:59'
+----
+====
+
+The output of the command is a report in HTML format, saved to the file `report.html`.
+
+== See Also 
+
+For detailed information, see xref:n1ql:n1ql-manage/query-awr.adoc[Automatic Workload Repository].

modules/cli/pages/cli-intro.adoc

@@ -49,6 +49,7 @@ The Server developer tools package lets you install the following EE Server util
 * xref:tools:cbexport.adoc[`cbexport`]
 * xref:tools:cbimport.adoc[`cbimport`]
 * xref:cli:cbq-tool.adoc[`cbq`]
+* xref:cli:cbqueryreportgen.adoc[`cbqueryreportgen`] 
 
 Download the command line tools package for your platform from the following links:
 
@@ -84,6 +85,7 @@ The Server admin tools package lets you install the following Server utilities o
 * xref:tools:cbimport.adoc[`cbimport`]
 * xref:cli:cbq-tool.adoc[`cbq`]
 * xref:cli:cbstats-intro.adoc[`cbstats`]
+* xref:cli:cbqueryreportgen.adoc[`cbqueryreportgen`] 
 * xref:cli:cbcli/couchbase-cli.adoc[`couchbase-cli`]
 * xref:cli:mcstat.adoc[`mcstat`]
 * xref:cli:mctimings.adoc[`mctimings`]
@@ -116,7 +118,7 @@ If you do not have these libraries installed, download them from https://docs.mi
 
 The versions of the utilities installed by the tools package are the same as the corresponding Couchbase Server installation package.
 
-For Server developer tools package, the {tools-ver} version of `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
+For the Server developer tools package, the {tools-ver} version of `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
 
 * 8.0.x
 * 7.6.x
@@ -125,7 +127,9 @@ For Server developer tools package, the {tools-ver} version of `cbimport`, `cbex
 
 You can download and use the latest version of the utilities (`cbimport`, `cbexport`, `cbbackupmgr`, and `cbq`) with earlier Couchbase Server versions.
 
-For Server admin tools package, do the following:
+The `cbqueryreportgen` utility is supported only on Couchbase Server 8.0 or later.
+
+For the Server admin tools package, do the following:
 
 * Use the `--version` option to get the version of the utility. However, for the `cbc` utility, use the `cbc version` option.
 * `couchbase-cli` is a utility for administering the Couchbase cluster. Make sure that the versions of `couchbase-cli` and the Couchbase cluster match.