Skip to content

Add documentation for query log in cloud dedicated#6866

Open
ritwika314 wants to merge 10 commits intomasterfrom
ritwika/query_log
Open

Add documentation for query log in cloud dedicated#6866
ritwika314 wants to merge 10 commits intomasterfrom
ritwika/query_log

Conversation

@ritwika314
Copy link
Collaborator

Summary

This pull request adds a docs page for query log in InfluxDB 3 Cloud Dedicated using both the Admin UI and influxctl with examples and screenshots.

Checklist

  • Rebased/mergeable
  • Local build passes (npx hugo --quiet)

Suggested reviewers (click to expand)

Based on files changed, consider requesting review from:

InfluxDB 3

Content Engineering Product
Core, Enterprise influxdata/monolith-team peterbarnett03, garylfowler
Clustered influxdata/platform-team ritwika314, sanderson
Cloud Dedicated influxdata/cloud-single-tenant ritwika314, sanderson
Cloud Serverless mavarius, garylfowler
Explorer mavarius, peterbarnett03

InfluxDB v2 / v1 / Enterprise v1

Content Engineering Product
v2, Cloud (TSM) influxdata/edge sanderson, jstirnaman
v1, Enterprise v1 influxdata/edge sanderson, jstirnaman

Other Products

Content Engineering Product
Telegraf influxdata/telegraf-team sanderson, caterryan
Kapacitor influxdata/bonitoo sanderson, jstirnaman
Chronograf influxdata/bonitoo mavarius, caterryan
Flux sanderson, jstirnaman

Shared / Cross-Product

Content Reviewers
/content/shared/ influxdata/product-managers
API docs Relevant product team above

@ritwika314 ritwika314 marked this pull request as ready for review February 25, 2026 01:51
@ritwika314 ritwika314 requested a review from a team as a code owner February 25, 2026 01:51
@ritwika314 ritwika314 requested review from blegesse-w, jeffreyssmith2nd and sanderson and removed request for a team February 25, 2026 01:51
@jstirnaman jstirnaman requested a review from Copilot February 25, 2026 13:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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

> [!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.
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
> 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.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ritwika314 ☝️

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced note with @jeffreyssmith2nd 's suggestion.

Comment on lines 37 to 45
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).

Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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 >}}

Copilot uses AI. Check for mistakes.
jstirnaman and others added 2 commits February 25, 2026 07:58
…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>
@github-actions
Copy link
Contributor

github-actions bot commented Feb 25, 2026

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-6866/
on branch gh-pages at 2026-02-25 17:57 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Feb 25, 2026

PR Preview

Status Details
Preview View preview
Pages 1 page(s) deployed
Build time 66s
Last updated 2026-02-25 17:57:54 UTC
Pages included in this preview
  • /influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-log/

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>
Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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" %}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Replace these with the placeholders attribute

> [!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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ritwika314 ☝️

Copy link
Contributor

Copilot AI commented Feb 25, 2026

@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.

Copilot AI and others added 2 commits February 25, 2026 08:09
…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>
Copy link
Member

@blegesse-w blegesse-w left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🥇

@jstirnaman jstirnaman self-requested a review February 25, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants