Skip to content

Detector catalog / Cost

CACHE

Caching opportunity

The same data is read more than once and is never cached.

Outcome
Cost
Scope
Judged on the whole run
Usual fix
A change in the job code
CI gate
No budget flag: gate it with --fail-on-introduced against a baseline

An example finding

Where you see it

Dashboard

The CACHE 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": "cachingOpportunity"
  }
}

Response

{
  "count": 1,
  "detectors": [
    {
      "type": "cachingOpportunity",
      "name": "caching opportunity",
      "tag": "CACHE",
      "tagSharedWith": [],
      "family": "cost",
      "pitch": "The same data is read more than once and is never cached.",
      "region": "action",
      "scope": "app",
      "fixEffort": "code",
      "thresholdSummary": "a dataset re-read from source multiple times with no cache/persist",
      "detectors": [
        {
          "detector": "cachingOpportunity",
          "version": 1,
          "thresholds": {
            "minExecutions": 2
          }
        }
      ],
      "pages": {
        "catalog": "docs/detectors/cachingOpportunity.html",
        "guide": "docs/user-guide/understanding-findings.html#cache"
      },
      "tuning": {
        "kind": "section",
        "anchor": "#bottleneck-caching-opportunity",
        "path": "docs/tuning-reference/bottleneck-utilization.html#bottleneck-caching-opportunity"
      },
      "gate": null
    }
  ]
}

get_finding_documentation call

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

Its response, with each Markdown body replaced by its length

{
  "type": "cachingOpportunity",
  "name": "Caching Opportunity",
  "detectionDoc": {
    "tag": "CACHE",
    "title": "Caching opportunity",
    "content": "<561 characters of Markdown>"
  },
  "tuningDoc": {
    "anchor": "#bottleneck-caching-opportunity",
    "title": "Executor Utilization",
    "content": "<11455 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 cachingOpportunity --format md
# Detectors (1)

## Cost

| Tag | Type | Scope | Fix | Gate | What it finds |
| --- | --- | --- | --- | --- | --- |
| CACHE | `cachingOpportunity` | app | code |  | The same data is read more than once and is never cached. |

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

sparkforensics-analyze <event-log> --type cachingOpportunity --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

A dataset re-read from source multiple times with no cache/persist.

cachingOpportunity version 1

ThresholdDefault
minExecutions2

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