kit
kit copied to clipboard
[PoC] feat: Add support for server-side instrumentation
See https://github.com/sveltejs/kit/discussions/13775
This PR adds minimal adaption for SvelteKit to support registering ESM server-side instrumentation in a dedicated instrument.server.ts file prior to SvelteKit's server being bootstrapped.
Concrete changes:
@sveltejs/kit- add
instrument.server.(js|ts)to file output (s.t. it can be transpiled)
- add
@sveltejs/adapter-node- add transpiled
instrument.server.jsto secondary server build - add dynamic import of
instrument.server.js(if available) to server entry
- add transpiled
Usage
// instrument.server.ts
// add arbitrary instrumentation code here, for example:
import { NodeSDK } from "@opentelemetry/sdk-node";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";
import { createAddHookMessageChannel } from "import-in-the-middle";
import { register } from "module";
const { registerOptions, waitForAllMessagesAcknowledged } =
createAddHookMessageChannel();
register("import-in-the-middle/hook.mjs", import.meta.url, registerOptions);
const sdk = new NodeSDK({
serviceName: "demo-todo-app",
traceExporter: new OTLPTraceExporter(),
instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
await waitForAllMessagesAcknowledged();
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
- [x] It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
- [x] This message body should clearly illustrate what problems it solves.
- [ ] Ideally, include a test that fails without this PR but passes with it.
Tests
- [ ] Run the tests with
pnpm testand lint the project withpnpm lintandpnpm check
Changesets
- [ ] If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.
Edits
- [ ] Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.
⚠️ No Changeset found
Latest commit: 09f27746dfda72ad8436ec6c6d1a4c55b3d4764b
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Preview: https://svelte-dev-git-preview-kit-13776-svelte.vercel.app/
Closing in favor of #13899 -- will add you as co-contributor on the squash commit!
Much appreciated, thanks! ❤️