tRPC Quick Start

Learn how to set up highlight.io in tRPC.

1

Configure client-side Highlight. (optional)

If you're using Highlight on the frontend for your application, make sure you've initialized it correctly and followed the fullstack mapping guide.

2

Install the relevant Highlight SDK(s).

Install @highlight-run/node with your package manager.

npm install --save @highlight-run/node

3

Initialize the Highlight JS SDK.

Initialize the Highlight JS SDK with your project ID.

import { H } from '@highlight-run/node' H.init({ projectID: '<YOUR_PROJECT_ID>', serviceName: '<YOUR_SERVICE_NAME>', environment: 'production', })

4

Add the tRPC Highlight integration.

Use the Node Highlight SDK in your response handler.

import { createNextApiHandler } from '@trpc/server/adapters/next' import { Handlers } from '@highlight-run/node' export default createNextApiHandler({ // ... your config onError: ({ error, req }) => { // ... your own error handling logic here Handlers.trpcOnError( { error, req }, { projectID: '<YOUR_PROJECT_ID>', serviceName: 'my-trpc-app', serviceVersion: 'git-sha', environment: 'production' } ) }, })

5

Verify that your SDK is reporting errors.

You'll want to throw an exception in one of your tRPC handlers. Access the API handler and make sure the error shows up in Highlight.

6

Verify your backend logs are being recorded.

Visit the highlight logs portal and check that backend logs are coming in.

7

Verify your backend traces are being recorded.

Visit the highlight traces portal and check that backend traces are coming in.