Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(node-core): Add processSegmentSpan to node context integration#20678
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.
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
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f2e8a6d
add processSegmentSpan for integration
chargome 26f39fd
fix test
chargome e5c90cd
fix(node-core): Update basic-usage-streamed test for context span att…
chargome 9a7069f
fix: Use strict attribute checks in basic-usage-streamed tests
chargome 10bf715
refactor
chargome 593d767
Merge branch 'develop' into cg-node-context-streaming
chargome de2d5c5
fix tests?
chargome ccd3b5d
todos for arch.device and assert on process memory for node 22
nicohrubec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
39 changes: 30 additions & 9 deletions
39 ...ages/node-core-integration-tests/suites/public-api/startSpan/basic-usage-streamed/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15 dev-packages/node-integration-tests/suites/context-streamed/scenario.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| tracesSampleRate: 1.0, | ||
| traceLifecycle: 'stream', | ||
| transport: loggingTransport, | ||
| }); | ||
| Sentry.startSpan({ name: 'test-span' }, () => { | ||
| // noop | ||
| }); | ||
| void Sentry.flush(); |
43 changes: 43 additions & 0 deletions
43 dev-packages/node-integration-tests/suites/context-streamed/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import { afterAll, expect, test } from 'vitest'; | ||
| import { cleanupChildProcesses, createRunner } from '../../utils/runner'; | ||
| afterAll(() => { | ||
| cleanupChildProcesses(); | ||
| }); | ||
| test('nodeContextIntegration sets context attributes on segment spans', async () => { | ||
| await createRunner(__dirname, 'scenario.ts') | ||
| .expect({ | ||
| span: container => { | ||
| const segmentSpan = container.items.find(s => !!s.is_segment); | ||
| expect(segmentSpan).toBeDefined(); | ||
| const attrs = segmentSpan!.attributes!; | ||
| // Static attributes | ||
| expect(attrs['app.start_time']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| // TODO: device.archs is an array and currently dropped during serialization | ||
| // expect(attrs['device.archs']).toEqual({ type: 'array', value: [expect.any(String)] }); | ||
| expect(attrs['device.boot_time']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| expect(attrs['device.processor_count']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| expect(attrs['device.cpu_description']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| expect(attrs['device.processor_frequency']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| expect(attrs['device.memory_size']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| expect(attrs['culture.locale']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| expect(attrs['culture.timezone']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| expect(attrs['process.runtime.engine.name']).toEqual({ type: 'string', value: 'v8' }); | ||
| expect(attrs['process.runtime.engine.version']).toEqual({ type: 'string', value: expect.any(String) }); | ||
| // Dynamic attributes | ||
| expect(attrs['app.memory']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| expect(attrs['device.free_memory']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| // process.availableMemory is only available in Node 22+ | ||
| if (typeof (process as any).availableMemory === 'function') { | ||
| expect(attrs['app.free_memory']).toEqual({ type: 'integer', value: expect.any(Number) }); | ||
| } | ||
| }, | ||
| }) | ||
| .start() | ||
| .completed(); | ||
| }); |
39 changes: 30 additions & 9 deletions
39 dev-packages/node-integration-tests/suites/public-api/startSpan/basic-usage-streamed/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -15,7 +15,7 @@ import type { | ||
| IntegrationFn, | ||
| OsContext, | ||
| } from '@sentry/core'; | ||
| import { defineIntegration } from '@sentry/core'; | ||
| import { defineIntegration, safeSetSpanJSONAttributes } from '@sentry/core'; | ||
| export const readFileAsync = promisify(readFile); | ||
| export const readDirAsync = promisify(readdir); | ||
| @@ -42,8 +42,6 @@ interface ContextOptions { | ||
| } | ||
| const _nodeContextIntegration = ((options: ContextOptions = {}) => { | ||
| let cachedContext: Promise<Contexts> | undefined; | ||
| const _options = { | ||
| app: true, | ||
| os: true, | ||
| @@ -53,13 +51,56 @@ const _nodeContextIntegration = ((options: ContextOptions = {}) => { | ||
| ...options, | ||
| }; | ||
| /** Add contexts to the event. Caches the context so we only look it up once. */ | ||
| async function addContext(event: Event): Promise<Event> { | ||
| if (cachedContext === undefined) { | ||
| cachedContext = _getContexts(); | ||
| // Compute contexts eagerly (shared between tx and span paths) | ||
| const appContext = _options.app ? getAppContext() : undefined; | ||
| const deviceContext = _options.device ? getDeviceContext(_options.device) : undefined; | ||
| const cultureContext = _options.culture ? getCultureContext() : undefined; | ||
| const cloudResourceContext = _options.cloudResource ? getCloudResourceContext() : undefined; | ||
| const osContextPromise = _options.os ? getOsContext() : undefined; | ||
| // Map static context data to span attributes | ||
| const cachedSpanAttributes: Record<string, unknown> = { | ||
| 'process.runtime.engine.name': 'v8', | ||
| 'process.runtime.engine.version': process.versions.v8, | ||
| ...contextsToSpanAttributes({ | ||
| app: appContext, | ||
| device: deviceContext, | ||
| culture: cultureContext, | ||
| cloud_resource: cloudResourceContext, | ||
| }), | ||
| }; | ||
| if (osContextPromise) { | ||
| osContextPromise | ||
| .then(osCtx => Object.assign(cachedSpanAttributes, contextsToSpanAttributes({ os: osCtx }))) | ||
| .catch(() => { | ||
| // Ignore - os attributes will be undefined | ||
| }); | ||
| } | ||
| // Build contexts for event processing (reuses same data, awaits async OS context) | ||
| const contextsPromise: Promise<Contexts> = (async () => { | ||
| const contexts: Contexts = {}; | ||
| if (osContextPromise) { | ||
| contexts.os = await osContextPromise; | ||
| } | ||
| if (appContext) { | ||
| contexts.app = appContext; | ||
| } | ||
| if (deviceContext) { | ||
| contexts.device = deviceContext; | ||
| } | ||
| if (cultureContext) { | ||
| contexts.culture = cultureContext; | ||
| } | ||
| if (cloudResourceContext) { | ||
| contexts.cloud_resource = cloudResourceContext; | ||
| } | ||
| return contexts; | ||
| })(); | ||
| const updatedContext = _updateContext(await cachedContext); | ||
| async function addContext(event: Event): Promise<Event> { | ||
| const updatedContext = _updateContext(await contextsPromise); | ||
| // TODO(v11): conditional with `sendDefaultPii` here? | ||
| event.contexts = { | ||
| @@ -74,42 +115,15 @@ const _nodeContextIntegration = ((options: ContextOptions = {}) => { | ||
| return event; | ||
| } | ||
| /** Get the contexts from node. */ | ||
| async function _getContexts(): Promise<Contexts> { | ||
| const contexts: Contexts = {}; | ||
| if (_options.os) { | ||
| contexts.os = await getOsContext(); | ||
| } | ||
| if (_options.app) { | ||
| contexts.app = getAppContext(); | ||
| } | ||
| if (_options.device) { | ||
| contexts.device = getDeviceContext(_options.device); | ||
| } | ||
| if (_options.culture) { | ||
| const culture = getCultureContext(); | ||
| if (culture) { | ||
| contexts.culture = culture; | ||
| } | ||
| } | ||
| if (_options.cloudResource) { | ||
| contexts.cloud_resource = getCloudResourceContext(); | ||
| } | ||
| return contexts; | ||
| } | ||
| return { | ||
| name: INTEGRATION_NAME, | ||
| processEvent(event) { | ||
| return addContext(event); | ||
| }, | ||
| processSegmentSpan(span) { | ||
| safeSetSpanJSONAttributes(span, cachedSpanAttributes); | ||
chargome marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| safeSetSpanJSONAttributes(span, getDynamicSpanAttributes(appContext, deviceContext)); | ||
| }, | ||
| }; | ||
| }) satisfies IntegrationFn; | ||
| @@ -142,6 +156,98 @@ function _updateContext(contexts: Contexts): Contexts { | ||
| return contexts; | ||
| } | ||
| export function contextsToSpanAttributes(contexts: Contexts): Record<string, unknown> { | ||
| const attrs: Record<string, unknown> = {}; | ||
| const { app, device, os: osCtx, culture, cloud_resource } = contexts; | ||
| if (app) { | ||
| if (app.app_start_time) { | ||
| attrs['app.start_time'] = app.app_start_time; | ||
| } | ||
| } | ||
| if (device) { | ||
| if (device.arch) { | ||
| attrs['device.archs'] = [device.arch]; | ||
| } | ||
chargome marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if (device.boot_time) { | ||
| attrs['device.boot_time'] = device.boot_time; | ||
| } | ||
| if (device.memory_size != null) { | ||
| attrs['device.memory_size'] = device.memory_size; | ||
| } | ||
| if (device.processor_count != null) { | ||
| attrs['device.processor_count'] = device.processor_count; | ||
| } | ||
| if (device.cpu_description) { | ||
| attrs['device.cpu_description'] = device.cpu_description; | ||
| } | ||
| if (device.processor_frequency != null) { | ||
| attrs['device.processor_frequency'] = device.processor_frequency; | ||
| } | ||
| } | ||
| if (osCtx) { | ||
| if (osCtx.name) { | ||
| attrs['os.name'] = osCtx.name; | ||
| } | ||
| if (osCtx.version) { | ||
| attrs['os.version'] = osCtx.version; | ||
| } | ||
| if (osCtx.kernel_version) { | ||
| attrs['os.kernel_version'] = osCtx.kernel_version; | ||
| } | ||
| if (osCtx.build) { | ||
| attrs['os.build'] = osCtx.build; | ||
| } | ||
| } | ||
| if (culture) { | ||
| if (culture.locale) { | ||
| attrs['culture.locale'] = culture.locale; | ||
| } | ||
| if (culture.timezone) { | ||
| attrs['culture.timezone'] = culture.timezone; | ||
| } | ||
| } | ||
| // CloudResourceContext already uses dot-notation keys matching span attribute conventions | ||
| if (cloud_resource) { | ||
| for (const [key, value] of Object.entries(cloud_resource)) { | ||
| if (value != null) { | ||
| attrs[key] = value; | ||
| } | ||
| } | ||
| } | ||
| return attrs; | ||
| } | ||
| export function getDynamicSpanAttributes( | ||
| appContext: AppContext | undefined, | ||
| deviceContext: DeviceContext | undefined, | ||
| ): Record<string, unknown> { | ||
| const attrs: Record<string, unknown> = {}; | ||
| if (appContext) { | ||
| attrs['app.memory'] = process.memoryUsage().rss; | ||
| if (typeof (process as ProcessWithCurrentValues).availableMemory === 'function') { | ||
| const freeMemory = (process as ProcessWithCurrentValues).availableMemory?.(); | ||
| if (freeMemory != null) { | ||
| attrs['app.free_memory'] = freeMemory; | ||
| } | ||
| } | ||
| } | ||
| // Only include if memory tracking was initially enabled (indicated by free_memory being set) | ||
| if (deviceContext?.free_memory != null) { | ||
| attrs['device.free_memory'] = os.freemem(); | ||
| } | ||
| return attrs; | ||
| } | ||
| /** | ||
| * Returns the operating system context. | ||
| * | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.