function · performance
start_logging
Starts one bounded host-wide performance log owned by the calling package.
performance.start_logging(maximum_samples?) -> session_id- Stable ID
performance.start-logging- Owner
- app.ScriptPackageHost
- Authority
- host_lifecycle
- Timing
- immediate
- Availability
- Phase 14 package callbacks
- Side effects
- replaces the prior completed log and begins bounded frame sampling
- Determinism
- Host-created package identity and per-callback budgets.
- Introduced
- 1.0.0
Usage
Start one host-wide bounded logging session owned by the calling package. A new session replaces the prior completed log; an active log cannot be stolen or replaced.
Parameters
- maximum_samples: optional positive limit from 1 through 36000; defaults to 3600.
Returns
A monotonically increasing process-local logging session identity.
Cost
Reserves bounded sample storage once, then records one fixed-size sample per presented frame until stopped or full.
Fields
This symbol has no fields.
Errors
- None
Examples
local session_id = performance.start_logging(3600)API history
- 1.0.0: Package-controlled performance-log start added during Phase 15 closure.