Skip to content

operations.md

Latest commit

 

History

History
78 lines (57 loc) · 3.01 KB

operations.md

File metadata and controls

78 lines (57 loc) · 3.01 KB

Operations and Deployment

Production Targets

  • Web app: static hosting on Vercel (web/dist)
  • CLI package: PyPI publish workflow (.github/workflows/publish.yml, OIDC trusted publishing)
  • Container image: GHCR multi-arch publish (linux/amd64, linux/arm64)

Web Deployment (Vercel)

  1. Connect the repository in Vercel.
  2. Build command: npm run build
  3. Output directory: web/dist
  4. Add environment variables:
    • VITE_SENTRY_DSN (optional; only used after user opt-in)
    • VITE_APP_RELEASE (recommended, e.g. commit SHA)
  5. Verify custom headers from vercel.json are applied after deploy.

Observability

Sentry setup

  • Configure VITE_SENTRY_DSN in each environment if you want opt-in diagnostics.
  • Set VITE_APP_RELEASE during builds to correlate errors with deploys.
  • Sentry captures:
    • unhandled runtime errors and rejections
    • page/module errors from guarded operations
    • selected performance telemetry (web-vitals + custom performance measures)

Recommended alerting

  • Create alerts for:
    • spike in Unhandled error events
    • spike in worker parse failures (module extra fields)
    • regression in web-vitals (web-vital:* metric messages)

Security and Supply Chain

  • CI actions are SHA-pinned.
  • Dependency review runs on pull requests.
  • Scheduled dependency audits run weekly for npm and pip.
  • Weekly override staleness check flags npm overrides that can be removed (npm run check:overrides; see ADR-001).
  • Docker image publish includes Trivy scan for HIGH/CRITICAL vulnerabilities.

CLI Environment Variables

Variable Default Description
LINKEDIN_ANALYZER_DATA_DIR data Base directory for input/output file paths
LOG_LEVEL INFO Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
LOG_FORMAT text Log output format — text for human-readable, json for structured JSON

Structured JSON logging

Set LOG_FORMAT=json (or pass --log-format json) to emit one JSON object per log line:

{
  "timestamp": "2026-03-05 12:00:00,000",
  "level": "INFO",
  "logger": "linkedin_analyzer",
  "message": "Processing Shares..."
}

This is recommended for production/container deployments where logs are ingested by a log aggregator.

One-Time External Setup

  • Configure PyPI trusted publishing for this repository (OIDC) so publish.yml can publish without PYPI_API_TOKEN.

Incident Triage Checklist

  1. Confirm scope and blast radius from Sentry events.
  2. Correlate to release via release tag (VITE_APP_RELEASE).
  3. Reproduce locally with same fixture/data shape when possible.
  4. Add regression tests before shipping fix.
  5. Backfill docs if behavior/runbook changed.