Add documentation for query log in cloud dedicated#6866
Add documentation for query log in cloud dedicated#6866ritwika314 wants to merge 10 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for the query log feature in InfluxDB 3 Cloud Dedicated. The new page explains how to view and analyze executed queries using both the Admin UI's Query History interface and the influxctl CLI by querying the _internal database. The documentation includes practical examples for filtering queries by status, duration, database, and time range, along with screenshots demonstrating the Admin UI interface.
Changes:
- Added
/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.mdwith dual-method documentation (Admin UI and CLI) - Documented query log schema including status, timing metrics, resource usage columns, and filtering capabilities
- Included working examples for common query log use cases with both SQL filtering and Admin UI filtering options
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
| > [!Note] | ||
| > #### Query logging is not enabled by default | ||
| > | ||
| > The query log is not enabled by default on all clusters as it can create a negligible ingest load on your cluster. |
There was a problem hiding this comment.
The statement "query log is not enabled by default on all clusters as it can create a negligible ingest load" is confusing. If the load is negligible, that's not typically a reason to disable a feature. Consider clarifying whether the load is significant (not negligible) or providing a different reason for why it's disabled by default (e.g., privacy concerns, storage costs, or that it's intended for troubleshooting rather than continuous monitoring).
| > The query log is not enabled by default on all clusters as it can create a negligible ingest load on your cluster. | |
| > The query log is disabled by default on all clusters because it generates additional ingest and storage overhead and is intended primarily for troubleshooting, not continuous monitoring. |
There was a problem hiding this comment.
I think its more accurate to say:
The query log is not enabled by default on all clusters as it can create a small additional ingest and storage load on your cluster.
There was a problem hiding this comment.
Replaced note with @jeffreyssmith2nd 's suggestion.
| 1. To access the {{% product-name %}} Admin UI, visit the following url in your browser: | ||
|
|
||
| <pre> | ||
| <a href="https://console.influxdata.com">https://console.influxdata.com</a> | ||
| </pre> | ||
|
|
||
| 2. Use the credentials provided by InfluxData to log into the Admin UI. | ||
| If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). | ||
|
|
There was a problem hiding this comment.
Following the established pattern in other cloud-dedicated files (e.g., content/influxdb3/cloud-dedicated/admin/databases/list.md), this section should use the {{< admin-ui-access >}} shortcode instead of manually writing out the access instructions. This maintains consistency and centralizes the Admin UI access instructions. Replace lines 37-44 with the shortcode.
| 1. To access the {{% product-name %}} Admin UI, visit the following url in your browser: | |
| <pre> | |
| <a href="https://console.influxdata.com">https://console.influxdata.com</a> | |
| </pre> | |
| 2. Use the credentials provided by InfluxData to log into the Admin UI. | |
| If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). | |
| {{< admin-ui-access >}} |
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
…optimize/query-log.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…optimize/query-log.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
PR Preview
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
…optimize/query-log.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jstirnaman
left a comment
There was a problem hiding this comment.
1 question for clarification, some minor fixes, and waiting on more from Copilot
| 3. Run the **query** subcommand with `--database` and `--language` (and optionally `--config`). | ||
| Global flags such as `--config` must come before the command; query flags such as `--database`, `--language`, and `--token` must come after `query`. | ||
|
|
||
| {{% code-placeholders "DATABASE_TOKEN" %}} |
There was a problem hiding this comment.
@copilot Replace these with the placeholders attribute
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Show resolved
Hide resolved
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log.md
Outdated
Show resolved
Hide resolved
| > [!Note] | ||
| > #### Query logging is not enabled by default | ||
| > | ||
| > The query log is not enabled by default on all clusters as it can create a negligible ingest load on your cluster. |
|
@jstirnaman I've opened a new pull request, #6869, to work on those changes. Once the pull request is ready, I'll request review from you. |
…ibute (#6869) * Initial plan * Replace deprecated code-placeholders shortcode with placeholders attribute Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* Initial plan * Fix support link pattern and add enforcement check Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * Remove validation changes, keep content fix only Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
blegesse-w
left a comment
There was a problem hiding this comment.
Looks solid to me. thanks for including examples. I think once the copilot and existing comments are resolved, it's should be good to merge 🥇
…optimize/query-log.md Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Summary
This pull request adds a docs page for query log in InfluxDB 3 Cloud Dedicated using both the Admin UI and
influxctlwith examples and screenshots.Checklist
npx hugo --quiet)Suggested reviewers (click to expand)
Based on files changed, consider requesting review from:
InfluxDB 3
InfluxDB v2 / v1 / Enterprise v1
Other Products
Shared / Cross-Product
/content/shared/