@outray/tanstack-start

TanStack Start server-request instrumentation for OutRay. It gives incoming requests low-cardinality route names, records response status and failures, and can opt in to bounded, redacted request/response capture.

Install

npm install @outray/tanstack-start

Create an OutRay token with Send observability data. Configure OutRay in a server entry; no NODE_OPTIONS preloader or OpenTelemetry-specific environment variables are required.

Configure the server

Create src/server.ts:

import { createOutrayTanStackServerEntry } from '@outray/tanstack-start/server'

export default createOutrayTanStackServerEntry({
  apiKey: 'outray_your_observability_token',
  serviceName: 'my-tanstack-app',
  environment: 'production',
  capturePayloads: {
    maxBodyBytes: 16 * 1024,
    redactedHeaders: ['x-workspace-secret'],
    redactedFields: ['accountPin'],
  },
  routeResolver: ({ pathname }) => {
    if (pathname.startsWith('/api/orders/')) return '/api/orders/:orderId'
    return null
  },
})

Your ordinary scripts stay unchanged:

{
  "scripts": {
    "dev": "vite dev",
    "start": "node .output/server/index.mjs"
  }
}

Pass the token directly as shown, but do not commit a real token to source control. Production code can supply the same apiKey option from OutRay Secrets, your deployment platform, or another server-only config source. serviceName and environment are regular code configuration.

Payload capture is disabled unless capturePayloads is set. Only JSON, application/*+json, and URL-encoded bodies are eligible. Sensitive headers and fields are always redacted, bodies are bounded, and request/response streams used by handlers are never consumed.

The default route normalizer replaces UUIDs, numeric IDs, long hexadecimal IDs, and ULIDs with :id. Use routeResolver for application-specific slugs or to provide exact TanStack route templates. Vite internals and common static asset paths are ignored by default.

This package instruments TanStack Start's Node/Nitro runtime. Keep the configuration in src/server.ts; it does not put the OutRay token in browser code and does not currently support edge runtimes.