Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
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
Closed
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
6 changes: 6 additions & 0 deletions packages/browser/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
});
}

if (opts._experiments?.enableLogs) {
setInterval(() => {
this._flushLogsBuffer();
}, 5000);
}

if (this._options.sendDefaultPii) {
this.on('postprocessEvent', addAutoIpAddressToUser);
this.on('beforeSendSession', addAutoIpAddressToSession);
Expand Down
100 changes: 98 additions & 2 deletions packages/core/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ import type {
SpanContextData,
SpanJSON,
StartSpanOptions,
TraceContext,
TransactionEvent,
Transport,
TransportMakeRequestResponse,
Expand All@@ -44,7 +45,10 @@ import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromScope } from './tracing/dynamicSamplingContext';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
} from './tracing/dynamicSamplingContext';
import { createClientReportEnvelope } from './utils-hoist/clientreport';
import { dsnToString, makeDsn } from './utils-hoist/dsn';
import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils-hoist/envelope';
Expand All@@ -57,11 +61,15 @@ import { getPossibleEventMessages } from './utils/eventUtils';
import { merge } from './utils/merge';
import { parseSampleRate } from './utils/parseSampleRate';
import { prepareEvent } from './utils/prepareEvent';
import { showSpanDropWarning } from './utils/spanUtils';
import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
import type { Log, SerializedOtelLog } from './types-hoist/log';
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
import { _getSpanForScope } from './utils/spanOnScope';

const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
const MAX_LOG_BUFFER_SIZE = 100;

/**
* Base implementation for all JavaScript SDK clients.
Expand DownExpand Up@@ -117,6 +125,8 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
// eslint-disable-next-line @typescript-eslint/ban-types
private _hooks: Record<string, Function[]>;

private _logsBuffer: Array<SerializedOtelLog>;

/**
* Initializes this client instance.
*
Expand All@@ -129,6 +139,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this._outcomes = {};
this._hooks = {};
this._eventProcessors = [];
this._logsBuffer = [];

if (options.dsn) {
this._dsn = makeDsn(options.dsn);
Expand DownExpand Up@@ -256,6 +267,58 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;

/**
* Captures a log event and sends it to Sentry.
*
* @param log The log event to capture.
*
* @experimental This method will experience breaking changes. This is not yet part of
* the stable Sentry SDK API and can be changed or removed without warning.
*/
public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
const { _experiments, release, environment } = this.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
return;
}

const [, traceContext] = _getTraceInfoFromScope(this, currentScope);

const logAttributes = {
...attributes,
};

if (release) {
logAttributes.release = release;
}

if (environment) {
logAttributes.environment = environment;
}

const span = _getSpanForScope(currentScope);
if (span) {
// Add the parent span ID to the log attributes for trace context
logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
}

const serializedLog: SerializedOtelLog = {
severityText: level,
body: {
stringValue: message,
},
attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
timeUnixNano: `${new Date().getTime().toString()}000000`,
traceId: traceContext?.trace_id,
severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
};

this._logsBuffer.push(serializedLog);
if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
this._flushLogsBuffer();
}
}

/**
* Get the current Dsn.
*/
Expand DownExpand Up@@ -295,6 +358,7 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
* still events in the queue when the timeout is reached.
*/
public flush(timeout?: number): PromiseLike<boolean> {
this._flushLogsBuffer();
const transport = this._transport;
if (transport) {
this.emit('flush');
Expand DownExpand Up@@ -1136,6 +1200,21 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
this.sendEnvelope(envelope);
}

/**
* Flushes the logs buffer to Sentry.
*/
protected _flushLogsBuffer(): void {
if (this._logsBuffer.length === 0) {
return;
}

const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
this._logsBuffer = [];
// sendEnvelope should not throw
// eslint-disable-next-line @typescript-eslint/no-floating-promises
this.sendEnvelope(envelope);
}

/**
* Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
*/
Expand DownExpand Up@@ -1256,3 +1335,20 @@ function isErrorEvent(event: Event): event is ErrorEvent {
function isTransactionEvent(event: Event): event is TransactionEvent {
return event.type === 'transaction';
}

/** Extract trace information from scope */
export function _getTraceInfoFromScope(
client: Client,
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);
const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(client, scope);
return [dynamicSamplingContext, traceContext];
}
91 changes: 91 additions & 0 deletions packages/core/src/log.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import type {
DsnComponents,
LogSeverityLevel,
SdkMetadata,
SerializedLogAttribute,
SerializedOtelLog,
} from './types-hoist';
import type { OtelLogItem, OtelLogEnvelope } from './types-hoist/envelope';
import { createEnvelope, dsnToString } from './utils-hoist';

export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
trace: 1,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
};

