Skip to content

Move influxctl --perf-debug example output to command reference #6599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: influxctl-v2.12.0
Choose a base branch
from
+181 −47
Draft

Move influxctl --perf-debug example output to command reference #6599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20d8929
Initial plan
Copilot Dec 9, 2025
29c1a51
docs: move perf-debug example output to query command reference
Copilot Dec 9, 2025
cc8cd64
docs: update placeholder syntax and add link to query command
Copilot Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ influxctl query [flags] <QUERY>
| | `--enable-system-tables` | Enable ability to query system tables |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--language` | Query language (`sql` _(default)_ or `influxql`) |
| | `--perf-debug` | Output performance statistics and gRPC response trailers instead of query results |
| | `--time-format` | Time format for table output (`rfc3339nano` _(default)_ or `unixnano`) |
| | `--token` | Database token with read permissions on the queried database |
| `-h` | `--help` | Output command help |
Expand All @@ -92,6 +93,7 @@ _Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/in
- [Query InfluxDB 3 and return results in JSON format](#query-influxdb-3-and-return-results-in-json-format)
- [Query InfluxDB 3 and return results with Unix nanosecond timestamps](#query-influxdb-3-and-return-results-with-unix-nanosecond-timestamps)
- [Query InfluxDB 3 using credentials from the connection profile](#query-influxdb-3-using-credentials-from-the-connection-profile)
- [Output query performance statistics](#output-query-performance-statistics)
- [Query data from InfluxDB 3 system tables](#query-data-from-influxdb-3-system-tables)

In the examples below, replace the following:
Expand Down Expand Up @@ -407,6 +409,89 @@ influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'"
```
{{% /influxdb/custom-timestamps %}}

### Output query performance statistics

