rsnext/examples/with-opentelemetry
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
app (Example) Update with-opentelemetry example. (#54775) 2023-09-26 02:56:23 +00: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 Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00: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 chore: remove experimental appDir: true from examples (#52289) 2023-07-05 21:45:39 +00:00
package.json Recommend @opentelemetry/api instead of @vercel/otel reexport (#48013) 2023-04-06 14:17:47 +02:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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).