# vtex-io-observability-and-ops

Adds structured logs and client metrics to VTEX IO backend services, so production failures are easy to trace before and after a release.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1100 installs · ★ 46
- Author: vtex
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-observability-and-ops/SKILL.md
- Updated: 2026-10-14
- HTML: https://affpapa.org/en/nevibecode/skills/vtex-io-observability-and-ops

## What it does

This skill steers an agent toward VTEX IO backend services you can actually debug in production. When a route or worker catches an error, the agent logs it through `ctx.vtex.logger` at `error` level with identifiers like `orderId` and `account`, then rethrows. Plain `console.log` is out, because only the platform logger feeds VTEX's searchable log collection.

Calls to external APIs get a `metric` option with a name tied to the integration, like `partner-sync-catalog`, so latency and error counts show up per operation. For APIs with strict rate limits, the skill pairs short timeouts with retries that back off, plus caching for reads that repeat.

A bare `catch` that just returns counts as a bug here, and so does a log line carrying an auth header or raw request body. Browser-side monitoring is outside its scope.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-observability-and-ops -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/vtex-io-observability-and-ops/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/vtex-io-observability-and-ops/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-observability-and-ops -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/vtex-io-observability-and-ops/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-observability-and-ops -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/vtex-io-observability-and-ops/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install vtex/skills vtex-io-observability-and-ops
```

2. **Manually: put the files in place**
- File: `.github/skills/vtex-io-observability-and-ops/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-observability-and-ops -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-observability-and-ops
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/vtex-io-observability-and-ops/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill vtex-io-observability-and-ops -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/vtex/skills/tree/HEAD/skills/vtex-io-observability-and-ops/SKILL.md

## When to use it
- find routes and workers that swallow errors silently
- tag partner API calls with a named `metric`
- strip tokens, auth headers and raw bodies from log lines
- cut burst traffic to rate-limited APIs with caching and backoff retries
- review whether an on-call engineer could diagnose a flow before release

## Example prompts
- Review this VTEX IO service for production readiness: logging, metrics, error visibility
- Add a `metric` to every call in the partner API client and swap `console.log` for `ctx.vtex.logger`
- Errors in the catalog sync worker vanish. Make sure failures show up in the logs

## Similar
- [mcp-builder](https://affpapa.org/en/nevibecode/skills/mcp-builder.md) — skill · 130949 installs
- [claude-api](https://affpapa.org/en/nevibecode/skills/claude-api.md) — skill · 74198 installs
- [lark-im](https://affpapa.org/en/nevibecode/skills/lark-im.md) — skill · 472900 installs
- [lark-event](https://affpapa.org/en/nevibecode/skills/lark-event.md) — skill · 466800 installs
- [caveman-discover](https://affpapa.org/en/nevibecode/skills/caveman-discover.md) — skill · 104400 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs

From the same set: [vtex/skills](https://affpapa.org/en/nevibecode/by/vtex/skills.md) — 38 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md