Move influxctl --perf-debug example output to command reference#6599
Merged
jstirnaman merged 6 commits intomasterfrom Dec 22, 2025
Merged
Move influxctl --perf-debug example output to command reference#6599jstirnaman merged 6 commits intomasterfrom
jstirnaman merged 6 commits intomasterfrom
Conversation
Copilot
AI
changed the title
[WIP] Release influxctl version 2.12.0
Move influxctl --perf-debug example output to command reference
Dec 9, 2025
jstirnaman
requested changes
Dec 9, 2025
jstirnaman
requested changes
Dec 19, 2025
Contributor
jstirnaman
left a comment
jstirnaman
left a comment
There was a problem hiding this comment.
Review: Example output doesn't match the documented command
The example performance statistics output was copied from the release notes, but was generated from a different query:
| Source | Query |
|---|---|
| Release notes | SELECT SUM(i), non_negative_difference(SUM(i)) as diff_i FROM data WHERE time > '2025-11-07T01:20:00Z'... |
| Documentation | SELECT SUM(temp) FROM home WHERE time > now() - 1h GROUP BY time(5m) |
The output values (20 rows, 1.222s duration, 70 KiB memory) wouldn't match if a user ran the simplified query.
Action required: Either:
- Regenerate the example output using the documented query, or
- Preface the output with "The output is similar to the following." if exact reproduction isn't feasible
See DOCS-CONTRIBUTING.md - Code examples for the documentation standard.
Contributor
Author
Added the disclaimer "The output is similar to the following:" before the example output sections in both Cloud Dedicated and Clustered query.md files. This indicates that the output values are representative but may not exactly match when running the simplified query. Changes in commit 3c4c22e. |
jstirnaman
approved these changes
Dec 19, 2025
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
…d query Regenerate example performance statistics output using the documented query (SELECT SUM(temp) FROM home). Tested influxctl query --perf-debug command to verify output format and values.
jstirnaman
force-pushed
the
copilot/sub-pr-6598
branch
from
f8dbc71 to
0997c45
Compare
Contributor
|
jstirnaman
approved these changes
Dec 22, 2025
jstirnaman
added a commit
that referenced
this pull request
Dec 22, 2025
* Initial plan * docs: move perf-debug example output to query command reference Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * docs: update placeholder syntax and add link to query command Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * docs: add disclaimer for example performance statistics output Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * fix(influxdb3): update --perf-debug example output to match documented query Regenerate example performance statistics output using the documented query (SELECT SUM(temp) FROM home). Tested influxctl query --perf-debug command to verify output format and values. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
--perf-debugflag documentation to Cloud Dedicated query.md--perf-debugflag documentation to Clustered query.md--perf-debugoutput in both formats💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.