/**
* Convert a log attribute to a serialized log attribute
*
* @param key - The key of the log attribute
* @param value - The value of the log attribute
* @returns The serialized log attribute
*/
export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
switch (typeof value) {
case 'number':
return {
key,
value: { doubleValue: value },
};
case 'boolean':
return {
key,
value: { boolValue: value },
};
case 'string':
return {
key,
value: { stringValue: value },
};
default:
return {
key,
value: { stringValue: JSON.stringify(value) ?? '' },
};
}
}

/**
* Creates envelope item for a single log
*/
export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
const headers: OtelLogItem[0] = {
type: 'otel_log',
};

return [headers, log];
}

/**
* Records a log and sends it to sentry.
*
* Logs represent a message (and optionally some structured data) which provide context for a trace or error.
* Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
*
* @params log - the log object which will be sent
*/
export function createOtelLogEnvelope(
logs: Array<SerializedOtelLog>,
metadata?: SdkMetadata,
tunnel?: string,
dsn?: DsnComponents,
): OtelLogEnvelope {
const headers: OtelLogEnvelope[0] = {};

if (metadata?.sdk) {
headers.sdk = {
name: metadata.sdk.name,
version: metadata.sdk.version,
};
}

if (!!tunnel && !!dsn) {
headers.dsn = dsnToString(dsn);
}

return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
}
33 changes: 4 additions & 29 deletions packages/core/src/server-runtime-client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,32 +2,24 @@ import type {
BaseTransportOptions,
CheckIn,
ClientOptions,
DynamicSamplingContext,
Event,
EventHint,
MonitorConfig,
ParameterizedString,
SerializedCheckIn,
SeverityLevel,
TraceContext,
} from './types-hoist';

import { createCheckInEnvelope } from './checkin';
import { Client } from './client';
import { getIsolationScope, getTraceContextFromScope } from './currentScopes';
import { Client, _getTraceInfoFromScope } from './client';
import { getIsolationScope } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';
import type { Scope } from './scope';
import {
getDynamicSamplingContextFromScope,
getDynamicSamplingContextFromSpan,
registerSpanErrorInstrumentation,
} from './tracing';
import { registerSpanErrorInstrumentation } from './tracing';
import { eventFromMessage, eventFromUnknownInput } from './utils-hoist/eventbuilder';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { resolvedSyncPromise } from './utils-hoist/syncpromise';
import { _getSpanForScope } from './utils/spanOnScope';
import { spanToTraceContext } from './utils/spanUtils';

export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
platform?: string;
Expand DownExpand Up@@ -136,7 +128,7 @@ export class ServerRuntimeClient<
};
}

const [dynamicSamplingContext, traceContext] = this._getTraceInfoFromScope(scope);
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
if (traceContext) {
serializedCheckIn.contexts = {
trace: traceContext,
Expand DownExpand Up@@ -186,23 +178,6 @@ export class ServerRuntimeClient<

return super._prepareEvent(event, hint, currentScope, isolationScope);
}

/** Extract trace information from scope */
protected _getTraceInfoFromScope(
scope: Scope | undefined,
): [dynamicSamplingContext: Partial<DynamicSamplingContext> | undefined, traceContext: TraceContext | undefined] {
if (!scope) {
return [undefined, undefined];
}

const span = _getSpanForScope(scope);

const traceContext = span ? spanToTraceContext(span) : getTraceContextFromScope(scope);
const dynamicSamplingContext = span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromScope(this, scope);
return [dynamicSamplingContext, traceContext];
}
}

function setCurrentRequestSessionErroredOrCrashed(eventHint?: EventHint): void {
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/types-hoist/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,7 +110,12 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { SerializedOtelLog, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type {
LogSeverityLevel,
SerializedOtelLog,
SerializedLogAttribute,
SerializedLogAttributeValueType,
} from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
Loading