Skip to content

feat(core): Add types for logs protocol and envelope#15530

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 2 commits into from
Feb 28, 2025
Merged

feat(core): Add types for logs protocol and envelope #15530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0151813
feat(core): Add types for logs protocol and envelope
AbhiPrasad Feb 27, 2025
d0a02a9
Merge branch 'develop' into abhi-log-envelope
AbhiPrasad Feb 28, 2025
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
9 changes: 8 additions & 1 deletion packages/core/src/types-hoist/envelope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
| 'replay_recording'
| 'check_in'
| 'span'
| 'otel_log'
| 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
| EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
| ReplayEnvelope
| CheckInEnvelope
| SpanEnvelope
| RawSecurityEnvelope;
| RawSecurityEnvelope
| LogEnvelope;

export type EnvelopeItem = Envelope[1][number];
1 change: 1 addition & 0 deletions packages/core/src/types-hoist/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down
64 changes: 64 additions & 0 deletions packages/core/src/types-hoist/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
| {
stringValue: string;
}
| {
intValue: number;
}
| {
boolValue: boolean;
}
| {
doubleValue: number;
};

export type LogAttribute = {
key: string;
value: LogAttributeValueType;
};

export interface Log {
/**
* The severity level of the log.
*
* Allowed values are, from highest to lowest:
* `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.

@chargomechargomeFeb 28, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?

@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields

According to their spec, trace is used for:

A fine-grained debugging event. Typically disabled in default configurations.

*
* The log level changes how logs are filtered and displayed.
* Critical level logs are emphasized more than trace level logs.
*/
severityText?: LogSeverityLevel;

/**
* The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
*/
severityNumber?: number;

/**
* The trace ID for this log
*/
traceId?: string;

/**
* The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
*/
body: {
stringValue: string;
};

/**
* Arbitrary structured data that stores information about the log - e.g., userId: 100.
*/
attributes?: LogAttribute[];

/**
* This doesn't have to be explicitly specified most of the time. If you need to set it, the value
* is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
*
* @summary A timestamp representing when the log occurred.
* @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
*/
timeUnixNano?: string;
}
1 change: 1 addition & 0 deletions packages/core/src/utils-hoist/envelope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
feedback: 'feedback',
span: 'span',
raw_security: 'security',
otel_log: 'log_item',
};

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add types for logs protocol and envelope by AbhiPrasad · Pull Request #15530 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add types for logs protocol and envelope#15530

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add types for logs protocol and envelope by AbhiPrasad · Pull Request #15530 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add types for logs protocol and envelope#15530

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(core): Add types for logs protocol and envelope by AbhiPrasad · Pull Request #15530 · getsentry/sentry-javascript · GitHub
Skip to content
feat(core): Add types for logs protocol and envelope#15530

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 2 commits into

from

Feb 28, 2025
 Merged


feat(core): Add types for logs protocol and envelope
#15530
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0151813

feat(core): Add types for logs protocol and envelope


AbhiPrasad Feb 27, 2025
d0a02a9

Merge branch 'develop' into abhi-log-envelope


AbhiPrasad Feb 28, 2025

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


9 changes: 8 additions & 1 deletion
packages/core/src/types-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { LegacyCSPReport } from './csp';
import type { DsnComponents } from './dsn';
import type { Event } from './event';
import type { FeedbackEvent, UserFeedback } from './feedback';
import type { Log } from './log';
import type { Profile, ProfileChunk } from './profiling';
import type { ReplayEvent, ReplayRecordingData } from './replay';
import type { SdkInfo } from './sdkinfo';
Expand DownExpand Up@@ -43,6 +44,7 @@ export type EnvelopeItemType =
 | 'replay_recording'
 | 'check_in'
 | 'span'
 | 'otel_log'
 | 'raw_security';

export type BaseEnvelopeHeaders = {
Expand DownExpand Up@@ -85,6 +87,7 @@ type CheckInItemHeaders = { type: 'check_in' };
type ProfileItemHeaders = { type: 'profile' };
type ProfileChunkItemHeaders = { type: 'profile_chunk' };
type SpanItemHeaders = { type: 'span' };
type LogItemHeaders = { type: 'otel_log' };
type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };

export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
Expand All@@ -101,6 +104,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
export type LogItem = BaseEnvelopeItem<LogItemHeaders, Log>;
export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
Expand All@@ -109,6 +113,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
type LogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };

export type EventEnvelope = BaseEnvelope<
 EventEnvelopeHeaders,
Expand All@@ -121,6 +126,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogItem>;

export type Envelope =
 | EventEnvelope
Expand All@@ -130,6 +136,7 @@ export type Envelope =
 | ReplayEnvelope
 | CheckInEnvelope
 | SpanEnvelope
 | RawSecurityEnvelope;
 | RawSecurityEnvelope
 | LogEnvelope;

export type EnvelopeItem = Envelope[1][number];

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ export type {
 TraceFlag,
} from './span';
export type { SpanStatus } from './spanStatus';
export type { Log, LogAttribute, LogSeverityLevel, LogAttributeValueType } from './log';
export type { TimedEvent } from './timedEvent';
export type { StackFrame } from './stackframe';
export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
Expand Down

64 changes: 64 additions & 0 deletions
packages/core/src/types-hoist/log.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'critical';

export type LogAttributeValueType =
 | {
 stringValue: string;
 }
 | {
 intValue: number;
 }
 | {
 boolValue: boolean;
 }
 | {
 doubleValue: number;
 };

export type LogAttribute = {
 key: string;
 value: LogAttributeValueType;
};

export interface Log {
 /**
 * The severity level of the log.
 *
 * Allowed values are, from highest to lowest:
 * `critical`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`.
@chargomechargomeFeb 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Can you remind me what level trace would be used for?
@AbhiPrasadAbhiPrasadFeb 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is taken from the OTEL spec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#severity-fields
According to their spec, trace is used for:
A fine-grained debugging event. Typically disabled in default configurations.
 *
 * The log level changes how logs are filtered and displayed.
 * Critical level logs are emphasized more than trace level logs.
 */
 severityText?: LogSeverityLevel;

 /**
 * The severity number - generally higher severity are levels like 'error' and lower are levels like 'debug'
 */
 severityNumber?: number;

 /**
 * The trace ID for this log
 */
 traceId?: string;

 /**
 * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
 */
 body: {
 stringValue: string;
 };

 /**
 * Arbitrary structured data that stores information about the log - e.g., userId: 100.
 */
 attributes?: LogAttribute[];

 /**
 * This doesn't have to be explicitly specified most of the time. If you need to set it, the value
 * is the number of seconds since midnight on January 1, 1970 ("unix epoch time")
 *
 * @summary A timestamp representing when the log occurred.
 * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
 */
 timeUnixNano?: string;
}

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -223,6 +223,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
};

/**
Expand Down