Optimize Spark Sql Plan logo

Optimize Spark Sql Plan

Organization
EmbrasureAI
optimize-spark-sql-plan

Optimize Apache Spark SQL and DataFrame queries using the final Adaptive Query Execution plan and runtime statistics rather than source code alone. Use to reduce runtime, shuffle, spill, scan cost, skew, join amplification, Python UDF overhead, poor partitioning, or unnecessary work while preserving query semantics.

Overview

PublisherEmbrasureAI
Repositoryspark-observability-skills
Skill nameoptimize-spark-sql-plan
Stars
54
Forks
14
Bundled files
1
LicenseApache-2.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 1 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by EmbrasureAI on GitHub. Read the source before you install it.

Installation

Install the Optimize Spark Sql Plan AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/EmbrasureAI/spark-observability-skills/tree/main/skills/optimize-spark-sql-plan
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/EmbrasureAI/spark-observability-skills.git /tmp/spark-observability-skills
mkdir -p .claude/skills
cp -r /tmp/spark-observability-skills/skills/optimize-spark-sql-plan .claude/skills/optimize-spark-sql-plan
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Optimize Spark Sql Plan in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Optimize Spark Sql Plan on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Optimize Spark Sql Plan is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Optimize a Spark SQL plan

Find the highest-impact improvement supported by the executed plan and its runtime metrics. Work from the final adaptive plan (isFinalPlan=true), not source code or the initial plan: AQE may already have broadcast, coalesced, or split what you were about to recommend.

Get the evidence

bash
export SPARK_HISTORY_URL="https://history.example.com"
python3 scripts/spark_history_api.py sql-list --app-id <application-id>
python3 scripts/spark_history_api.py sql --app-id <application-id> --execution-id <execution-id> > /tmp/spark-sql.json

Run from this skill directory. If SPARK_HISTORY_URL is unset, find the server before asking the user: try http://localhost:18080, a running application's UI on http://localhost:4040, and the history-server or eventLog settings in the local Spark config; ask only when nothing responds. Authentication comes from SPARK_HISTORY_AUTHORIZATION, SPARK_HISTORY_COOKIE, or SPARK_HISTORY_HEADERS_JSON; never ask for credentials in chat and never disable TLS verification (--ca-file for a private CA).

The snapshot's layout: sqlExecution.planDescription is the executed plan text, sqlExecution.nodes[].metrics carry per-operator counters with edges giving parent-child links, jobs[].stageIds tie the execution to stages, longestStages[] holds each stage with its taskSummary quantiles (arrays align with quantiles; middle is median, last is max), and environment.sparkProperties is the effective configuration. For data beyond the profile, other subcommands (slow, failure, applications) and the raw $SPARK_HISTORY_URL/api/v1 endpoints (/stages/{stage}/{attempt}/taskSummary, /allexecutors, /environment) are available with the same auth. If the API omits the plan, recover it from the driver log or generate explain(mode="formatted") from the deployed code yourself. Get the deployed query code too: the plan tells you what ran, the code tells you what was intended.

