Skip to content
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.

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

docs: Fix typo in tracing docs #11952

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion velox/docs/configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ Tracing
- Description
* - query_trace_enabled
- bool
- true
- false
- If true, enable query tracing.
* - query_trace_dir
- string
Expand Down
10 changes: 5 additions & 5 deletions velox/docs/develop/debugging/tracing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ and produces a list of `exec::Split` for the query replay.
Trace Scan
^^^^^^^^^^

As outlined in the **How Tracing Works** section, replaying a non-leaf operator requires a
As outlined in the **How Tracing Tool Works** section, replaying a non-leaf operator requires a
specialized source operator. This operator is responsible for reading data records during the
tracing phase and integrating with Velox’s `LocalPlanner` with a customized plan node and
operator translator.
Expand Down Expand Up @@ -269,12 +269,12 @@ The query trace replayer is typically used in the local environment and works as
- Add the replay plan node to the replay plan as the source node.
- Get all the traced splits using `OperatorInputSplitReader`.
- Use the splits as inputs for task replaying.
5. For a non-leaf operator, add a `QueryTraceScanNode` as the source node to the replay plan and
5. For a non-leaf operator, add a `TraceScanNode` as the source node to the replay plan and
then add the replay plan node.
6. Use `exec::test::AssertQueryBuilder` to add the sink node, apply the query
configurations (disable tracing), and connector properties, and execute the replay plan.

The `OperatorReplayBase` provides the core functionality required for replaying an operator.
The `OperatorReplayerBase` provides the core functionality required for replaying an operator.
It handles the retrieval of metadata, creation of the replay plan, and execution of the plan.
Concrete operator replayers, such as `HashJoinReplayer` and `AggregationReplayer`, extend this
base class and override the `createPlanNode` method to create the specific plan node.
Expand Down Expand Up @@ -360,9 +360,9 @@ Here is a full list of supported command line arguments.
* ``--summary``: Show the summary of the tracing including number of tasks and task ids.
It also print the query metadata including query configs, connectors properties, and query plan in JSON format.
* ``--query_id``: Specify the target query ID, it must be set.
* ``--task_id``: Specify the target task ID, it must be set.
* ``--task_id``: Specify the target task ID, if empty, show the summary of all the traced query task.
* ``--node_id``: Specify the target node ID, it must be set.
* ``--driver_ids``: Specify the target driver IDs to replay.
* ``--driver_ids``: A comma-separated list of target driver ids.
* ``--shuffle_serialization_format``: Specify the shuffle serialization format.
* ``--table_writer_output_dir``: Specify the output directory of TableWriter.
* ``--hiveConnectorExecutorHwMultiplier``: Hardware multiplier for hive connector.
2 changes: 1 addition & 1 deletion website/blog/2024-12-15-tracing-query-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ and a plan fragment.
4. If the target plan node is a `TableScanNode`, add the replay plan node to the replay plan
as the source node. Get all the traced splits using `OperatorInputSplitReader`.
Use the splits as inputs for task replaying.
5. For a non-leaf operator, add a `QueryTraceScanNode` as the source node to the replay plan and
5. For a non-leaf operator, add a `TraceScanNode` as the source node to the replay plan and
then add the replay plan node.
6. Add a sink node, apply the query configurations (disable tracing), and connector properties,
and execute the replay plan.
Expand Down
Loading