import { H } from '@highlight-run/node'

H.init({
	projectID: '<YOUR_PROJECT_ID>',
	serviceName: '<YOUR_SERVICE_NAME>',
	environment: 'production',
})

Wrap your code using the Node.js SDK.

By calling H.startWithHeaders() and span.end(), the @highlight-run/node SDK will record a span. You can create more child spans or add custom attributes to each span.


const functionToTrace = async (input int) => {
	const { span, ctx } = H.startWithHeaders("functionToTrace", {}, {custom_property: input})
	// ...
	// use the current span context with the function call to ensure child spans are tied to the current span
	// import api from '@opentelemetry/api'
	api.context.with(ctx, () => {
        anotherFunction()
    })
	// ...
	span.end()
}

const anotherFunction = () => {
	const { span } = H.startWithHeaders("anotherFunction", {})

	// ...
	span.end()
}

module.exports = function() {
    console.log('hey there!');
    functionToTrace()
}

Pass HTTP headers to the SDK

H.runWithHeaders takes request headers and spreads them across all related spans, automatically relating spans to your session and request headers.


app.get('/', async (req, res) => {
	await H.runWithHeaders(req.headers, () => {
		const { span } = H.startWithHeaders("custom-span", {})
		const err = new Error('this is a test error')

		console.info('Sending error to highlight')
		H.consumeError(err)

		res.send('Hello World!')
		span.end()
	})
})

Verify your backend traces are being recorded.

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

Tracing in Node.js Next.js