Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 9, 2025

Relocates --perf-debug flag documentation and example output from release notes to the influxctl query command reference pages.

Changes:

  • Added --perf-debug flag to Flags table in both Cloud Dedicated and Clustered query.md
  • Added "Output query performance statistics" example section with:
    • Table and JSON format command examples
    • Collapsible example output for both formats
  • Updated "View command updates" section to document v2.12.0 addition
  • Removed verbose example output from release notes, keeping only feature description with link to query command reference
  • Modernized placeholder syntax by replacing deprecated code-placeholders shortcode with new { placeholders="..." } attribute syntax

Example structure:

### Output query performance statistics

Use the `--perf-debug` flag to output performance statistics and gRPC response
trailers instead of query results.

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Table format](#)
[JSON format](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```sh { placeholders="DATABASE_TOKEN|DATABASE_NAME" }
...

{{% /code-tab-content %}}
...
{{< /code-tabs-wrapper >}}

{{< expand-wrapper >}}
{{% expand "View example table-formatted performance statistics" %}}
...
{{% /expand %}}
{{< /expand-wrapper >}}


- [x] Signed the [InfluxData CLA](https://www.influxdata.com/legal/cla/)
  ([if necessary](https://github.com/influxdata/docs-v2/blob/master/DOCS-CONTRIBUTING.md#sign-the-influxdata-cla))
- [x] Rebased/mergeable

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 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](https://gh.io/copilot-coding-agent-tips) in the docs.

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copilot AI changed the title [WIP] Release influxctl version 2.12.0 Move influxctl --perf-debug example output to command reference Dec 9, 2025
Copilot AI requested a review from jstirnaman December 9, 2025 16:51
### Features

- Add 'influxdata-archive-keyring' as a suggested package to simplify future repository key rotations for the end user
- Add a new `--perf-debug` flag to the `query` command that outputs performance statistics and gRPC response trailers instead of query results
Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot link to /influxdb3/version/reference/cli/influxctl/query/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done! Added link to the query command reference. Changes in commit cc8cd64.

trailers instead of query results.
This is useful for debugging query performance and understanding query execution.

{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}}
Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot Use the new placeholder attribute syntax. code-placeholders is the deprecated shortcode.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done! Replaced the deprecated code-placeholders shortcode with the new { placeholders="..." } attribute syntax in both Cloud Dedicated and Clustered query.md files. Changes in commit cc8cd64.

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants