[ARROW-15059] [C++] Add basic visibility into execution engine performance

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: C++
• Labels: query-engine
• External issue URL: https://github.com/apache/arrow/issues/30574
• Assignee: Unassigned
• Reporter: Weston Pace
• Created: 10/Dec/21 16:57
• Updated: 11/Jan/23 08:44

Description

For internal development purposes and for bug reports and highly technical users it will be extremely helpful if we can turn on and off a profiling log.

I think initially:

• We may want the ability to entirely disable logging with a compile-time variable (we may already have this since OT can be entirely disabled)
• Enabling or disabling the log is controlled by an environment variable (assuming we built with logging)
• The log will initially just dump to stdout or a flat file (we can also or will also someday export via OT)
• Some initial metrics include "run time of node", "run time of kernel function", "run time of query"
• It would be nice if we could get some regular statistics as well such as the allocated bytes of the memory pools, RSS consumed by the process, etc. Perhaps that would require two files.

Issue Links

• depends upon: ARROW-15044 [C++] Add simple stdout/JSON exporter for OpenTelemetry
• relates to: ARROW-14000 [C++] Add profiling / tracing for exec plan

Sub-Tasks

• [C++][Tools] Create visualization tool for exec plan tracing logs: Open
• [C++][R][Python] Update ExecPlan bindings: Open
• [C++] Add rows scanned to open telemetry / profiling: In Progress
• [C++] Dump OpenTelemetry profiling summary to stdout: Open
• [Tools][Docs] Add instructions on how to collect the produced telemetry data: Open