a3acbf4f55
Added docs that mention: - important code-snippets from example - links to official OTEL docs - document NEXT_VERBOSE_OTEL - explain what we provide out of the box - what we don’t - explain how you can add tracing yourself - explain how instrumentation.js works - it can be used for different types of instrumentation that don't use OTEL. It's just a hook called when starting up a new node environment. - list of all spans we instrument by default fix NEXT-799 ([link](https://linear.app/vercel/issue/NEXT-799)) --------- Co-authored-by: S3Prototype <liuqahs15@gmail.com>
2.3 KiB
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
Deploy the example using Vercel or preview live with StackBlitz
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).