Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(node): Add logging public APIs to Node SDKs by AbhiPrasad · Pull Request #15764 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
withScope,
zodErrorsIntegration,
profiler,
logger,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
3 changes: 3 additions & 0 deletions packages/astro/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type { NodeOptions } from '@sentry/node';
import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './index.client';
import type * as serverSdk from './index.server';
import sentryAstro from './index.server';

/** Initializes Sentry Astro SDK */
Expand All@@ -26,4 +27,6 @@ export declare function flush(timeout?: number | undefined): PromiseLike<boolean

export declare const Span: clientSdk.Span;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export default sentryAstro;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,7 @@ export {
profiler,
amqplibIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import type {
FeedbackEvent,
FetchBreadcrumbHint,
Integration,
Log,
MonitorConfig,
Outcome,
ParameterizedString,
Expand DownExpand Up@@ -621,6 +622,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public on(hook: 'close', callback: () => void): () => void;

/**
* A hook that is called before a log is captured
*
* @returns {() => void} A function that, when executed, removes the registered callback.
*/
public on(hook: 'beforeCaptureLog', callback: (log: Log) => void): () => void;

/**
* Register a hook on this client.
*/
Expand DownExpand Up@@ -768,6 +776,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'close'): void;

/**
* Emit a hook event for client before capturing a log
*/
public emit(hook: 'beforeCaptureLog', log: Log): void;

/**
* Emit a hook that was previously registered via `on()`.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/core/src/logs/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,14 +110,14 @@ export function _INTERNAL_captureLog(log: Log, client = getClient(), scope = get
const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
if (logBuffer === undefined) {
CLIENT_TO_LOG_BUFFER_MAP.set(client, [serializedLog]);
// Every time we initialize a new log buffer, we start a new interval to flush the buffer
return;
} else {
logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
}

logBuffer.push(serializedLog);
if (logBuffer.length > MAX_LOG_BUFFER_SIZE) {
_INTERNAL_flushLogsBuffer(client, logBuffer);
}
client.emit('beforeCaptureLog', log);
}

/**
Expand Down
68 changes: 68 additions & 0 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,10 @@ import type {
ClientOptions,
Event,
EventHint,
Log,
MonitorConfig,
ParameterizedString,
Primitive,
SerializedCheckIn,
SeverityLevel,
} from './types-hoist';
Expand All@@ -20,6 +22,8 @@ import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuil
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _INTERNAL_flushLogsBuffer } from './logs';
import { isPrimitive } from './utils-hoist';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand All@@ -33,6 +37,8 @@ export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportO
export class ServerRuntimeClient<
O extends ClientOptions & ServerRuntimeClientOptions = ServerRuntimeClientOptions,
> extends Client<O> {
private _logWeight: number;

/**
* Creates a new Edge SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -42,6 +48,26 @@ export class ServerRuntimeClient<
registerSpanErrorInstrumentation();

super(options);

this._logWeight = 0;

// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(client);
});

this.on('beforeCaptureLog', log => {
client._logWeight += estimateLogSizeInBytes(log);

// We flush the logs buffer if it exceeds 0.8 MB
// The log weight is a rough estimate, so we flush way before
// the payload gets too big.
if (client._logWeight > 800_000) {
_INTERNAL_flushLogsBuffer(client);
client._logWeight = 0;
}
});
}

/**
Expand DownExpand Up@@ -196,3 +222,45 @@ function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
}
}
}

/**
* Estimate the size of a log in bytes.
*
* @param log - The log to estimate the size of.
* @returns The estimated size of the log in bytes.
*/
function estimateLogSizeInBytes(log: Log): number {
let weight = 0;

// Estimate byte size of 2 bytes per character. This is a rough estimate JS strings are stored as UTF-16.
if (log.message) {
weight += log.message.length * 2;
}

if (log.attributes) {
Object.values(log.attributes).forEach(value => {
if (Array.isArray(value)) {
weight += value.length * estimatePrimitiveSizeInBytes(value[0]);
} else if (isPrimitive(value)) {
weight += estimatePrimitiveSizeInBytes(value);
} else {
// For objects values, we estimate the size of the object as 100 bytes
weight += 100;
}
});
}

return weight;
}

function estimatePrimitiveSizeInBytes(value: Primitive): number {
if (typeof value === 'string') {
return value.length * 2;
} else if (typeof value === 'number') {
return 8;
} else if (typeof value === 'boolean') {
return 4;
}

return 0;
}
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/log.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ export interface Log {
/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: Record<string, string | number | boolean | Array<string | number | boolean>>;
attributes?: Record<string, unknown>;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export {
amqplibIntegration,
childProcessIntegration,
vercelAIIntegration,
logger,
} from '@sentry/node';

export {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,8 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;

export declare const logger: typeof clientSdk.logger | typeof serverSdk.logger;

export { withSentryConfig } from './config';

/**
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,3 +150,7 @@ export type {
User,
Span,
} from '@sentry/core';

import * as logger from './log';

export { logger };
Loading