rsnext/examples/with-opentelemetry
Jan Kaifer e35710f71f
Recommend @opentelemetry/api instead of @vercel/otel reexport (#48013)
- remove vscode folder from example
- recommend `@poentelemetry/api` over `@vercel/otel`

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation or adding/fixing Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md



## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

fix NEXT-959
2023-04-06 14:17:47 +02:00
..
app feat: add OTEL instrumentation for next-server + OTEL example (#46198) 2023-02-22 16:08:22 +01:00
pages Add documentation on OTEL support (#47194) 2023-04-04 14:24:46 +00:00
shared Recommend @opentelemetry/api instead of @vercel/otel reexport (#48013) 2023-04-06 14:17:47 +02:00
.gitignore Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
instrumentation.ts Add documentation on OTEL support (#47194) 2023-04-04 14:24:46 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
next.config.js feat: add OTEL instrumentation for next-server + OTEL example (#46198) 2023-02-22 16:08:22 +01:00
package.json Recommend @opentelemetry/api instead of @vercel/otel reexport (#48013) 2023-04-06 14:17:47 +02:00
README.md Add documentation on OTEL support (#47194) 2023-04-04 14:24:46 +00:00
tsconfig.json feat: add OTEL instrumentation for next-server + OTEL example (#46198) 2023-02-22 16:08:22 +01:00

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

Deploy with Vercel

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).