tRPC Error Monitoring

Learn how to set up highlight.io in tRPC.

1

Add `tracingOrigins` to your client Highlight snippet.

This backend SDK requires one of the Highlight frontend SDKs to be installed, so please make sure you've followed the fullstack mapping guide first.

H.init("<YOUR_PROJECT_ID>", { tracingOrigins: ['localhost', 'example.myapp.com/backend'], networkRecording: { enabled: true, recordHeadersAndBody: true, }, });

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

Set up logging.

With the JS SDKs, your logs are reported automatically from console methods. See the JS logging setup guide for more details.