Use the `--perf-debug` flag to output performance statistics and gRPC response
trailers instead of query results.
This is useful for debugging query performance and understanding query execution.

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Table format](#)
[JSON format](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```sh { placeholders="DATABASE_TOKEN|DATABASE_NAME" }
influxctl query \
--perf-debug \
--format table \
--token DATABASE_TOKEN \
--database DATABASE_NAME \
--language influxql \
"SELECT SUM(temp) FROM home WHERE time > now() - 1h GROUP BY time(5m)"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sh { placeholders="DATABASE_TOKEN|DATABASE_NAME" }
influxctl query \
--perf-debug \
--format json \
--token DATABASE_TOKEN \
--database DATABASE_NAME \
--language influxql \
"SELECT SUM(temp) FROM home WHERE time > now() - 1h GROUP BY time(5m)"
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}

{{< expand-wrapper >}}
{{% expand "View example table-formatted performance statistics" %}}
```
+--------------------------+----------+
| Metric | Value |
+--------------------------+----------+
| Client Duration | 1.222 s |
| Output Rows | 20 |
| Output Size | 647 B |
+--------------------------+----------+
| Compute Duration | 37.2 ms |
| Execution Duration | 243.8 ms |
| Ingester Latency Data | 0 |
| Ingester Latency Plan | 0 |
| Ingester Partition Count | 0 |
| Ingester Response | 0 B |
| Ingester Response Rows | 0 |
| Max Memory | 70 KiB |
| Parquet Files | 1 |
| Partitions | 1 |
| Planning Duration | 9.6 ms |
| Queue Duration | 286.6 µs |
+--------------------------+----------+
```
{{% /expand %}}
{{% expand "View example JSON-formatted performance statistics" %}}
```json
{
"client_duration_secs": 1.101,
"compute_duration_secs": 0.037,
"execution_duration_secs": 0.247,
"ingester_latency_data": 0,
"ingester_latency_plan": 0,
"ingester_partition_count": 0,
"ingester_response_bytes": 0,
"ingester_response_rows": 0,
"max_memory_bytes": 71744,
"output_bytes": 647,
"output_rows": 20,
"parquet_files": 1,
"partitions": 1,
"planning_duration_secs": 0.009,
"queue_duration_secs": 0
}
```
{{% /expand %}}
{{< /expand-wrapper >}}

### Query data from InfluxDB 3 system tables

> [!Note]
Expand Down Expand Up @@ -460,6 +545,11 @@ cat ./query.sql | influxctl query \

{{% expand "View command updates" %}}

#### v2.12.0 {date="2025-12-09"}

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

#### v2.9.0 {date="2024-05-06"}

- Add `--time-format` flag to specify which timestamp format to use in the
Expand Down
90 changes: 90 additions & 0 deletions content/influxdb3/clustered/reference/cli/influxctl/query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ influxctl query [flags] <QUERY>
| | `--enable-system-tables` | Enable ability to query system tables |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--language` | Query language (`sql` _(default)_ or `influxql`) |
| | `--perf-debug` | Output performance statistics and gRPC response trailers instead of query results |
| | `--time-format` | Time format for table output (`rfc3339nano` _(default)_ or `unixnano`) |
| | `--token` | Database token with read permissions on the queried database |
| `-h` | `--help` | Output command help |
Expand All @@ -90,6 +91,7 @@ _Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxct
- [Query InfluxDB 3 and return results in JSON format](#query-influxdb-3-and-return-results-in-json-format)
- [Query InfluxDB 3 and return results with Unix nanosecond timestamps](#query-influxdb-3-and-return-results-with-unix-nanosecond-timestamps)
- [Query InfluxDB 3 using credentials from the connection profile](#query-influxdb-3-using-credentials-from-the-connection-profile)
- [Output query performance statistics](#output-query-performance-statistics)
- [Query data from InfluxDB 3 system tables](#query-data-from-influxdb-3-system-tables)

In the examples below, replace the following:
Expand Down Expand Up @@ -405,6 +407,89 @@ influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'"
```
{{% /influxdb/custom-timestamps %}}

### Output query performance statistics

Use the `--perf-debug` flag to output performance statistics and gRPC response
trailers instead of query results.
This is useful for debugging query performance and understanding query execution.

{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Table format](#)
[JSON format](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```sh { placeholders="DATABASE_TOKEN|DATABASE_NAME" }
influxctl query \
--perf-debug \
--format table \
--token DATABASE_TOKEN \
--database DATABASE_NAME \
--language influxql \
"SELECT SUM(temp) FROM home WHERE time > now() - 1h GROUP BY time(5m)"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```sh { placeholders="DATABASE_TOKEN|DATABASE_NAME" }
influxctl query \
--perf-debug \
--format json \
--token DATABASE_TOKEN \
--database DATABASE_NAME \
--language influxql \
"SELECT SUM(temp) FROM home WHERE time > now() - 1h GROUP BY time(5m)"
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}

{{< expand-wrapper >}}
{{% expand "View example table-formatted performance statistics" %}}
```
+--------------------------+----------+
| Metric | Value |
+--------------------------+----------+
| Client Duration | 1.222 s |
| Output Rows | 20 |
| Output Size | 647 B |
+--------------------------+----------+
| Compute Duration | 37.2 ms |
| Execution Duration | 243.8 ms |
| Ingester Latency Data | 0 |
| Ingester Latency Plan | 0 |
| Ingester Partition Count | 0 |
| Ingester Response | 0 B |
| Ingester Response Rows | 0 |
| Max Memory | 70 KiB |
| Parquet Files | 1 |
| Partitions | 1 |
| Planning Duration | 9.6 ms |
| Queue Duration | 286.6 µs |
+--------------------------+----------+
```
{{% /expand %}}
{{% expand "View example JSON-formatted performance statistics" %}}
```json
{
"client_duration_secs": 1.101,
"compute_duration_secs": 0.037,
"execution_duration_secs": 0.247,
"ingester_latency_data": 0,
"ingester_latency_plan": 0,
"ingester_partition_count": 0,
"ingester_response_bytes": 0,
"ingester_response_rows": 0,
"max_memory_bytes": 71744,
"output_bytes": 647,
"output_rows": 20,
"parquet_files": 1,
"partitions": 1,
"planning_duration_secs": 0.009,
"queue_duration_secs": 0
}
```
{{% /expand %}}
{{< /expand-wrapper >}}

### Query data from InfluxDB 3 system tables

> [!Note]
Expand Down Expand Up @@ -458,6 +543,11 @@ cat ./query.sql | influxctl query \

{{% expand "View command updates" %}}

#### v2.12.0 {date="2025-12-09"}

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

#### v2.9.0 {date="2024-05-06"}

- Add `--time-format` flag to specify which timestamp format to use in the
Expand Down
48 changes: 1 addition & 47 deletions content/shared/influxctl/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,7 @@
### 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

Example Output for `--perf-debug`:

```
$ ./influxctl query --perf-debug --format table --token REDACTED --database testdb --language influxql "SELECT SUM(i), non_negative_difference(SUM(i)) as diff_i FROM data WHERE time > '2025-11-07T01:20:00Z' AND time < '2025-11-07T03:00:00Z' AND runid = '540cd752bb6411f0a23e30894adea878' GROUP BY time(5m)"
+--------------------------+----------+
| Metric | Value |
+--------------------------+----------+
| Client Duration | 1.222 s |
| Output Rows | 20 |
| Output Size | 647 B |
+--------------------------+----------+
| Compute Duration | 37.2 ms |
| Execution Duration | 243.8 ms |
| Ingester Latency Data | 0 |
| Ingester Latency Plan | 0 |
| Ingester Partition Count | 0 |
| Ingester Response | 0 B |
| Ingester Response Rows | 0 |
| Max Memory | 70 KiB |
| Parquet Files | 1 |
| Partitions | 1 |
| Planning Duration | 9.6 ms |
| Queue Duration | 286.6 µs |
+--------------------------+----------+

$ ./influxctl query --perf-debug --format json --token REDACTED --database testdb --language influxql "SELECT SUM(i), non_negative_difference(SUM(i)) as diff_i FROM data WHERE time > '2025-11-07T01:20:00Z' AND time < '2025-11-07T03:00:00Z' AND runid = '540cd752bb6411f0a23e30894adea878' GROUP BY time(5m)"
{
"client_duration_secs": 1.101,
"compute_duration_secs": 0.037,
"execution_duration_secs": 0.247,
"ingester_latency_data": 0,
"ingester_latency_plan": 0,
"ingester_partition_count": 0,
"ingester_response_bytes": 0,
"ingester_response_rows": 0,
"max_memory_bytes": 71744,
"output_bytes": 647,
"output_rows": 20,
"parquet_files": 1,
"partitions": 1,
"planning_duration_secs": 0.009,
"queue_duration_secs": 0
}
```
```
- Add a new `--perf-debug` flag to the [`query` command](/influxdb3/version/reference/cli/influxctl/query/) that outputs performance statistics and gRPC response trailers instead of query results

### Dependency updates

Expand Down