Skip to content

Implement planned topic: 0014-resource-tuning#215

Open
skill-temporal-developer-updater[bot] wants to merge 4 commits into
mainfrom
draft/0014-resource-tuning
Open

Implement planned topic: 0014-resource-tuning#215
skill-temporal-developer-updater[bot] wants to merge 4 commits into
mainfrom
draft/0014-resource-tuning

Conversation

@skill-temporal-developer-updater
Copy link
Copy Markdown
Contributor

Validation Report — resource-tuning (Go)

Branch: draft/0014-resource-tuning
Skill root: .
Reference file added: references/go/resource-tuning.md
Cross-link edits: references/go/go.md, references/go/advanced-features.md
Topic class: core Go SDK reference (not a third-party integration — Check 5 N/A)

Go / no-go

Check Verdict
1 — Citation audit PASS (41/41 citations resolve)
2 — Reverse-grep audit PASS (0 unexplained misses)
3 — Regression on known bugs PASS (no hits)
4 — Independent re-verification PASS (10/10 sampled claims match)
5 — Integration-layout audit N/A (not an integration topic)
6 — Tone and scope audit FINDING — one Pattern 4 (Public Preview admonition)

Overall verdict: MINOR FIXES. Factual content is grounded and accurate; one minor admonition is missing.

Check 1 findings

None. All 41 inline citations across the three docs files (worker-performance.mdx, worker-tuning-reference.mdx, worker-health.mdx) and the secondary source (sample-apps/go/features/worker_tuner/worker_tuner.go) resolve cleanly. The cited line ranges substantively support the authored claims, including the multi-source citations that combine docs lines with sample-app lines.

Check 2 findings

None unexplained. One token does not appear anywhere in the documentation tree:

  • go.temporal.io/sdk/contrib/resourcetuner — appears only in the authored file as a negative warning ("Don't import…"). The path is being called out as a wrong-import to prevent agent fabrication; the correct paths (go.temporal.io/sdk/worker, go.temporal.io/sdk/contrib/sysinfo) are both grounded in sample-apps/go/features/worker_tuner/worker_tuner.go:3-6. Acceptable as a defensive call-out, not a fabricated positive claim.

All other tokens (Go API symbols, struct fields, metric names, default values, package paths) appear at least once in the docs tree.

Check 3 findings

None. Universal regression patterns (the --profile, TEMPORAL_TLS_*_PATH, tcld service-account, --output text|jsonl, saas-api.tmprl.cloud:7233) are all absent. Topic-specific regressions are also absent:

  • worker.ResourceBasedTunerOptions in the resource-based tuner snippet (line 60-64) uses TargetMem / TargetCpu — correct.
  • worker.DefaultResourceControllerOptions() in the composite tuner snippet (line 86-89) uses MemTargetPercent / CpuTargetPercent — correct.
  • worker.NewCompositeTuner is called with the named-struct form worker.CompositeTunerOptions{...} including all four slot suppliers (line 110-115) — correct.
  • No positive recommendation to import contrib/resourcetuner or call resourcetuner.NewResourceBasedTuner(...).

The wrong-pattern strings (e.g. MemTargetPercent on tuner options) appear only inside "Don't do X" guidance and the "Common mistakes" section — these are correct negative bullets, not regressions.

Check 4 findings

None. 10 / 10 sampled claims match the docs:

# Claim location Docs source Match
1 line 13 (cgroups / containerized) worker-performance.mdx:66-70
2 line 41 (Namespace APS = 400) worker-tuning-reference.mdx:124
3 line 49 (fixed-size outperforms resource-based) worker-performance.mdx:397, 402-405
4 line 75 (ResourceBasedTunerOptions field names) worker-performance.mdx:494-497
5 line 128 (DefaultResourceControllerOptions field names) worker-performance.mdx:519-522
6 line 132 (DefaultActivityResourceBasedSlotSupplierOptions used for both activity AND local-activity) worker-performance.mdx:529, 533 ✓ (the docs really do reuse the activity defaults for the local-activity supplier — surprising but accurate)
7 line 139 (Tuner + MaxConcurrentXXXTask errors at init) worker-performance.mdx:84-86, 96-100, 224-229
8 line 141 (rampThrottle semantics) worker-performance.mdx:464-471
9 line 147 (Go SDK reports 0 for CPU/mem by default) worker-health.mdx:402-403
10 lines 170-173 (custom-supplier method contracts) worker-performance.mdx:448-453

Check 5 findings

N/A — references/integrations.md exists in the repo, but this topic is a core Go SDK reference (worker tuning, slot suppliers, SysInfoProvider), not a third-party integration. Layout audit does not apply.

Check 6 findings

Pattern 4 — Public Preview without admonition. references/go/resource-tuning.md lines 143-162 cover worker.Options.SysInfoProvider (host resource reporting in Worker heartbeats), sourced from docs/cloud/worker-health.mdx:400-417. That section is a subsection of "Manage Worker Heartbeating", which is marked as Public Preview at worker-health.mdx:376-380:

:::tip SUPPORT, STABILITY, and DEPENDENCY INFO

This feature is currently in [Public Preview](...).

:::

The authored file does not carry a [!NOTE] admonition flagging this. Either the SysInfoProvider section (lines 143-162) or the broader heartbeat-reporting context should carry the standard Public Preview admonition.

Per the verdict rubric, Pattern 4 findings alone are MINOR FIXES, not a re-authoring trigger.

No Pattern 1 (workaround disclosure) findings — every "Don't do X" bullet is paired with the supported alternative (e.g. line 27, 129, 134 in the reference file, and the "Common mistakes" section). No Pattern 2 / 3 findings worth calling out.

Statistics

  • Citation count: 41 distinct citations (mostly multi-source citations combining a sample-app line with a docs line)
  • Docs files audited: 3 (worker-performance.mdx, worker-tuning-reference.mdx, worker-health.mdx) + 1 sample app (sample-apps/go/features/worker_tuner/worker_tuner.go)
  • Tokens reverse-grepped: 43
  • Grep-misses: 1 (contrib/resourcetuner — defensive negative call-out, acceptable)
  • Sample size for Check 4: 10
  • Sample match rate: 10/10 = 100%
  • Regression pattern hits (universal + topic-specific): 0
  • Check 6 Pattern 1 findings: 0
  • Check 6 Pattern 4 findings: 1

Recommended follow-up

Single-commit minor fix: add a Public Preview admonition near line 143 of references/go/resource-tuning.md covering the worker.Options.SysInfoProvider / host resource reporting content. Suggested form (matching the standard admonition phrasing used elsewhere in the skill):

> [!NOTE]
> Worker Heartbeating (including host resource reporting via SysInfoProvider) is in Public Preview.

No re-authoring pass needed.

skill-sync[bot] and others added 4 commits May 14, 2026 18:46
Documents the worker-package tuner and slot-supplier APIs
(NewResourceBasedTuner, NewCompositeTuner, NewResourceController,
NewFixedSizeSlotSupplier, NewResourceBasedSlotSupplier) and the
contrib/sysinfo provider used for both resource-based tuning input
and host resource reporting in Worker heartbeats. Calls out that
these APIs no longer live under contrib/resourcetuner.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Adds a single bullet to the Reference Files list in
references/go/go.md so the new resource-tuning.md is discoverable
from the language entry point.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Adds a one-line pointer plus the load-bearing constraint that
worker.Options.Tuner and MaxConcurrentXXXTask options are mutually
exclusive. Keeps the existing fixed-options snippet intact.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@skill-temporal-developer-updater skill-temporal-developer-updater Bot requested a review from a team as a code owner May 14, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants