Examples Runnable examples, instrumentation guides, recipes, and migration paths.
Use this page to pick the right starting point. Runnable examples are things you can clone, scaffold, or run locally. Reference examples are docs and snippets to copy into an existing app.
Goal Start here Type First run from a fresh checkout Getting started Guide Run everything from one local image Dockerfile.local via pnpm local:image && pnpm local:runRunnable image Try obs-unified with realistic traffic demo/Runnable demo Scaffold a new React + Hono app obs-unified create, choose React + Vite + HonoRunnable template Add obs-unified to an existing React + Hono app React + Hono walkthrough Walkthrough Add obs-unified to an existing Python Flask app Python Flask walkthrough Walkthrough Add browser analytics only Analytics SDK Reference Add TypeScript backend telemetry Telemetry SDK Reference Instrument Python, JVM, or .NET Language recipes Recipes
Example What it shows Run / entry point Dockerfile.localAll-in-one local image with Postgres, collector, dashboard, file blob storage, and seed data. pnpm local:image && pnpm local:runpackages/cli/templates/react-vite/React + Vite frontend, Hono Node API, AnalyticsProvider, backend spans, and click-to-trace propagation. obs-unified create my-app, choose React + Vite + Honopackages/cli/templates/vanilla-ts/Browser-only Vite + TypeScript analytics. obs-unified create my-app, choose Vanilla TypeScriptpackages/cli/templates/hono-workers/Hono on Cloudflare Workers with backend telemetry wiring. obs-unified create my-api, choose Hono on Workersapps/obs-demo/AI calls, RAG, tool calls, session tracking, and evaluation scenarios. pnpm dev, then curl http://127.0.0.1:8787/api/demo/run-allapps/collector-node/Standalone Node collector with Postgres + MinIO. docker compose up -d from apps/collector-nodedemo/OpenTelemetry Astronomy Shop feeding obs-unified with polyglot microservice traffic. pnpm demo:setup, pnpm demo:preflight, pnpm demo:up
Runtime Example Notes Node.js / TypeScript sdks/node/examples/basic.tsFirst-party Node SDK usage Node.js / TypeScript sdks/node/examples/smoke.mjsLightweight SDK smoke path Go sdks/go/examples/basic/main.goGo SDK init and span conventions Rust sdks/rust/examples/basic.rsRust SDK init and helper usage
Runtime Recipe Python docs/recipes/python.mdJVM / Java / Kotlin docs/recipes/jvm.md.NET docs/recipes/dotnet.mdGo sdks/go/README.mdRust sdks/rust/README.mdSDK skeleton for contributors sdks/_template/README.md
Source Guide Sentry docs/migrate/from-sentry.mdPostHog docs/migrate/from-posthog.mdHoneycomb docs/migrate/from-honeycomb.mdOld @obs/* package scope docs/migrate/from-obs-scope.md
After wiring any example, verify the collector and browser CORS path:
obs-unified doctor http://localhost:8790 --origin http://localhost:5173 For browser examples, the origin should match the app you are testing. For the Astronomy Shop demo, use http://localhost:8080.