next.js/examples/with-opentelemetry

OpenTelemetry example

OpenTelemetry is a collection of tools for easier instrumentation of you applications. You can use it to setup instrumentation for Next.js with the instrumentation.ts file.

In order to collect and inspect traces generated by OpenTelemetry you need a running OpenTelemetry collector and a backend.

You can easily deploy this example on Vercel. It manages OpenTelemetry collector for you, read the docs for more details. Or you can follow official OpenTelemetry documentation if you want to use it in your self-hosted Next.js app.

But you need to run your own collector if you want to test OpenTelemetry locally. We recommend cloning pre-made dev setup. It contains pre-configured docker images for Collector, ZipKin, Jaeger and Prometheus.

More information about OpenTelemetry can be found in Next.js docs.

Deploy your own

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-opentelemetry with-opentelemetry-app

yarn create next-app --example with-opentelemetry with-opentelemetry-app

pnpm create next-app --example with-opentelemetry with-opentelemetry-app

Deploy it to the cloud with Vercel (Documentation).