ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 1 commit into from
Jun 18, 2026
Merged

ref(node): Streamline hapi instrumentation #21602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
},
});

// Route registered via a plugin produces a `plugin.hapi` span.
await server.register({
name: 'testPlugin',
version: '1.0.0',
register: async function (pluginServer) {
pluginServer.route({
method: 'GET',
path: '/plugin-route',
handler: () => 'Hello from plugin!',
});
},
});

// Server extension produces a `server.ext.hapi` span.
server.ext('onPreResponse', (request, h) => h.continue);

await Sentry.setupHapiErrorHandler(server);
await server.start();

Expand Down
37 changes: 37 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/hapi/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
await runner.completed();
});

test('should instrument plugin routes and server extensions.', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'GET /plugin-route',
spans: expect.arrayContaining([
expect.objectContaining({
description: 'GET /plugin-route',
op: 'plugin.hapi',
origin: 'auto.http.otel.hapi',
data: expect.objectContaining({
'http.route': '/plugin-route',
'hapi.type': 'plugin',
'hapi.plugin.name': 'testPlugin',
'sentry.op': 'plugin.hapi',
'sentry.origin': 'auto.http.otel.hapi',
}),
}),
expect.objectContaining({
description: 'ext - onPreResponse',
op: 'server.ext.hapi',
origin: 'auto.http.otel.hapi',
data: expect.objectContaining({
'hapi.type': 'server.ext',
'server.ext.type': 'onPreResponse',
'sentry.op': 'server.ext.hapi',
'sentry.origin': 'auto.http.otel.hapi',
}),
}),
]),
},
})
.start();
runner.makeRequest('get', '/plugin-route');
await runner.completed();
});

test('should handle returned plain errors in routes.', async () => {
const runner = createRunner()
.expect({
Expand Down
34 changes: 1 addition & 33 deletions packages/node/src/integrations/tracing/hapi/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
captureException,
debug,
defineIntegration,
getClient,
getDefaultIsolationScope,
getIsolationScope,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
*/
export async function setupHapiErrorHandler(server: Server): Promise<void> {
await server.register(hapiErrorPlugin);

// Sadly, middleware spans do not go through `requestHook`, so we handle those here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using hapi
const client = getClient();
if (client) {
client.on('spanStart', span => {
addHapiSpanAttributes(span);
});
}

ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: router, plugin, server.ext
const type = attributes['hapi.type'];

// If this is already set, or we have no Hapi span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
});
}
111 changes: 44 additions & 67 deletions packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
* - Types vendored from @hapi/hapi as simplified interfaces
* - Minor TypeScript strictness adjustments for this repository's compiler settings
* - Span creation migrated to the @sentry/core API; op/origin folded into span creation
*/
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
SemconvStability,
semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
HapiComponentName,
HapiServerRouteInput,
handlerPatched,
PatchableServerRoute,
HapiServerRouteInputMethod,
HapiPluginInput,
RegisterFunction,
PatchableExtMethod,
ServerExtDirectInput,
type HapiServerRouteInput,
type PatchableServerRoute,
type HapiServerRouteInputMethod,
type HapiPluginInput,
type RegisterFunction,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import {
getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
private _semconvStability: SemconvStability;

constructor(config: InstrumentationConfig = {}) {
super(PACKAGE_NAME, SDK_VERSION, config);
this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
}

protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
(module: any) => {
const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
if (!isWrapped(moduleExports.server)) {
this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
}

if (!isWrapped(moduleExports.Server)) {
this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
}
return moduleExports;
},
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

// Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
// function, which requires supporting a variety of different types of Plugin inputs
self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
return newServer;
};
}
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
route[i] = newRoute;
}
} else {
// oxlint-disable-next-line no-param-reassign
route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
}
return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
const instrumentation: HapiInstrumentation = this;
if (method instanceof Array) {
for (let i = 0; i < method.length; i++) {
method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
}
return method;
} else if (isPatchableExtMethod(method)) {
if (method[handlerPatched] === true) return method;
method[handlerPatched] = true;

const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
if (api.trace.getSpan(api.context.active()) === undefined) {
return await method.apply(this, params);
return method.apply(this, params);
}
const metadata = getExtMetadata(extPoint, pluginName, method.name);
const span = instrumentation.tracer.startSpan(metadata.name, {
attributes: metadata.attributes,
});
try {
return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
api.trace.setSpan(api.context.active(), span),
method,
undefined,
...params,
);
} catch (err: any) {
span.recordException(err);
span.setStatus({
code: api.SpanStatusCode.ERROR,
message: err.message,
});
throw err;
} finally {
span.end();
}
return startSpan(
{
name: metadata.name,
op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
attributes: {
...metadata.attributes,
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
},
},
() => method.apply(undefined, params),
);
};
return newHandler as T;
}
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
* for adding this server route. Else, signifies that the route was added directly
*/
private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
const instrumentation: HapiInstrumentation = this;
if (route[handlerPatched] === true) return route;
route[handlerPatched] = true;