Highest-impact opportunities, in order, and how to check each

  1. Cardinality blowup. Join output far exceeding both inputs is usually an unintended many-to-many:

    bash
    jq '.sqlExecution.nodes[] | select(.nodeName | test("Join")) | {nodeId, nodeName, rows: [.metrics[] | select(.name | test("output rows"))]}' /tmp/spark-sql.json

    Compare each join's rows against its children's (follow edges). Fix keys or deduplicate first; it dominates every downstream metric.

  2. Pruning. Scans reading far more than the query uses:

    bash
    jq '.sqlExecution.nodes[] | select(.nodeName | startswith("Scan")) | {nodeName, metrics}' /tmp/spark-sql.json

    Compare files and bytes read against rows output, and check the pushed/partition filters on the scan in planDescription.

  3. Broadcast. A SortMergeJoin whose smaller side is observed (not estimated) to be broadcastable:

    bash
    jq -r '.sqlExecution.planDescription' /tmp/spark-sql.json | grep -n 'SortMergeJoin\|BroadcastHashJoin'

    Read the smaller side's "data size" metric from its node, and spark.sql.autoBroadcastJoinThreshold from environment.sparkProperties. Stale statistics are the usual reason AQE missed it; confirm executor memory headroom before recommending.

  4. Unnecessary shuffles. Exchanges whose partitioning an upstream operation already satisfies, or repartitions the query does not need:

    bash
    jq -r '.sqlExecution.planDescription' /tmp/spark-sql.json | grep -n 'Exchange'

    Every exchange should map to a semantic requirement; look for back-to-back exchange/sort pairs and matching partitioning expressions above and below.

  5. Skewed joins and aggregations. One partition dominating a join or aggregate stage:

    bash
    jq '{jobStages: [.jobs[] | {jobId, stageIds}], stages: [.longestStages[] | {id: .stage.stageId, run: .taskSummary.executorRunTime, shuffleRead: .taskSummary.shuffleReadMetrics.readBytes}]}' /tmp/spark-sql.json

    Max many times median on the join's stage is skew; check planDescription for skewed=true and, if AQE did not handle it, why. Re-run with a higher --stage-limit if the stage is missing.

  6. Partition count. Uniformly oversized shuffle partitions with spill: grep -n 'AQEShuffleRead' <(jq -r '.sqlExecution.planDescription' /tmp/spark-sql.json) for coalescing, stage numTasks from longestStages[].stage, and spill from the check below. Raise spark.sql.shuffle.partitions or AQE targets before adding explicit repartitions, which can insert redundant exchanges.

  7. Excess spill in stateful operators. Aggregates, sorts, and windows spilling:

    bash
    jq '.sqlExecution.nodes[] | select(.nodeName | test("Aggregate|Sort|Window")) | {nodeName, spill: [.metrics[] | select(.name | test("spill"))]}' /tmp/spark-sql.json

    Reduce state (partial aggregation, narrower rows, fewer window columns) before adding memory.

  8. Python UDF boundaries. Serialization often costs more than the function itself:

    bash
    jq '.sqlExecution.nodes[] | select(.nodeName | test("Python")) | {nodeName, metrics}' /tmp/spark-sql.json

    Weigh node time against rows processed; a native expression removes the boundary.

  9. Caching. jq -r '.sqlExecution.planDescription' /tmp/spark-sql.json | grep -c 'InMemoryTableScan': a cached result scanned once wastes memory, and a subtree recomputed under several plan branches wants a cache.

The commands above are starting points, not limits: compose your own jq, call the REST API directly, or pull logs, code, and platform state when a question needs it. Rule each candidate in or out with evidence, and when a signal is suggestive but not conclusive, go a level deeper (more task samples, the exact log lines, the executed plan) until you are confident it is or is not the cause. Do not settle for the first plausible explanation.

An Exchange is not automatically waste, a sort-merge join is not automatically wrong, a broadcast is not automatically safe, and a Python UDF is not automatically material: tie every recommendation to the node's runtime metrics, and check whether Catalyst or AQE already applied it.

Changes must preserve semantics: row counts, join cardinality, null behavior, duplicates, and ordering assumptions. Changing partitioning can alter low-order bits of floating-point aggregations.

Report

State the highest-impact change with its plan node, runtime evidence, and expected effect; why Spark did not already do it; correctness risks; and any remaining smaller findings. Do not apply hints, code, or configuration changes to production without approval.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Optimize Spark Sql Plan AI skill do?

Optimize Apache Spark SQL and DataFrame queries using the final Adaptive Query Execution plan and runtime statistics rather than source code alone. Use to reduce runtime, shuffle, spill, scan cost, skew, join amplification, Python UDF overhead, poor partitioning, or unnecessary work while preserving query semantics.

Why use Optimize Spark Sql Plan on TypingMind?

Because you install it once and use it with any model. Optimize Spark Sql Plan is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Optimize Spark Sql Plan in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/EmbrasureAI/spark-observability-skills/tree/main/skills/optimize-spark-sql-plan. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Optimize Spark Sql Plan?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Optimize Spark Sql Plan?

As many as you like. As long as a model supports skills, you can use Optimize Spark Sql Plan with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Optimize Spark Sql Plan AI skill free?

Yes. It is published on GitHub by EmbrasureAI under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