Skip to content

Detector catalog / SQL plans

PLAN

Small files

A write produces many tiny files that slow every later read.

Outcome
SQL plans
Scope
Judged per SQL query
Usual fix
A Spark configuration change
CI gate
No budget flag: gate it with --fail-on-introduced against a baseline

An example finding

Where you see it

Dashboard

The PLAN tag marks it in the action region of the dashboard, among the widgets that rank a fix. How to read it in the findings guide.

Agent (MCP)

An assistant can read this entry with the list_detectors tool and its background with get_finding_documentation. The call and the response below come from a real run of the MCP server.

Call

{
  "tool": "list_detectors",
  "arguments": {
    "type": "smallFiles"
  }
}

Response

{
  "count": 1,
  "detectors": [
    {
      "type": "smallFiles",
      "name": "small files",
      "tag": "PLAN",
      "tagSharedWith": [
        "duplicatePlanSubtree",
        "overBroadcast",
        "underBroadcast",
        "pythonUdf",
        "nestedLoopJoin",
        "mergeRewrite",
        "unprunedScan",
        "joinKeyCast"
      ],
      "family": "plan",
      "pitch": "A write produces many tiny files that slow every later read.",
      "region": "action",
      "scope": "sql",
      "fixEffort": "config",
      "thresholdSummary": "over 100 files averaging under 3 MiB",
      "detectors": [
        {
          "detector": "smallFiles",
          "version": 2,
          "thresholds": {
            "minFiles": 100,
            "maxAvgFileSizeMB": 3
          }
        }
      ],
      "pages": {
        "catalog": "docs/detectors/smallFiles.html",
        "guide": "docs/user-guide/understanding-findings.html#plan"
      },
      "tuning": {
        "kind": "page",
        "anchor": "#bottleneck-small-files",
        "path": "docs/tuning-reference/bottleneck-small-files.html#bottleneck-small-files"
      },
      "gate": null
    }
  ]
}

get_finding_documentation call

{
  "tool": "get_finding_documentation",
  "arguments": {
    "type": "smallFiles"
  }
}

Its response, with each Markdown body replaced by its length

{
  "type": "smallFiles",
  "name": "Small Files",
  "detectionDoc": {
    "tag": "PLAN",
    "title": "Plan advisor",
    "content": "<7876 characters of Markdown>"
  },
  "tuningDoc": {
    "anchor": "#bottleneck-small-files",
    "title": "Small Files",
    "content": "<6064 characters of Markdown>"
  }
}

CI (CLI)

List this entry from the command line. The output below is a real run of the command. Budgets and exit codes are in the CI guide.

sparkforensics-analyze detectors --type smallFiles --format md
# Detectors (1)

## SQL plans

| Tag | Type | Scope | Fix | Gate | What it finds |
| --- | --- | --- | --- | --- | --- |
| PLAN | `smallFiles` | sql | config |  | A write produces many tiny files that slow every later read. |

Report only this finding type for a run with --type:

sparkforensics-analyze <event-log> --type smallFiles --impact critical,warning,info

It has no budget flag. Fail a build on a new one by comparing against a baseline with --fail-on-introduced.

Airflow

The operator has no budget parameter for it. Use fail_on_introduced with a baseline.

check_spark_job = SparkForensicsOperator(
    task_id="check_spark_job",
    log_source=...,
    backend=SubprocessAnalyzeHook(),
    baseline_log_source=...,
    fail_on_introduced="critical",
)

The operator works per run, and its summary counts findings per impact band. See the operator for its parameters.

How it is measured

Thresholds

Over 100 files averaging under 3 MiB.

smallFiles version 2

ThresholdDefault
minFiles100
maxAvgFileSizeMB3

Each rule's impact bands and fixed fallbacks are in the threshold tables.

Override a default per run with --thresholds; see Tuning detector thresholds.

Docs