What problem does it solve?
It helps teams prevent “mystery failures” in VTEX IO production by ensuring important errors are visible in logs/metrics and operational signals exist for diagnosing issues quickly and safely.
Core Features & Use Cases
- Structured, searchable logging: Use
ctx.vtex.logger with meaningful context (account, routeId, operation identifiers) while avoiding secrets and sensitive payloads.
- Integration-focused metrics: Add metrics to important VTEX client calls and downstream operations so latency, error rates, and throughput are observable over time.
- Operational readiness & rate-limit awareness: Improve failure visibility, reduce rate-limit risk using timeouts/backoff/caching, and validate that flows expose enough signals before and after release.
Use case example: When a backend route syncing orders intermittently fails due to downstream issues or rate limits, this skill guides adding sanitized logs and integration metrics at the call sites so on-call can determine whether failures are caused by timeouts, errors in specific integrations, or rate-limit pressure.
Quick Start
Apply the vtex-io-observability-and-ops skill to your VTEX IO routes or workers when you need better production diagnostics for failing integrations and rate-limit-sensitive calls.
