Rp Telemetry
WixOfficialPublished by Wix
- Skill
- Tool integration
- Automation and integrations
- MIT
- Low risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
rp-telemetry is a specialized tool designed to capture comprehensive telemetry data during RePlatform migration runs. It operates as a background companion, recording observations about the migration process—such as stage transitions, API latency, user decisions, and pipeline defects—without interfering with the migration logic itself. The skill enforces strict data integrity rules, requiring objective observations rather than subjective diagnoses, and utilizes a centralized recorder to ensure consistent, schema-validated data collection. It manages the entire lifecycle of a run, from initial start and dimension tracking to final rollup and BI hand-off, ensuring that all telemetry is captured, persisted, and reported reliably.
What it does
- Records granular telemetry events including halts, errors, and pipeline performance metrics.
- Tracks run lifecycle stages, timings, and volumes for comprehensive migration analysis.
- Enforces strict schema validation for all recorded events to ensure data quality.
- Automatically handles session resumption, identity resolution, and BI push retries.
- Provides tools for metering API and model usage to identify performance bottlenecks.
- Generates deterministic run digests from session transcripts for post-run review.
When to use it
- At the very beginning of a RePlatform migration run to initialize telemetry tracking.
- Whenever a significant event, stage boundary, or user-facing halt occurs during a migration.
- When you need to capture performance metrics or API usage data for a specific migration stage.
- At the conclusion of a migration run to finalize the data rollup and report the final state.
- When you need to repair a failed BI push or rebuild a signal document from an archived journal.
Advantages
- Decouples telemetry collection from migration logic, preventing interference with core tasks.
- Ensures data consistency through automated schema validation and strict recording rules.
- Provides high-fidelity insights into migration health without requiring manual narration.
- Supports resilient data delivery with built-in retry and healing mechanisms for BI sinks.
- Standardizes metrics across different migration projects for better cross-run analysis.
Usage examples
- “Start the telemetry for a new migration run.”
- Initializes the telemetry session with project dimensions and begins tracking the run lifecycle.
- “Record that the discovery stage has finished.”
- Closes the discovery stage, stamps discovered entity types, and logs the stage outcome.
- “Meter the API usage for the current import stage.”
- Logs measured API latency, call counts, and retry statistics for the import process.
- “Finalize the migration run with the collected rollup data.”
- Closes the run, submits the final rollup to BI, and reports the status of the data hand-off.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/wix/rp-telemetry/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip rp-telemetry.zip -d .agents/skills
Documentation by Wix
rp-telemetry
Capture per-run telemetry that tells us what to improve in the skills and the underlying Wix tooling. This skill stays active alongside the migration skills for the entire run; the migration skills themselves are unchanged and know nothing about telemetry.
The one rule that governs everything you record
Observation, not diagnosis. Every field records what was observed — what happened, what was expected, what actually occurred, where, and how often. Never record a root cause, a fix, a recommendation, or a workaround-as-solution. There is deliberately no field for them; the schema rejects unknown fields. Root cause is derived later, at review time, by a reviewing agent with full context — not asserted by you in the moment.
Three discipline rules apply to every free-text field (what_happened, expected,
actual):
Types, not instances. Refer to entity types and classes, never specific client data.
entity_type: "product"— never a product's name, SKU, price, or body text.Secret-safe. No credentials, tokens, URLs, config values, or file contents — the recorder also runs a mechanical scrub as a last line of defense, but do not rely on it.
Short and structural. A sentence or two, max 400 chars. Prefer stating expected-vs-actual over narrating. The coded fields carry the structure.
No remediation narration. "The canonical lib was fixed and re-synced" is a fix story, not an observation — even when true (dev-mode backports). Record what was observed to work ("adding fieldsets=FULL returned the field; the lookup succeeded") and leave the repair to the execution log.
The recorder
For investigated mapping coverage, use lib/knowledge-observation.js event(...) and the
normal recorder. It requires findingClass (missing-knowledge, missing-writer,
target-limitation, source-ambiguity or conflicting-knowledge), public targetRef/operation,
toolkitVersion, outcome (resolved-mapping, deferred-field, deferred-record or verified-repair),
verificationLevel and affectedCount (measured integer or null). Record successful novel
mappings as well as unresolved work. Only verified read-back supports verified-repair.
The validator admits registered public identifiers; unknown operations use unregistered.
It rejects arbitrary extra keys. Never pass a raw custom key, source value or customer ID.
The recorder owns JSON in actual/BI actualSkill; do not combine this payload with an
independent actual. Occurrences, affected observations and distinct runs are different counts;
overlapping decisions do not establish a distinct-record total. Existing offline/disabled BI
delivery and replay apply; local persistence is not a claim of warehouse ingestion.
All telemetry is persisted through the bundled recorder — never hand-write or edit
run-telemetry.json or telemetry/ files. Run it from this resource directory
(see CONVENTIONS.md), pointing at the active migration project:
node scripts/rp-telemetry.js <command> [...] --project <abs path to migrations/<project>>The recorder owns everything mechanical: schema validation (it rejects invalid enums and
unknown fields — fix and retry, never guess around it), timestamps, per-class event
folding, the run/attempt/session resume model, the privacy scrub, and the well-formedness
gate at finalize. It prints one JSON result per call; {"ok":false,...} lists exactly
what to fix.
| Call | When |
|---|---|
start '<dims-json>' | At run begin — before any other pipeline step. Resumes an unfinalized run automatically. |
dims '<dims-json>' | Whenever a dimension becomes known mid-run (platform version and extensions after discovery, site_id after provisioning). |
stage start <stage> / stage end <stage> --outcome <outcome> | At every stage boundary. Outcomes: passed, halted, failed, skipped. passed is refused for codegen and setup_discovery while that stage's llm-handoff.json has needsLlm: true or open blockers/unresolved/openItems; record halted instead. Never pre-fill the outcome in a subagent brief. |
meter [--api-ms N --model-ms N --script-ms N --input-tokens N …] | Measured latency/token counts for a stage. Call it whenever you have real numbers; see "Metering" below. |
wait start [--halt <subtype> --skill <s> [--what '<text>']] / wait end | The moment the run halts for the user, and the moment it resumes. This is how user latency stays out of active_ms — never estimate elapsed time yourself. Pass --halt for a needs-user halt and the recorder emits the paired halt_needs_user event for you. |
record '<event-json>' | The moment something observable happens (taxonomy below). |
digest --transcript <path> [--offline] | Just before finalize — a deterministic parse of this run's Claude Code session transcript (cost, turn counts, tool failures, retry loops, hook errors). Never authored by you; --offline re-runs it later against a checkpointed or local transcript for a run that died before calling it. |
finalize '<rollup-json>' | When the run reaches a terminal state. |
rebuild [--attempt <n>] [--push] | Only on request, to re-assemble a past run's signal document from its archived journal after a recorder fix — never during a run. --push re-emits the rebuilt run to the BI sink (backfill after an outage; idempotent — the reviewer dedupes at query time). |
status | To orient after a resume. |
Preflight reads that same status and reports whether a journal exists — active,
absent, finalized_only or unreadable — as a non-blocking line in its result. When
nothing is recording, the preflight script then calls start itself (moving an
unreplayable journal aside first) and adds a recovery field to that line. This is a
safety net, not the main path: start at run begin below stays required. A
recovery: failed reading falls under the "never mention" rule below — it is recorded for
the RePlatform team in the preflight result and progress log, never told to the person
running the migration, and never blocks the run.
Run lifecycle
startas the first telemetry act of the run, with whatever dimensions are already known:node scripts/rp-telemetry.js start '{"source_platform":"wordpress", "source_site_url":"https://client-site.example","source_acquisition":"public_storefront", "delivery_mode":"management","destination_strategy":"new_site", "runtime_env":{"agent_runtime":"claude-code","model":"<model id>"}}' --project <dir>starton a project with an unfinalized run resumes it (same run, same attempt, one more session) and closes any open wait interval.startafter a finalized run opens the next attempt. Never try to manage run identity yourself.Always
starton resume, even mid-stage. Besides the session accounting, the resume is a BI heal point: the recorder re-pushes everything the previous session's transport may have lost (push failures are journaled, then healed at the next opportunity — a halted run may never reach finalize, so skipping the resumestartcan strand the run's tail in the local journal).statusshowsbi_backlog: truewhen unpushed rows are pending.A safety net backs this up, and it does not replace your
start: the start of areplatform run/resumesupervisor process, and the orchestration route script after at least 15 minutes of journal silence, record the resumed session themselves on an open recording (tagged with atrigger). Astartwithin a minute of such an automatic session, or at any point during the live supervisor run that opened it, joins that session instead of opening another — it still records the dimensions you pass. The 15-minute gap is a heuristic about sittings, not a detected session. A failed or skipped automatic resume falls under the "never mention" rule below: it goes only to the progress log or the supervisor's run record.source_acquisitionis an open set of class tokens, but reuse an established one (admin_api,public_storefront,public_content,file_export) rather than minting a synonym — cross-run folding depends on stable tokens.Skills provenance is auto-stamped — you don't pass it. At
startthe recorder stamps two identifiers onto the run so every record can be traced back to the skills that produced it:skills_version— the bundle's semver release label (fromVERSION). Coarse and hand-bumped by design; it is the group-by/order-by key that binds issues to a release line ("all issues on 1.2.x", "regressed since 1.1.0").skills_commit— the exact source commit the bundle was built from: the precise vendored snapshot within a release. Many commits ship under one hand-bumpedskills_version, so a run reporting1.0.0is otherwise unattributable to the change that produced its issue. The recorder resolves it, in order of authority, from thesourceCommitstamped into.publish-manifest.jsonat publish time (the only source that works in a partner runtime, and the only correct one once the bundle is vendored intowix/skills), else a dev-modegit rev-parse --short HEADof the source checkout, elsenull.
Both may be overridden by passing
skills_version/skills_commitin thestartdims (a runtime with better provenance than the recorder can infer), but normally you leave them to auto-resolve.Operator identity is auto-stamped too — you don't pass it, and you must not invent it. At
startthe recorder resolveswix_user_id(the operator's Wix user GUID) from the Wix CLI's login artifact,~/.wix/auth/account.json. A run normally starts before the destination stage, where the CLI login is created, so "no login yet" is the usual case, not an edge.A run that starts without the id is not silent. The recorder makes it a placeholder subject, a random GUID for that run alone, saves it in the run's journal, and sends the run's records to BI under it from the first minute. Those run rows carry no operator id, no source site address, no project name and no destination site id. It is random and nothing else: never derived from anything, never shared by two runs, never the all-zeros GUID (BI did not ingest that one).
Every later recorder command (
record,stage,meter,source-read,dims,wait,digest,finalize,starton resume,meter-from-audit.js) and every orchestration route call (each stage boundary) re-check the login, andwix-destination.js ensurehands over the Wix account it has confirmed with the operator (never an unconfirmed or switched login). Once an id resolves, the identity is journaled as adimsrecord and the whole run is sent again under the operator's id with the operator, site address, project name and destination site id on its run rows; nothing is sent under the placeholder after that. Nobody has to call anything. Right after you see the operator's Wix CLI login confirmed you may runrp-telemetry.js identityto adopt it at once; it also re-sends anything BI has not confirmed and reportsadoptedandbi_backlog; with identity already known and nothing pending it does nothing.A run that never sees a login completes under its placeholder with no operator id; its health keeps
operator_identity_unresolved, and nothing is recorded as a failed send. The local record is authoritative either way.You may pass
wix_user_idexplicitly in thestartdims and it wins over resolution, but only when the runtime genuinely knows better (a hosted runner that authenticated the operator itself). Never pass a GUID you guessed, copied from another run, or read off a site — a wrong identity misattributes the run to a real person and is worse than a placeholder.Never mention any of this to the person running the migration. Telemetry health is our signal, not theirs: it says nothing about whether their migration worked, and an unattributed run is complete and correct. It is read from BI and the local rollup, not narrated in a completion report. The same goes for push failures and
bi_pushcounts — they are yours to repair and never the operator's to hear about.When a result carries
telemetry_attention, repair it yourself and keep going. Everyrp-telemetry.jsresult adds that field while something is wrong and omits it otherwise.issuessays what:bi_backlog(rows BI has not confirmed) oridentity_not_adopted(a Wix login exists but the run has no operator id yet);last_failureis a short code for the last failed send;repairis the command.finalizeandrebuild --pushreportbi_push_failedthe same way, withrebuild --pushas the repair. A run with no login yet and sending switched off on purpose are not trouble and never raise it.The first time you see it in a run, run the
repaircommand once and read the result that follows. It re-checks the login and re-sends what BI has not confirmed. The field is gone when it worked. Do not repeat the repair at later stage boundaries.Carry on with the run either way. Never pause, never stop, never wait for the repair: telemetry must not hold up the migration.
Before you
finalize, if the last result you saw still carried the field, record one event withevent_type: pipeline_defect,subtype: record_defect, naming theissuesinwhat_happened, then finalize. The event is sent with the backlog as soon as BI is reachable again. Iffinalizereportsbi_push_failed, runrebuild --pushonce. That is all: at most three telemetry commands in a run, and none when nothing went wrong.Do not ask the operator anything, do not mention telemetry to them, and do not pick a repair that needs them (a missing login is not something to ask for).
The route and destination scripts print nothing about telemetry: what they could not send shows up in the next
rp-telemetry.jsresult, and every stage boundary runs one.
Stage boundaries as the pipeline moves. Map orchestrator steps to stages like this:
Stage Covers configEverything before discovery: project resolution, config files, up-front input collection discoverySource discovery ( rp-discovery+ source adapter)mcp_gateThe Wix MCP prerequisite gate between discovery and mapping mappingrp-mapperproducing the mapping planmapping_reviewThe mapping review checkpoint (user-facing) setup_discoveryrp-setup-discoverycodegenrp-import-codegenapproval_gateThe execution-plan approval gate (user-facing) setup_provisioningSite creation, app installs, collections — rp-execute-setupstorefront_buildThe website-modewix-headlessbuild + release;skippedinmanagementmodeextractSource extraction to disk, before any write ( rp-execute-import)importThe import writes ( rp-execute-import)finishVerification spot-checks, completion reporting, handoff Stages bind to when the work actually runs, not to their canonical order. If the orchestration runs extraction early (e.g. extract + dry-run before the approval gate, inside the codegen phase), close the open stage, bracket the extraction in its own
extractstage, then reopen — a stage may be entered more than once, and itsactive_mssums the entries. Booking a real extraction intocodegen(and leavingextractas a milliseconds-long token stage) is exactly the mis-attribution theextractstage exists to prevent.When the
discoverystage ends, always stamp what it learned:dims '{"source_platform_version":"...","source_extensions":["..."], "discovered_entity_types":["post","product","event"]}'— pass[]explicitly when discovery found no extensions (or, improbably, no entity types); a null left behind is flagged intelemetry_healthassource_extensions_null_after_discovery/discovered_entity_types_null_after_discovery.discovered_entity_typeslists every source entity class discovery found in use — including classes with no Wix target; it is what finalize cross-checks thevolumesrows against, so the "what we couldn't import" demand signal cannot be silently under-reported.wait start/wait endaround every needs-user halt: credential requests, the mapping-review checkpoint, the approval gate, any halt-to-needs-user. Pass the halt class on the same call —wait start --halt missing_input --skill rp-mapper --what "run halted at the mapping-review checkpoint awaiting approval"— and the recorder emits the pairedhalt_needs_userevent mechanically; a stalled wait with no halt event in its stage is flagged intelemetry_health(wait_without_halt_event:<stage>). If the session is about to end on a halt, leave the wait open — the resume'sstartcloses it, so overnight user latency lands inwaiting_mswhere it belongs. If you resume real work while a wait is open (e.g. investigating something before the user has answered),wait endfirst andwait startagain when you go back to waiting — active work must never be booked as waiting.recordevents as they happen (next section). Record in the moment, not retrospectively — improvisation and halts are only reliably knowable when they occur.digest --transcript <path to this session's CC transcript>just beforefinalize. It parses the Claude Code session transcript, deterministically — no model, no judgment, nothing for you to say. If it fails, carry on tofinalizeanyway; telemetry never blocks a migration.finalizeonce, at a terminal state, with the rollup:node scripts/rp-telemetry.js finalize '{"terminal_state":"completed", "volumes":[{"entity_type":"product","target":"native","target_surface":"stores/v3", "discovered":142,"planned":142,"attempted":142,"succeeded":139,"failed":3, "skipped":0,"already_imported":0}], "verification":[{"subject":"product","method":"query_back","checked":10,"passed":10,"failed":0}], "operator_acceptance":"accepted"}' --project <dir>volumescome from the execution artifacts (manifest, audit log, crosswalk):plannedandtarget/target_surfacefrom the approved plan;already_importedis crosswalk-skipped scope from a prior attempt — never fold it intoskipped.Include a volume row for every entity type discovery found in use — including types excluded by user decision or with no clean Wix target (
discovered: N, skipped: N,target: nonewhere no target exists,planned0 or null). "What we cannot or chose not to import" must be signal-layer arithmetic, never an evidence dig — rows only for imported types silently erase the excluded half of the approved plan. This is enforced mechanically: on a completed run, any class stamped indiscovered_entity_typeswith no volume row is flaggedvolume_row_missing:<type>intelemetry_health.verificationmakes the finish step's spot-checks countable.checked: 0is an honest "written but unverified" — report it rather than papering over it.Do not finalize a halt you expect the user to resume — leave the run unfinalized with the wait open. Finalize with
halted_needs_useronly when the run is genuinely being closed out in a stalled state. A user who declines the plan isabandoned_by_user(plus auser_decisionevent withsubtype: declined), neverhalted_needs_userorfailed.There is no
blockedterminal state;terminal_stateis a registered BI enum. A run stopped on a blocker (run.jsonstatus: blocked) records the stop as ahalt_needs_userevent —wait start --halt <subtype>— not as auser_decision. It stays unfinalized while a resume is expected. If it is closed out on the blocker, finalizehalted_needs_userwithstopped_at_stageset. Useabandoned_by_useronly when the user declines to continue. Route checks, refusedruncalls andanswer --continuekeep an explicit hold's wait open. They do not count as execution sessions. Afterreplatform resumeor a transition with--status running, the next execution entry resumes telemetry normally.Check the returned
bi_push. If it reportsfailed > 0orskipped > 0, the run (or part of it) did not reach the central BI record: retry once withrebuild --push, and if it still fails, tell the operator in the completion report that the run exists only locally — never let a run silently vanish from the shared record.skipped > 0meansRP_TELEMETRY_BI_DISABLEDwas set during the session; on a real migration run that env var must never be set. A cleanbi_pushresult (failed: 0,skipped: 0) means the rows were handed to frog, not that they have arrived in BI — perbi-sink.js's own transport code, a 2xx is not an ingestion receipt; only a Trino read-back proves arrival, and no such read-back is available from inside a run. Reportbi_pushsuccess as "handed off," never as "confirmed in BI."Reading a push failure. A failed push's detail names its cause:
network_error:<CODE>(for exampleENOTFOUND: the machine cannot resolve the host and probably needs a proxy;ECONNREFUSED: nothing is listening at the proxy address) orproxy_connect_<status>(the proxy refused the tunnel, for example407for missing credentials). The push followsHTTPS_PROXY/NO_PROXYfrom the environment by itself, on every supported Node, so the operator sets nothing at launch. The proxy must be anhttp://orhttps://proxy; asocksproxy is not supported and the push then goes direct. The detail never contains the proxy address.
Metering — splitting active_ms into where the time actually went
active_ms alone cannot locate a bottleneck: it is wall-clock between two stage boundaries, fusing
model reasoning + subprocess execution + remote API latency + defect-repair time into one
number. meter splits it, and cost is derived from the token counts.
# a generated script reporting its own measured work
node scripts/rp-telemetry.js meter --api-ms 250000 --api-calls 73 --api-retries 2 --script-ms 1200 --project <dir>
# the agent runtime reporting its own usage for the stage it just finished
node scripts/rp-telemetry.js meter --model-ms 42000 --input-tokens 8000 --output-tokens 1500 --cache-read-tokens 120000 --project <dir>Derive the API half mechanically — do not hand-count it. After a generated import runs:
node scripts/meter-from-audit.js --project <migration dir> --stage import # --dry-run to previewIt reads logs/import-audit.ndjson and emits measured api_ms / api_calls / api_retries.
It exists because a bulk write logs one audit row per item, each carrying the batch's total
latency — summing rows multiplies one call's latency by its item count, which can
report several times more API time than the stage existed for. The helper
collapses rows per distinct (runId, endpoint, batch, latencyMs), so a batch counts once while
genuinely separate calls each count.
Fields: durations model_ms / api_ms / script_ms; counts input_tokens, output_tokens,
cache_read_tokens, cache_write_tokens, api_calls, api_retries. Defaults to the open stage;
--stage <stage> targets another. Repeated calls accumulate, so each script invocation and each
stage re-entry reports independently.
Rules that keep the numbers trustworthy:
Measure, never estimate. Every field is a number something actually observed — a script's own elapsed time, an audit log's summed
latencyMs, the runtime's reported usage. If you do not have a measurement, omit the field; the gap is reported asunattributed_msand flagged, which is far more useful than a guess.Do not meter the same interval twice. Meters sum, so re-reporting a stage's API time after a resume double-counts it. The recorder flags
stage_over_attributed:<stage>when attributed time exceeds elapsed time, becauseunattributed_msclamps at zero and would otherwise hide it.Cost is derived, never recorded. Pass
model_pricing_snapshotin thestartdims ({ "<model>": { "input_per_mtok": 15, "output_per_mtok": 75, "cache_read_per_mtok": 1.5 } }) and the rollup computescost.estimated_cost_usd. A stored dollar figure silently goes wrong when list prices change; tokens plus a dated snapshot stay recomputable. Without a snapshot, cost isnullwithcost_basis: "no_pricing_snapshot"— never a fabricated number.contained_recoveryis derived, not self-reported. Anyerrororpipeline_defectin a stage marks it, because a stage that spent its time debugging is the one an agent is least likely to remember to flag.timing.stages_with_recoverylists them, so a clean run and a thrash are distinguishable instead of both reading as "this is what the stage costs".
The rollup's timing.agentic_ms vs timing.deterministic_ms (and agentic_share) is the number
that shows whether moving work into deterministic code is paying off. agentic_share is null when
nothing was metered rather than 0, which would falsely read as a fully deterministic run.
Source key/value reads — the one capability that widened what we can read
The WordPress bridge can read key/value ("EAV") tables like postmeta, key-scoped.
That is the largest widening of source-read reach this pipeline has taken, so it is counted.
node scripts/rp-telemetry.js source-read --discovery-queries 1 --discovery-table postmeta --redacted-values 0 --project <dir>
node scripts/rp-telemetry.js source-read --scoped-queries 6 --scoped-table postmeta --redacted-values 2 --project <dir>
node scripts/rp-telemetry.js source-read --tier-refusals 1 --project <dir>Counts accumulate across calls, so report per batch rather than holding a running total.
wix-wp-plugin-v2-client.js derives the per-read counts for you and hands them to its
onSourceRead hook — use that rather than counting at a call site, because the call site that
forgets is what makes a run's total quietly wrong.
redacted_values is the field worth watching across runs. The other three describe how one
migration read one site. A non-zero redaction total means a source site keeps a credential in a
column nobody expected, which is a fleet-level signal no single run can see. tier_refusals has
to be reported by the caller rather than inferred, because the plugin answers a tier violation
with the same 400 as a nonexistent column — deliberately, so a refusal never discloses which
column holds the values.
Key names are never telemetry. The run's own artifacts hold those. discovery_tables and
scoped_tables carry bare WordPress table names (postmeta), which are structural, not customer
data; the validator rejects anything that is not ^[A-Za-z0-9_]+$, and rejects a pinned_keys
field outright as unknown. Nothing here should ever be able to carry a value.
Collecting operator_acceptance
At the finish handoff, ask the operator one plain question: does the migrated result look
right to them — accepted, rework_needed, or rejected? Record their answer in
finalize. If the run never reaches finish or they do not answer, it stays unknown.
This is the only field separating "completed and good" from "completed and unusable" —
ask it, but never pressure or interpret; their verdict as given, coarse by design.
Event taxonomy — when to record what
Events are folded per problem class by the recorder (same type + stage + entity type +
API surfaces + app + error code + subtype fold into one event with a count), so record
every occurrence class once and pass count when you observed many at once — e.g. a
generated script reporting 4,000 identical write failures is one record call with
"count": 4000. Distinct problems are distinct subtypes or error codes, not bigger
counts.
Every event needs: event_type, stage (defaults to the open stage), skill (the
active rp-* resource, e.g. "rp-mapper"), severity (blocking | degraded |
cosmetic | info), and what_happened. Add entity_type, wix_api_surface (e.g.
stores/v3), source_api_surface (endpoint class like wp/v2/posts — never a URL),
wix_app_id, and error_code whenever they apply — they are the cross-run group-by keys.
halt_needs_user— the run stopped at a defined needs-user state. Prefer the mechanical form —wait start --halt <subtype> …emits it for you (lifecycle step 3); record it yourself only for a halt with no wait interval.subtype:missing_input(missing/invalid required input or credential) |manual_only(genuinely manual step, no API) |systemic_failure(systemic failure or data-loss risk).manual_action_required— the execution plan flagged something as "can't be done, needs manual action" (e.g. a storage-plan upgrade), whether or not the run halted on it.subtype:plan_or_billing|dashboard_only|external_dependency|other.error— an API or script error, including recovered ones. Carryerror_code(required — it is the discriminator; no subtype),retry_count, andrecovered. Record one event per resolved retry chain, after the outcome is known — the finalrecovered, the totalretry_count— never one call per attempt (per-attempt calls fold into one class, and the failing first attempt's fields would bury the recovery). When recovery required a change (not just a retry),actualmust record what change made it succeed, as an observation: "retried with the description as plain text instead of HTML; the write succeeded" — never "the fix is X". If that change deviated from the documented path — including a change to a planned command or value, like simplifying an input the plan specified — also emit a pairedskill_coverage_gap(undocumented_workaround).fidelity_loss— the migration technically proceeded but lost something.subtype:dropped_field|unverified_enum|no_target(source entity with no clean Wix target) |coerced_value. For a loss triggered by specific records, inline the offending record's sanitized shape inobserved_shapes— field names and types and which field was dropped/coerced, never values.api_gap— a missing or insufficient Wix API capability.subtype:missing_api|missing_capability(API exists but cannot express the operation) |internal_only(capability exists but is not publicly exposed) |other. Carrywix_api_surface(required) anderror_code— that signature is matched centrally across runs. Never write to any backlog file; the event is the whole per-run obligation.skill_coverage_gap— the standing self-report, and the highest-value signal for improving the skills. Whenever you act beyond what the active skill explicitly told you to do — you guess a value, work around a missing instruction, resolve an ambiguity by judgment, or handle a case the skill does not cover — record it at that moment.subtype:guessed_value|undocumented_workaround|ambiguous_instruction|path_not_covered. Describe the situation and the action taken as an observation: "skill did not specify which enum value maps to X, so a value was chosen to proceed" — never "the skill should add Y". If you are unsure whether something counts as improvisation, it does — record it.user_decision— the user's answer at every defined checkpoint or fork: the mapping-review checkpoint, the approval gate, and intake forks (comments anonymization, delivery mode, media reachability, …).subtype:accepted|declined|deferred|amended;decision_point(required) names the fork, e.g.mapping_review,approval_gate,comments_anonymization. Record the decision, not the user's reasoning verbatim. Anamendedacceptance whose change exposed a mapping problem additionally surfaces that problem asfidelity_lossorskill_coverage_gap. Adeclinedat a terminal checkpoint pairs withterminal_state: abandoned_by_user.pipeline_defect— our own migration machinery misbehaved: not a Wix API error, not a source failure, not your improvisation.subtype:state_inconsistency(two pipeline state artifacts disagree) |ordering_violation(a step ran before its prerequisite's output existed) |record_defect(a pipeline record/log is malformed or misleading as evidence) |other. Name the artifacts and their states inwhat_happened— names and states, never contents.source_plugin_coverage— which of the source site's plugins we could not resolve, plus one run-level summary. Record after discovery writesdiscovery/plugin-coverage.json.Record one event per unresolved item only. The unresolved set is: every
pendingrow (includingreason: cannot-telland unread candidate namespaces), everyrequires-developmentrow, and every row carryingblocked[]entries (auser-file/credential/surface-changedblocker, declined or not). These are the whole point of this event type — they are the only signal that says which plugin profile to write next, and without them that ordering is guesswork.Do not emit a per-row event for anything already resolved:
migration-plannedrows withconfidence: confirmed, orno-need-to-migraterows withbasis: listorbasis: decision(a human already signed that verdict). On a 55-plugin store that would be ~29 events restating a checked-in list — telemetry with no information content, which makes the real backlog harder to see, not easier. (Amigration-plannedorno-need-to-migraterow that automation derived —confidence: proposed/basis: proposed— is reported throughskill_coverage_gap(guessed_value), not here.)Emit exactly one aggregate event per run carrying the distribution: plugins installed, counts by the four statuses (and by
via/confidencefor planned rows), blocked counts by kind, and whether the plugin list was available. That preserves the cross-run view of how coverage is trending without one event per plugin.Per-event fields:
subtypeis the row's status (pending|requires_development) orblockedfor a blocker entry (then also carry the blockerkind); carry the plugin slug and version, the capability, the read channel, whether the row wasrecognized, andsource_api_surfaceas the endpoint class. Slug and version are required — without them a cross-run view cannot tell which plugin caused what. Plugin slugs and versions are software identifiers, not client data; still never record site URLs or record contents.A
requires-developmentrow additionally pairs withapi_gap, and a lossyvia: cmsrow withfidelity_loss— this event reports distribution and backlog, never the gap itself.
evidence_refs — rare, not routine
Author every event to be self-sufficient: coded fields + bounded free text +
observed_shapes should let a reviewer triage it without opening any artifact. Add
evidence_refs ({"artifact":"execution-log.md","locator":"## Import"}) only for the
exceptional event whose signal genuinely cannot carry the full observation. Use
project-root-relative paths and prefer section headings as locators (line ranges break
when files regenerate). Never reference secret-bearing config files.
What never to do
Never hand-write, edit, or re-read
run-telemetry.jsonortelemetry/files — the recorder appends; you only call it.Never record client data values, names, URLs beyond the recorded source origin, or secrets — in any field, including shapes and locators. For a credential-bearing source surface such as a payment gateway's configuration, telemetry may carry the field name and its state (
present/blank/absent) and nothing else: never the value, never a prefix of it, never its length, never a hash. A length narrows a brute force and a hash confirms a guess, so neither is a safe substitute for the value.Never record a fix, root cause, or recommendation — observations only.
Never estimate durations — timing comes from
stage/waitboundary calls.Never skip a rejected call: fix the listed fields and retry. Rejections are counted against telemetry health either way.
Never create or update improvement/feature-request backlog files during a run — those are maintained centrally from many runs' telemetry, not per run.
Never delete or trim project artifacts for telemetry reasons — capture is a non-destructive view; size is not a reason to drop anything.
Files
- ATTRIBUTION.mdAdded by AutoGineer836 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md37.3 KiB
- lib/bi-sink.jsScript15.8 KiB
- lib/knowledge-observation.jsScript3.0 KiB
- lib/telemetry-recorder.jsScript138.8 KiB
- lib/transcript-digest.jsScript11.4 KiB
- scripts/meter-from-audit.jsScript3.6 KiB
- scripts/rp-telemetry.jsScript11.6 KiB
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
What our scanner noticed· Low risk
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Wix
- Publisher
- Wix (Official)
- Source
- wix/skills · skills/wix-replatform/resources/rp-telemetry · commit d168bc2
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Wix.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download rp-telemetry.zip