const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
if (api.trace.getSpan(api.context.active()) === undefined) {
return await oldHandler.call(this, ...params);
return oldHandler.call(this, ...params);
}
setHttpServerSpanRouteAttribute(route.path);
const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
const span = instrumentation.tracer.startSpan(metadata.name, {
attributes: metadata.attributes,
});
try {
return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
oldHandler.call(this, ...params),
);
} catch (err: any) {
span.recordException(err);
span.setStatus({
code: api.SpanStatusCode.ERROR,
message: err.message,
});
throw err;
} finally {
span.end();
}
const metadata = getRouteMetadata(route, pluginName);
return startSpan(
{
name: metadata.name,
op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
attributes: {
...metadata.attributes,
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
},
},
() => oldHandler.call(this, ...params),
);
};
};

Expand Down
25 changes: 6 additions & 19 deletions packages/node/src/integrations/tracing/hapi/vendored/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
* - Types vendored from @hapi/hapi as simplified interfaces
*/
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';

@JPeer264JPeer264Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?

@nicohrubecnicohrubecJun 17, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet

@nicohrubecnicohrubecJun 17, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far

import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
HapiLayerType,
HapiLifecycleMethodNames,
HapiPluginObject,
PatchableExtMethod,
ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
route: Hapi.ServerRoute,
semconvStability: SemconvStability,
pluginName?: string,
): {
attributes: Attributes;
name: string;
} => {
const attributes: Attributes = {
[ATTR_HTTP_ROUTE]: route.path,
[ATTR_HTTP_METHOD]: route.method,
};
if (semconvStability & SemconvStability.OLD) {
attributes[ATTR_HTTP_METHOD] = route.method;
}
if (semconvStability & SemconvStability.STABLE) {
// Note: This currently does *not* normalize the method name to uppercase
// and conditionally include `http.request.method.original` as described
// at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
// These attributes are for a *hapi* span, and not the parent HTTP span,
// so the HTTP span guidance doesn't strictly apply.
attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
}

let name;
if (pluginName) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ref(node): Streamline hapi instrumentation#21602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nicohrubec
merged 1 commit into

from

Jun 18, 2026
 Merged


ref(node): Streamline hapi instrumentation
#21602
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/scenario.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,22 @@ const run = async () => {
 },
 });

 // Route registered via a plugin produces a `plugin.hapi` span.
 await server.register({
 name: 'testPlugin',
 version: '1.0.0',
 register: async function (pluginServer) {
 pluginServer.route({
 method: 'GET',
 path: '/plugin-route',
 handler: () => 'Hello from plugin!',
 });
 },
 });

 // Server extension produces a `server.ext.hapi` span.
 server.ext('onPreResponse', (request, h) => h.continue);

 await Sentry.setupHapiErrorHandler(server);
 await server.start();

Expand Down

