Skip to content

[SPARK-54340][PYTHON][FOLLOW-UP] Add link and examples for run-with-viztracer#53418

Closed
zhengruifeng wants to merge 1 commit intoapache:masterfrom
zhengruifeng:doc_viz
Closed

[SPARK-54340][PYTHON][FOLLOW-UP] Add link and examples for run-with-viztracer#53418
zhengruifeng wants to merge 1 commit intoapache:masterfrom
zhengruifeng:doc_viz

Conversation

@zhengruifeng
Copy link
Contributor

What changes were proposed in this pull request?

Add link and examples for run-with-viztracer

Why are the changes needed?

to make it easier for developers to have a try

Does this PR introduce any user-facing change?

dev-only changes

How was this patch tested?

manually check

(spark_dev_313) ➜  spark git:(doc_viz) python/run-with-viztracer -h
Usage:
  run-with-viztracer your_original_commands

To view the profiling results, run:
  vizviewer pyspark_*.json

Environment:
  If SPARK_VIZTRACER_OUTPUT_DIR is set, the output will be saved to the directory.
  Otherwise, it will be saved to the current directory.

Requirements:
  - viztracer must be installed (pip install viztracer)

Check the following documentation for more information on using viztracer:

  https://viztracer.readthedocs.io/en/latest/

Examples:
  - Start pyspark shell
    python/run-with-viztracer bin/pyspark --conf spark.driver.memory=16g

  - Start pyspark shell in Connect mode
    python/run-with-viztracer bin/pyspark --remote local

Was this patch authored or co-authored using generative AI tooling?

no

test
Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

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

+1, LGTM. Thank you, @zhengruifeng .

Merged to master/4.1 for Apache Spark 4.1.0 RC3.

dongjoon-hyun pushed a commit that referenced this pull request Dec 10, 2025
…viztracer`

### What changes were proposed in this pull request?
Add link and examples for `run-with-viztracer`

### Why are the changes needed?
to make it easier for developers to have a try

### Does this PR introduce _any_ user-facing change?
dev-only changes

### How was this patch tested?
manually check
```sh
(spark_dev_313) ➜  spark git:(doc_viz) python/run-with-viztracer -h
Usage:
  run-with-viztracer your_original_commands

To view the profiling results, run:
  vizviewer pyspark_*.json

Environment:
  If SPARK_VIZTRACER_OUTPUT_DIR is set, the output will be saved to the directory.
  Otherwise, it will be saved to the current directory.

Requirements:
  - viztracer must be installed (pip install viztracer)

Check the following documentation for more information on using viztracer:

  https://viztracer.readthedocs.io/en/latest/

Examples:
  - Start pyspark shell
    python/run-with-viztracer bin/pyspark --conf spark.driver.memory=16g

  - Start pyspark shell in Connect mode
    python/run-with-viztracer bin/pyspark --remote local
```

### Was this patch authored or co-authored using generative AI tooling?
no

Closes #53418 from zhengruifeng/doc_viz.

Authored-by: Ruifeng Zheng <ruifengz@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
(cherry picked from commit 4520c17)
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
@zhengruifeng zhengruifeng deleted the doc_viz branch December 11, 2025 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants