Docs
DocumentationQuery ReferenceAPI Reference
Open Console→→
DocumentationQuery ReferenceAPI Reference

Platform overview

What is Axiom?QuickstartArchitectureFeatures
Fundamentals
Datasets
Edge deployments
Limits
Performance
Optimize usage
Requirements
Semantic conventions
Glossary
Tour
SecurityRoadmap

Send data

Reference architecturesMethods

Understand data

Console
Query
Builder
Editor
Query results
Visualize
Traces
Metrics
Correlations
Save queries
Stream
Dashboard
Create
Elements
Create
Configure
Element types
Gauge
Heatmap
Log stream
Monitor list
Note
Pie chart
Scatter plot
Statistic
Table
Time series
Sections
Configure
Filter
Monitor
Overview
View status
Configure
Examples
Monitor types
Anomaly
Match
New values
Threshold
Alerting
Overview
Configure
Notifier types
Amp
ChatGPT Workspace Agent
Claude Code
Cursor
Custom Webhook
Discord
Email
incident.io
Jira Service Management
Microsoft Teams
Opsgenie
PagerDuty
Slack
Annotations
Command Menu
Manage
Datasets
Overview
Views
Virtual fields
Access
RBAC
Tokens
CLI
Organization
Labels
Audit log
Settings
Usage and billing
Profile
Extend
Overview
AWS Lambda
AWS PrivateLink
Cloudflare Workers
Cloudflare Logpush
Convex
Grafana
Hex
Netlify
Supabase
Tailscale
Terraform
Unkey
Vercel
Intelligence
Overview
Spotlight
AI agents
Overview
MCP Server
Overview
Tools
Query cost limits
Agent-created orgs
Skills
Overview
Axiom alerting
Build dashboards
Control costs
SRE
Translate SPL to APL
Splunk
Overview
Splunk app
Install and configure
Commands
Examples
Portal
How it works
Set up standard mode
Set up transparent mode
Observability Cloud
OCSF data
OCSF as CIM
SPL command support
Examples
Monitor and troubleshoot

Use cases

ObservabilityProduct analytics
OCSF security data
Overview
Send data
Query data
LLM observability
Overview
Use Axiom AI SDK
Manual instrumentation
GenAI attributes
Redaction policies

Miscellaneous

LLMs
Overview
List of docs pages
Full docs
Query reference
FAQs
Legal
Acceptable use policy
Axiom for Startups terms
Committed use terms
Cookies
Data processing
HIPAA
Partner agreement
Partner program guide
Privacy policy
SLA
Terms of service
Terms of use

Send data from TanStack Start to Axiom

This page explains how to send logs and client errors from a TanStack Start app to Axiom using @axiomhq/tanstack-start.

The @axiomhq/tanstack-start library provides request middleware, server-function middleware, TanStack Router observation, proxy ingestion, and client error boundary helpers for React and Solid apps built with TanStack Start.

Info

The @axiomhq/tanstack-start library is part of the Axiom JavaScript SDK. For source code and examples, see the GitHub repository.

Prerequisites

  • Create an Axiom account.
  • Create a dataset in Axiom where you send your data.
  • Create an API token in Axiom with permissions to ingest data to the dataset you have created.
  • A new or existing TanStack Start app (React or Solid).

Install @axiomhq/tanstack-start

In your terminal, go to the root folder of your TanStack Start app and run:

shell
npm install @axiomhq/js @axiomhq/logging@0.3.0 @axiomhq/tanstack-start
Info

@axiomhq/tanstack-start 0.2.0 has an exact peer dependency on @axiomhq/logging@0.3.0. Pin @axiomhq/logging@0.3.0 to avoid peer-dependency resolution errors.

Configure the server logger

Create a server-side logger that sends events to Axiom using your API token and edge deployment domain. Keep AXIOM_TOKEN on the server and don’t expose it in browser bundles.

typescript
import { Axiom } from '@axiomhq/js';
import { AxiomJSTransport, ConsoleTransport, Logger } from '@axiomhq/logging';
import { tanStackStartServerFormatters } from '@axiomhq/tanstack-start';

const axiom = new Axiom({
  token: process.env.AXIOM_TOKEN!,
  edge: process.env.AXIOM_EDGE,
});

export const startLogger = new Logger({
  transports: [
    new AxiomJSTransport({
      axiom,
      dataset: process.env.AXIOM_DATASET!,
    }),
    new ConsoleTransport({ prettyPrint: true }),
  ],
  formatters: tanStackStartServerFormatters,
});

Set AXIOM_EDGE to the base domain of your edge deployment:

Edge deploymentBase domain for ingest and query
US East 1 (AWS)us-east-1.aws.edge.axiom.co
EU Central 1 (AWS)eu-central-1.aws.edge.axiom.co

For more information, see Edge deployments.

Configure client-side proxy ingestion

To send browser logs without exposing your Axiom API token in client code, use ProxyTransport on the client and forward events through a server route backed by createAxiomProxyHandler.

  1. Create src/lib/axiom/client.ts:

    typescript
    import { ConsoleTransport, Logger, ProxyTransport } from '@axiomhq/logging';
    import type { Transport } from '@axiomhq/logging';
    import { tanStackStartClientFormatters } from '@axiomhq/tanstack-start';
    import { tanStackRouterFormatters } from '@axiomhq/tanstack-start/router';
    
    function createBrowserTransports(): [Transport, ...Transport[]] {
      return [
        new ProxyTransport({ url: '/api/axiom' }),
        new ConsoleTransport({ prettyPrint: true }),
      ];
    }
    
    export const routerLogger = new Logger({
      transports: createBrowserTransports(),
      formatters: tanStackRouterFormatters,
    });
    
    export const clientLogger = new Logger({
      transports: createBrowserTransports(),
      formatters: tanStackStartClientFormatters,
    });
  2. Create the server proxy route src/routes/api/axiom.ts:

    typescript
    import { createFileRoute } from '@tanstack/react-router';
    import { createAxiomProxyHandler } from '@axiomhq/tanstack-start';
    import { startLogger } from '../../lib/axiom/server';
    
    const proxyHandler = createAxiomProxyHandler(startLogger);
    
    export const Route = createFileRoute('/api/axiom')({
      server: {
        handlers: {
          POST: ({ request }) => proxyHandler(request),
        },
      },
    });

    For Solid apps, import createFileRoute from @tanstack/solid-router.

Add Start middleware

Use createAxiomRequestMiddleware and createAxiomFnMiddleware to log HTTP requests and server function calls:

typescript
import {
  createAxiomFnMiddleware,
  createAxiomRequestMiddleware,
} from '@axiomhq/tanstack-start';
import { startLogger } from './lib/axiom/server';

export const requestMiddleware = [
  createAxiomRequestMiddleware(startLogger, {
    include: ['/api/*', '/_server/*'],
    exclude: ['/api/health'],
  }),
];

export const functionMiddleware = [
  createAxiomFnMiddleware(startLogger, {
    correlation: true,
  }),
];

Use one function instrumentation path per server function. If you mount createAxiomFnMiddleware globally through createStart({ functionMiddleware }), don’t also attach it to individual server functions unless you want duplicate log events.

Observe TanStack Router

Use observeTanStackRouter from @axiomhq/tanstack-start/router to record client-side route navigation and timing logs:

typescript
import { observeTanStackRouter } from '@axiomhq/tanstack-start/router';
import { routerLogger } from './lib/axiom/client';

const observe = observeTanStackRouter(routerLogger, {
  source: 'tanstack-router-react',
  performance: true,
});

const unsubscribe = observe(router);

observeTanStackRouter only subscribes in the browser, so it’s safe to call during router setup that also runs during SSR.

Capture client errors

Use the framework adapter with clientLogger so client error reports go through /api/axiom without importing server credentials into browser bundles.

TSX
import { ErrorComponent, createRouter, type ErrorComponentProps } from '@tanstack/react-router';
import { useEffect } from 'react';
import { createAxiomReactErrorHandler } from '@axiomhq/tanstack-start/react';
import { clientLogger } from './lib/axiom/client';

const handleClientError = createAxiomReactErrorHandler(clientLogger);

function RouterErrorBoundary({ error }: ErrorComponentProps) {
  useEffect(() => {
    handleClientError(error);
  }, [error]);

  return <ErrorComponent error={error} />;
}

const router = createRouter({
  routeTree,
  defaultErrorComponent: RouterErrorBoundary,
});
TSX
import { ErrorComponent, createRouter, type ErrorComponentProps } from '@tanstack/solid-router';
import { onMount } from 'solid-js';
import { createAxiomSolidErrorHandler } from '@axiomhq/tanstack-start/solid';
import { clientLogger } from './lib/axiom/client';

const handleClientError = createAxiomSolidErrorHandler(clientLogger);

function RouterErrorBoundary(props: ErrorComponentProps) {
  onMount(() => handleClientError(props.error, props.reset));
  return <ErrorComponent error={props.error} />;
}

const router = createRouter({
  routeTree,
  defaultErrorComponent: RouterErrorBoundary,
});
Was this page helpful?
Suggest edits on GitHub
On this page
Install @axiomhq/tanstack-startConfigure the server loggerConfigure client-side proxy ingestionAdd Start middlewareObserve TanStack RouterCapture client errors