37 changes: 37 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,43 @@ describe('hapi auto-instrumentation', () => {
 await runner.completed();
 });

 test('should instrument plugin routes and server extensions.', async () => {
 const runner = createRunner()
 .expect({
 transaction: {
 transaction: 'GET /plugin-route',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'GET /plugin-route',
 op: 'plugin.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'http.route': '/plugin-route',
 'hapi.type': 'plugin',
 'hapi.plugin.name': 'testPlugin',
 'sentry.op': 'plugin.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 expect.objectContaining({
 description: 'ext - onPreResponse',
 op: 'server.ext.hapi',
 origin: 'auto.http.otel.hapi',
 data: expect.objectContaining({
 'hapi.type': 'server.ext',
 'server.ext.type': 'onPreResponse',
 'sentry.op': 'server.ext.hapi',
 'sentry.origin': 'auto.http.otel.hapi',
 }),
 }),
 ]),
 },
 })
 .start();
 runner.makeRequest('get', '/plugin-route');
 await runner.completed();
 });

 test('should handle returned plain errors in routes.', async () => {
 const runner = createRunner()
 .expect({
Expand Down

34 changes: 1 addition & 33 deletions
packages/node/src/integrations/tracing/hapi/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
import { HapiInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import {
 captureException,
 debug,
 defineIntegration,
 getClient,
 getDefaultIsolationScope,
 getIsolationScope,
 SDK_VERSION,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 spanToJSON,
} from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';
import { DEBUG_BUILD } from '../../../debug-build';
Expand DownExpand Up@@ -108,33 +104,5 @@ export const hapiErrorPlugin = {
 */
export async function setupHapiErrorHandler(server: Server): Promise<void> {
 await server.register(hapiErrorPlugin);

 // Sadly, middleware spans do not go through `requestHook`, so we handle those here
 // We register this hook in this method, because if we register it in the integration `setup`,
 // it would always run even for users that are not even using hapi
 const client = getClient();
 if (client) {
 client.on('spanStart', span => {
 addHapiSpanAttributes(span);
 });
 }

 ensureIsWrapped(server.register, 'hapi');
}

function addHapiSpanAttributes(span: Span): void {
 const attributes = spanToJSON(span).data;

 // this is one of: router, plugin, server.ext
 const type = attributes['hapi.type'];

 // If this is already set, or we have no Hapi span, no need to process again...
 if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
 return;
 }

 span.setAttributes({
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.hapi`,
 });
}

111 changes: 44 additions & 67 deletions
packages/node/src/integrations/tracing/hapi/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,32 +18,27 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 * - Minor TypeScript strictness adjustments for this repository's compiler settings
 * - Span creation migrated to the @sentry/core API; op/origin folded into span creation
 */
/* eslint-disable */

import * as api from '@opentelemetry/api';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import {
 InstrumentationBase,
 InstrumentationConfig,
 InstrumentationNodeModuleDefinition,
 isWrapped,
 SemconvStability,
 semconvStabilityFromStr,
} from '@opentelemetry/instrumentation';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';

import type * as Hapi from './hapi-types';
import { SDK_VERSION } from '@sentry/core';
import { SDK_VERSION, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { AttributeNames } from './enums/AttributeNames';
import {
 HapiComponentName,
 HapiServerRouteInput,
 handlerPatched,
 PatchableServerRoute,
 HapiServerRouteInputMethod,
 HapiPluginInput,
 RegisterFunction,
 PatchableExtMethod,
 ServerExtDirectInput,
 type HapiServerRouteInput,
 type PatchableServerRoute,
 type HapiServerRouteInputMethod,
 type HapiPluginInput,
 type RegisterFunction,
 type PatchableExtMethod,
 type ServerExtDirectInput,
} from './internal-types';
import {
 getRouteMetadata,
Expand All@@ -60,11 +55,8 @@ const PACKAGE_NAME = '@sentry/instrumentation-hapi';

/** Hapi instrumentation for OpenTelemetry */
export class HapiInstrumentation extends InstrumentationBase {
 private _semconvStability: SemconvStability;

 constructor(config: InstrumentationConfig = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
 this._semconvStability = semconvStabilityFromStr('http', process.env.OTEL_SEMCONV_STABILITY_OPT_IN);
 }

 protected init() {
Expand All@@ -74,11 +66,11 @@ export class HapiInstrumentation extends InstrumentationBase {
 (module: any) => {
 const moduleExports: typeof Hapi = module[Symbol.toStringTag] === 'Module' ? module.default : module;
 if (!isWrapped(moduleExports.server)) {
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'server', this._getServerPatch.bind(this));
 }

 if (!isWrapped(moduleExports.Server)) {
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this) as any);
 this._wrap(moduleExports, 'Server', this._getServerPatch.bind(this));
 }
 return moduleExports;
 },
Expand DownExpand Up@@ -115,7 +107,7 @@ export class HapiInstrumentation extends InstrumentationBase {

 // Casting as any is necessary here due to multiple overloads on the Hapi.Server.register
 // function, which requires supporting a variety of different types of Plugin inputs
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation) as any);
 self._wrap(newServer, 'register', instrumentation._getServerRegisterPatch.bind(instrumentation));
 return newServer;
 };
 }
Expand DownExpand Up@@ -202,6 +194,7 @@ export class HapiInstrumentation extends InstrumentationBase {
 route[i] = newRoute;
 }
 } else {
 // oxlint-disable-next-line no-param-reassign
 route = instrumentation._wrapRouteHandler.call(instrumentation, route, pluginName);
 }
 return original.apply(this, [route]);
Expand DownExpand Up@@ -254,38 +247,29 @@ export class HapiInstrumentation extends InstrumentationBase {
 const instrumentation: HapiInstrumentation = this;
 if (method instanceof Array) {
 for (let i = 0; i < method.length; i++) {
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint) as PatchableExtMethod;
 method[i] = instrumentation._wrapExtMethods(method[i]!, extPoint);
 }
 return method;
 } else if (isPatchableExtMethod(method)) {
 if (method[handlerPatched] === true) return method;
 method[handlerPatched] = true;

 const newHandler: PatchableExtMethod = async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 const newHandler: PatchableExtMethod = function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await method.apply(this, params);
 return method.apply(this, params);
 }
 const metadata = getExtMetadata(extPoint, pluginName, method.name);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with<Parameters<Hapi.Lifecycle.Method>, Hapi.Lifecycle.Method>(
 api.trace.setSpan(api.context.active(), span),
 method,
 undefined,
 ...params,
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => method.apply(undefined, params),
 );
 };
 return newHandler as T;
 }
Expand All@@ -300,34 +284,27 @@ export class HapiInstrumentation extends InstrumentationBase {
 * for adding this server route. Else, signifies that the route was added directly
 */
 private _wrapRouteHandler(route: PatchableServerRoute, pluginName?: string): PatchableServerRoute {
 const instrumentation: HapiInstrumentation = this;
 if (route[handlerPatched] === true) return route;
 route[handlerPatched] = true;

 const wrapHandler: (oldHandler: Hapi.Lifecycle.Method) => Hapi.Lifecycle.Method = oldHandler => {
 return async function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 return function (this: any, ...params: Parameters<Hapi.Lifecycle.Method>) {
 if (api.trace.getSpan(api.context.active()) === undefined) {
 return await oldHandler.call(this, ...params);
 return oldHandler.call(this, ...params);
 }
 setHttpServerSpanRouteAttribute(route.path);
 const metadata = getRouteMetadata(route, instrumentation._semconvStability, pluginName);
 const span = instrumentation.tracer.startSpan(metadata.name, {
 attributes: metadata.attributes,
 });
 try {
 return await api.context.with(api.trace.setSpan(api.context.active(), span), () =>
 oldHandler.call(this, ...params),
 );
 } catch (err: any) {
 span.recordException(err);
 span.setStatus({
 code: api.SpanStatusCode.ERROR,
 message: err.message,
 });
 throw err;
 } finally {
 span.end();
 }
 const metadata = getRouteMetadata(route, pluginName);
 return startSpan(
 {
 name: metadata.name,
 op: `${metadata.attributes[AttributeNames.HAPI_TYPE]}.hapi`,
 attributes: {
 ...metadata.attributes,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.hapi',
 },
 },
 () => oldHandler.call(this, ...params),
 );
 };
 };

Expand Down

25 changes: 6 additions & 19 deletions
packages/node/src/integrations/tracing/hapi/vendored/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,21 +18,19 @@
 * - Upstream version: @opentelemetry/instrumentation-hapi@0.64.0
 * - Types vendored from @hapi/hapi as simplified interfaces
 */
/* eslint-disable */

import { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE, ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
import type { Attributes } from '@opentelemetry/api';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
@JPeer264JPeer264Jun 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: Should we already move this to the sentry conventions?
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we moved the node package to sentry conventions yet
@nicohrubecnicohrubecJun 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node-core so far
import { ATTR_HTTP_METHOD } from './semconv';
import type * as Hapi from './hapi-types';
import {
 HapiLayerType,
 HapiLifecycleMethodNames,
 HapiPluginObject,
 PatchableExtMethod,
 ServerExtDirectInput,
type HapiPluginObject,
type PatchableExtMethod,
type ServerExtDirectInput,
} from './internal-types';
import { AttributeNames } from './enums/AttributeNames';
import { SemconvStability } from '@opentelemetry/instrumentation';

export function getPluginName<T>(plugin: Hapi.Plugin<T>): string {
 if ((plugin as Hapi.PluginNameVersion).name) {
Expand DownExpand Up@@ -70,26 +68,15 @@ export const isPatchableExtMethod = (

export const getRouteMetadata = (
 route: Hapi.ServerRoute,
 semconvStability: SemconvStability,
 pluginName?: string,
): {
 attributes: Attributes;
 name: string;
} => {
 const attributes: Attributes = {
 [ATTR_HTTP_ROUTE]: route.path,
 [ATTR_HTTP_METHOD]: route.method,
 };
 if (semconvStability & SemconvStability.OLD) {
 attributes[ATTR_HTTP_METHOD] = route.method;
 }
 if (semconvStability & SemconvStability.STABLE) {
 // Note: This currently does *not* normalize the method name to uppercase
 // and conditionally include `http.request.method.original` as described
 // at https://opentelemetry.io/docs/specs/semconv/http/http-spans/
 // These attributes are for a *hapi* span, and not the parent HTTP span,
 // so the HTTP span guidance doesn't strictly apply.
 attributes[ATTR_HTTP_REQUEST_METHOD] = route.method;
 }

 let name;
 if (pluginName) {
Expand Down
Loading
Loading