Skills api-observability-setup-axiom-pino-sentry
Pino, Axiom, Sentry installation - one-time project setup for logging and error tracking with source maps upload
git clone https://github.com/agents-inc/skills
T=$(mktemp -d) && git clone --depth=1 https://github.com/agents-inc/skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/src/skills/api-observability-setup-axiom-pino-sentry" ~/.claude/skills/agents-inc-skills-api-observability-setup-axiom-pino-sentry-fdbe76 && rm -rf "$T"
src/skills/api-observability-setup-axiom-pino-sentry/SKILL.mdObservability Setup (Pino + Axiom + Sentry)
Quick Guide: One-time project setup for observability. Install
,pino,next-axiom. Configure Axiom dataset + Vercel integration. Set up Sentry DSN and config files. Wrap@sentry/nextjswithnext.config.tsthenwithAxiom. AddwithSentryConfigfor runtime-specific Sentry init. Source maps are uploaded automatically wheninstrumentation.tsis set in CI.SENTRY_AUTH_TOKEN
Detailed Resources:
- For code examples, see examples/ folder:
- examples/core.md - Dependencies, env vars, next.config.ts, instrumentation
- examples/sentry-config.md - Sentry configuration files (client, server, edge)
- examples/pino-logger.md - Pino logger setup with redaction
- examples/axiom-integration.md - Web Vitals and dashboard queries
- examples/ci-cd.md - GitHub Actions source maps upload
- examples/health-check.md - Health check endpoints
- For decision frameworks and anti-patterns, see reference.md
<critical_requirements>
CRITICAL: Before Using This Skill
All code must follow project conventions in CLAUDE.md (kebab-case, named exports, import ordering,
, named constants)import type
(You MUST create separate Axiom datasets for each environment - development, staging, production)
(You MUST configure all three Sentry config files -
, sentry.client.config.ts
, sentry.server.config.ts
)sentry.edge.config.ts
(You MUST add source maps upload to CI/CD - Sentry needs source maps for readable stack traces)
(You MUST install
as a devDependency only - never use in production)pino-pretty
</critical_requirements>
Auto-detection: pino, next-axiom, @sentry/nextjs, Axiom, Sentry, observability setup, logging setup, error tracking setup, source maps, sentry.client.config, sentry.server.config, sentry.edge.config, withAxiom, withSentryConfig
When to use:
- Setting up a new project that needs logging and error tracking
- Adding observability to an existing project without it
- Migrating from another logging/error tracking solution to Axiom + Sentry
When NOT to use:
- Adding new log statements to existing code (ongoing usage, not initial setup)
- Configuring alerts, monitors, or dashboards after initial setup
- Debugging production issues with existing observability
Key patterns covered:
- Dependency installation (Pino, next-axiom, @sentry/nextjs, pino-pretty)
- Environment variables template (
).env.example
withnext.config.ts
andwithAxiom()
wrapperswithSentryConfig()- Sentry configuration files (client, server, edge)
for Sentry initializationinstrumentation.ts- GitHub Actions for source maps upload
- Pino logger with development/production modes
- Health check endpoints
- Initial Axiom dashboard setup
<philosophy>
Philosophy
Observability is not optional for production apps. Without logging and error tracking, debugging production issues becomes guesswork. The Pino + Axiom + Sentry stack provides:
- Pino: Fast structured JSON logging (5x faster than Winston)
- Axiom: Unified logs, traces, and metrics with Vercel integration
- Sentry: Error tracking with source maps and release tracking
This skill covers one-time setup only. For ongoing usage patterns (log levels, structured fields, correlation IDs, alert configuration), use your observability usage skill.
</philosophy><patterns>
Core Patterns
Pattern 1: Dependency Installation
Install all observability packages with correct dependency types.
# Production dependencies npm install pino next-axiom @sentry/nextjs # Development dependencies (pretty printing for local dev) npm install -D pino-pretty
Why:
pino-pretty as devDependency prevents production bundle bloat (~500KB), all core packages are production dependencies for runtime use.
For detailed code examples with good/bad comparisons, see examples/core.md.
Pattern 2: Environment Variables Template
Create
.env.example with all required observability variables documented. Group by service, use comments to explain where to get each value, and maintain separate datasets per environment.
Key variables needed:
- Dataset name (e.g.,NEXT_PUBLIC_AXIOM_DATASET
,myapp-dev
)myapp-prod
- API token with ingest permissionNEXT_PUBLIC_AXIOM_TOKEN
- Sentry DSN from project settingsNEXT_PUBLIC_SENTRY_DSN
- For source maps upload in CISENTRY_AUTH_TOKEN
/SENTRY_ORG
- Organization and project slugsSENTRY_PROJECT
For complete template with all variables, see examples/core.md.
Pattern 3: next.config.ts with withAxiom and withSentryConfig
Wrap Next.js config with
withAxiom for logging integration, then withSentryConfig for source map handling.
Key configuration points:
wraps first (inner), Sentry wraps outerwithAxiom
suppresses source map upload logs locallysilent: !process.env.CI- Source maps are hidden by default in v9+ (no
needed)hideSourceMaps - Use
to clean up after uploadsourcemaps.deleteSourcemapsAfterUpload
import { withSentryConfig } from "@sentry/nextjs"; import { withAxiom } from "next-axiom"; const nextConfig = { /* your config */ }; export default withSentryConfig(withAxiom(nextConfig), { org: process.env.SENTRY_ORG, project: process.env.SENTRY_PROJECT, authToken: process.env.SENTRY_AUTH_TOKEN, silent: !process.env.CI, });
For complete configuration example, see examples/core.md.
Pattern 4: Sentry Configuration Files
Create all three Sentry config files for client, server, and edge runtimes.
Required files:
- Client-side with replay integrationsentry.client.config.ts
- Server-side with local variables capturesentry.server.config.ts
- Edge runtime with limited featuressentry.edge.config.ts
Key considerations:
- Use named constants for sample rates
- Environment-specific configuration (debug mode, sample rates)
- Filter expected errors with
beforeSend - v9+:
andhideSourceMaps
removed, source maps hidden by defaultenableTracing
For complete file templates, see examples/sentry-config.md.
Pattern 5: Instrumentation File
Create
instrumentation.ts for proper Sentry initialization in Next.js. Uses dynamic imports to load the correct config for each runtime.
import * as Sentry from "@sentry/nextjs"; export async function register() { if (process.env.NEXT_RUNTIME === "nodejs") { await import("./sentry.server.config"); } if (process.env.NEXT_RUNTIME === "edge") { await import("./sentry.edge.config"); } } // Next.js 15+ error handling hook export const onRequestError = Sentry.captureRequestError;
Why: Dynamic imports prevent loading wrong config for runtime,
onRequestError hook captures Server Component errors automatically (Next.js 15+).
Pattern 6: Web Vitals Component
Add
<AxiomWebVitals /> component to root layout for automatic Core Web Vitals (LCP, INP, CLS) reporting to Axiom.
Note: Web Vitals are only sent from production deployments, not local development.
For implementation example, see examples/axiom-integration.md.
Pattern 7: GitHub Actions Source Maps Upload
Configure CI/CD to upload source maps to Sentry on deployment. Key requirements:
in build environment enables automatic uploadSENTRY_AUTH_TOKEN- Use
for release creationgetsentry/action-release@v3 - Tie version to git SHA for release tracking
For complete workflow template, see examples/ci-cd.md.
Pattern 8: Health Check Endpoint
Add health check endpoints that integrate with your observability stack:
- Shallow check - Fast response for load balancer probes, includes version for Sentry release correlation
- Deep check - Verifies dependencies, logs failures via Pino for Axiom dashboard visibility
For implementation examples, see examples/health-check.md.
Pattern 9: Pino Logger Setup
Configure Pino with development/production modes:
- Development:
for human-readable outputpino-pretty - Production: JSON for log aggregation ingestion
- Base fields for context in every log
- Redaction of sensitive fields
For complete configuration, see examples/pino-logger.md.
Pattern 10: Axiom Dashboard Setup
After setting up, create initial dashboards in Axiom:
- Request volume per minute
- Error rate percentage
- Response time P95
- Top errors
- Web Vitals metrics
For APL query examples, see examples/axiom-integration.md.
</patterns><decision_framework>
Decision Framework
See reference.md for complete decision trees:
- Log Destinations: Where logs should go in each environment
- Sentry vs Axiom for Errors: Which system handles which error types
</decision_framework>
<red_flags>
RED FLAGS
See reference.md for complete list.
High Priority:
- Committing Axiom tokens or Sentry DSN to version control
- Using pino-pretty in production
- Missing source maps upload in CI
- Same Axiom dataset for all environments
Common Mistakes:
- Forgetting to wrap
withnext.config.tswithAxiom - Missing
instrumentation.ts - Using removed Sentry options (
,hideSourceMaps
,enableTracing
)disableServerWebpackPlugin - Hardcoding sample rates instead of named constants
</red_flags>
<critical_reminders>
CRITICAL REMINDERS
All code must follow project conventions in CLAUDE.md
(You MUST create separate Axiom datasets for each environment - development, staging, production)
(You MUST configure all three Sentry config files -
, sentry.client.config.ts
, sentry.server.config.ts
)sentry.edge.config.ts
(You MUST add source maps upload to CI/CD - Sentry needs source maps for readable stack traces)
(You MUST install
as a devDependency only - never use in production)pino-pretty
Failure to follow these rules will result in missing logs, unreadable errors, and security vulnerabilities.
</critical_reminders>