DOC-12541 new query report generation tool #3905
Conversation
Pallavi-Janardhan
requested review from
RichardSmedley,
simon-dew and
safianalicb
simon-dew
changed the title
simon-dew
force-pushed
the
DOC-12541_new_query_report_generation_tool
branch
from
e2b7465 to
3d84a55
Compare
|
This PR targets |
simon-dew
force-pushed
the
DOC-12541_new_query_report_generation_tool
branch
from
3d84a55 to
c0e0e5f
Compare
|
Okay I have recreated this PR to start from |
There was a problem hiding this comment.
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]| 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 `--cluster` flag specifies the hostname of the Couchbase cluster. Example: `cbqueryreportgen couchbase://localhost`. |
There was a problem hiding this comment.
Add an Options heading. Also, mention that the first listed options are required.
| The `--cluster` flag specifies the hostname of the Couchbase cluster. Example: `cbqueryreportgen couchbase://localhost`. | |
| == Options | |
| Required flags: | |
| The `--cluster` flag specifies the hostname of the Couchbase cluster. Example: `cbqueryreportgen couchbase://localhost`. |
|
|
||
| The `--output` flag specifies the output file to write the report to. Example: `cbqueryreportgen --output report.html`. | ||
|
|
||
| optional Flags: |
There was a problem hiding this comment.
Capitalization:
| optional Flags: | |
| Optional flags: |
|
|
||
| The `--version` flag prints to the console the version number of the Couchbase Server. | ||
|
|
||
| == See Also |
There was a problem hiding this comment.
Add an example, as suggested in the ticket:
| == See Also | |
| == Example | |
| This example creates a report showing all of the statistics for a single day. | |
| The AWR repository is `travel-sample._default.awr`. | |
| It is assumed that the user has 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-24T00:00:00,2025-09-24T23:59:59' | |
| ---- | |
| ==== | |
| The output of the command is a report in HTML format, saved to the file `report.html`. | |
| == See Also |
Jira: [DOC-9905]
Added info about the new utility, cbqueryreportgen, to the CLI Reference doc.
Docs preview
Preview credentials