Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1959 from influxdata/operator-profiler 

Add the Flux 'operator' profiler
pull/1963/head
Scott Anderson 2020-12-08 21:30:13 -07:00 committed by GitHub
parent 0e62149ce9 d000fd9746
commit ff8ded2cc4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
content/influxdb/cloud/reference/flux/stdlib/profiler/_index.md
View File

@ -9,61 +9,9 @@ menu:
name: Profiler
parent: Flux standard library
weight: 202
influxdb/v2.0/tags: [functions, optimize, package]
influxdb/cloud/tags: [functions, optimize, package]
related:
- /influxdb/cloud/query-data/optimize-queries/
---
The Flux Profiler package provides performance profiling tools for Flux queries and operations.
Import the `profiler` package:
```js
import "profiler"
```
## Options
The Profiler package includes the following options:
### enabledProfilers
Enable Flux profilers.
_**Data type:** Array of strings_
```js
import "profiler"
option profiler.enabledProfilers = [""]
```
#### Available profilers
##### query
The `query` profiler provides statistics about the execution of an entire Flux script.
When enabled, results returned by [`yield()`](/influxdb/cloud/reference/flux/stdlib/built-in/outputs/yield/)
include a table with the following columns:
- **TotalDuration**: total query duration in nanoseconds.
- **CompileDuration**: number of nanoseconds spent compiling the query.
- **QueueDuration**: number of nanoseconds spent queueing.
- **RequeueDuration**: number fo nanoseconds spent requeueing.
- **PlanDuration**: number of nanoseconds spent planning the query.
- **ExecuteDuration**: number of nanoseconds spent executing the query.
- **Concurrency**: number of goroutines allocated to process the query.
- **MaxAllocated**: maximum number of bytes the query allocated.
- **TotalAllocated**: total number of bytes the query allocated (includes memory that was freed and then used again).
- **RuntimeErrors**: error messages returned during query execution.
- **flux/query-plan**: Flux query plan.
- **influxdb/scanned-values**: value scanned by InfluxDB.
- **influxdb/scanned-bytes**: number of bytes scanned by InfluxDB.
#### Use the query profiler
Use the query profiler to output statistics about query execution.
```js
import "profiler"
option profiler.enabledProfilers = ["query"]
// ... Query to profile
```
{{< duplicate-oss >}}

33
content/influxdb/v2.0/reference/flux/stdlib/profiler/_index.md
View File

@ -32,12 +32,16 @@ _**Data type:** Array of strings_
```js
import "profiler"
option profiler.enabledProfilers = [""]
option profiler.enabledProfilers = ["query", "operator"]
// Query to profile
```
#### Available profilers
## Available profilers
- [query](#query)
- [operator](#operator)
##### query
### query
The `query` profiler provides statistics about the execution of an entire Flux script.
When enabled, results returned by [`yield()`](/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/yield/)
include a table with the following columns:
@ -56,14 +60,17 @@ include a table with the following columns:
- **influxdb/scanned-values**: value scanned by InfluxDB.
- **influxdb/scanned-bytes**: number of bytes scanned by InfluxDB.
#### Use the query profiler
### operator
The `operator` profiler output statistics about each operation in a query.
[Operations executed in the storage tier](/influxdb/v2.0/query-data/optimize-queries/#start-queries-with-pushdown-functions)
return as a single operation.
When the `operator` profile is enabled, results returned by [`yield()`](/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/yield/)
include a table with a row for each operation and the following columns:
Use the query profiler to output statistics about query execution.
```js
import "profiler"
option profiler.enabledProfilers = ["query"]
// ... Query to profile
```
- **Type:** operation type
- **Label:** operation name
- **Count:** total number of times the operation executed
- **MinDuration:** minimum duration of the operation in nanoseconds
- **MaxDuration:** maximum duration of the operation in nanoseconds
- **DurationSum:** total duration of all operation executions in nanoseconds
- **MeanDuration:** average duration of all operation executions in nanoseconds