feat(winston): Add customLevelMap for winston transport#18922

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
JPeer264 merged 4 commits into from
Jan 27, 2026
Merged

feat(winston): Add customLevelMap for winston transport #18922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ef1584
feat(winston): Add customLevelMap for winston transport
JPeer264 Jan 21, 2026
e388d33
fixup! feat(winston): Add customLevelMap for winston transport
JPeer264 Jan 26, 2026
f662b63
fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9
JPeer264 Jan 26, 2026
c2dece0
fixup! feat(winston): Add customLevelMap for winston transport
JPeer264 Jan 26, 2026
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
76 changes: 76 additions & 0 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
environment: 'test',
enableLogs: true,
transport: loggingTransport,
debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
});
}

if (process.env.WITH_FILTER === 'true') {
const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
levels: ['error'],
});
const filteredLogger = winston.createLogger({
transports: [new FilteredSentryWinstonTransport()],
});

filteredLogger.info('Ignored message');
filteredLogger.error('Test error message');
}

// If unmapped custom level is requested (tests debug line for unknown levels)
if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
const customLevels = {
levels: {
myUnknownLevel: 0,
error: 1,
},
};

// Create transport WITHOUT customLevelMap for myUnknownLevel
// myUnknownLevel will default to 'info', but we only capture 'error'
const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
levels: ['error'],
});

const unmappedLogger = winston.createLogger({
levels: customLevels.levels,
level: 'error',
transports: [new UnmappedSentryWinstonTransport()],
});

// This should NOT be captured (unknown level defaults to 'info', which is not in levels)
// @ts-ignore - custom levels are not part of the winston logger
unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
// This SHOULD be captured
unmappedLogger.error('This error message should be captured');
}

// If custom level mapping is requested
if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
const customLevels = {
levels: {
customCritical: 0,
customWarning: 1,
customNotice: 2,
},
};

const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
customLevelMap: {
customCritical: 'fatal',
customWarning: 'warn',
customNotice: 'info',
},
});

const mappedLogger = winston.createLogger({
levels: customLevels.levels,
// https://github.com/winstonjs/winston/issues/1491
// when custom levels are set with a transport,
// the level must be set on the logger
level: 'customNotice',
transports: [new SentryWinstonTransport()],
});

// @ts-ignore - custom levels are not part of the winston logger
mappedLogger.customCritical('This is a critical message');
// @ts-ignore - custom levels are not part of the winston logger
mappedLogger.customWarning('This is a warning message');
// @ts-ignore - custom levels are not part of the winston logger
mappedLogger.customNotice('This is a notice message');
}

await Sentry.flush();
}

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

test("should capture winston logs with filter but don't show custom level warnings", async () => {
const runner = createRunner(__dirname, 'subject.ts')
.withEnv({ WITH_FILTER: 'true' })
.expect({
log: {
items: [
{
timestamp: expect.any(Number),
level: 'info',
body: 'Test info message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'error',
body: 'Test error message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'error',
body: 'Test error message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
],
},
})
.start();

await runner.completed();

const logs = runner.getLogs();

const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

expect(warning).not.toBeDefined();
});

test('should capture winston logs with metadata', async () => {
const runner = createRunner(__dirname, 'subject.ts')
.withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

await runner.completed();
});

test('should skip unmapped custom levels when not in the levels option', async () => {
const runner = createRunner(__dirname, 'subject.ts')
.withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
.expect({
log: {
items: [
// First, the default logger captures info and error
{
timestamp: expect.any(Number),
level: 'info',
body: 'Test info message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'error',
body: 'Test error message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
// Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
{
timestamp: expect.any(Number),
level: 'error',
body: 'This error message should be captured',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
],
},
})
.start();

await runner.completed();

const logs = runner.getLogs();

const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

expect(warning).toBeDefined();
});

test('should map custom winston levels to Sentry severity levels', async () => {
const runner = createRunner(__dirname, 'subject.ts')
.withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
.expect({
log: {
items: [
// First, the default logger captures info and error
{
timestamp: expect.any(Number),
level: 'info',
body: 'Test info message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'error',
body: 'Test error message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
// Then the mapped logger uses custom level mappings
{
timestamp: expect.any(Number),
level: 'fatal', // 'critical' maps to 'fatal'
body: 'This is a critical message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'warn', // 'warning' maps to 'warn'
body: 'This is a warning message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'info', // 'notice' maps to 'info'
body: 'This is a notice message',
severity_number: expect.any(Number),
trace_id: expect.any(String),
attributes: {
'sentry.origin': { value: 'auto.log.winston', type: 'string' },
'sentry.release': { value: '1.0.0', type: 'string' },
'sentry.environment': { value: 'test', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'server.address': { value: expect.any(String), type: 'string' },
},
},
],
},
})
.start();

await runner.completed();
});
});
27 changes: 26 additions & 1 deletion packages/node-core/src/integrations/winston.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
* ```
*/
levels?: Array<LogSeverityLevel>;

/**
* Use this option to map custom levels to Sentry log severity levels.
*
* @example
* ```ts
* const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
* customLevelMap: {
* myCustomLevel: 'info',
* customError: 'error',
* },
* });
* ```
*/
customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
attributes[MESSAGE_SYMBOL] = undefined;
attributes[SPLAT_SYMBOL] = undefined;

const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];

@nicohrubecnicohrubecJan 23, 2026•
edited
Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?

@JPeer264JPeer264Jan 26, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

That could actually make sense

@JPeer264JPeer264Jan 26, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already

const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

if (this._levels.has(logSeverityLevel)) {
captureLog(logSeverityLevel, message as string, {
...attributes,
'sentry.origin': 'auto.log.winston',
});
} else if (!customLevel && !winstonLogLevel) {
DEBUG_BUILD &&
debug.log(
`Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
);
Comment thread
cursor[bot] marked this conversation as resolved.
}
} catch {
// do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
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
feat(winston): Add customLevelMap for winston transport#18922

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

JPeer264
merged 4 commits into

from

Jan 27, 2026
 Merged


feat(winston): Add customLevelMap for winston transport
#18922
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8ef1584

feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 21, 2026
e388d33

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026
f662b63

fix: Switch to ts-ignore. ts-expect-error was introduced in TS3.9


JPeer264 Jan 26, 2026
c2dece0

fixup! feat(winston): Add customLevelMap for winston transport


JPeer264 Jan 26, 2026

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


76 changes: 76 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/subject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ Sentry.init({
 environment: 'test',
 enableLogs: true,
 transport: loggingTransport,
 debug: true,
});

async function run(): Promise<void> {
Expand DownExpand Up@@ -64,6 +65,81 @@ async function run(): Promise<void> {
 });
 }

 if (process.env.WITH_FILTER === 'true') {
 const FilteredSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });
 const filteredLogger = winston.createLogger({
 transports: [new FilteredSentryWinstonTransport()],
 });

 filteredLogger.info('Ignored message');
 filteredLogger.error('Test error message');
 }

 // If unmapped custom level is requested (tests debug line for unknown levels)
 if (process.env.UNMAPPED_CUSTOM_LEVEL === 'true') {
 const customLevels = {
 levels: {
 myUnknownLevel: 0,
 error: 1,
 },
 };

 // Create transport WITHOUT customLevelMap for myUnknownLevel
 // myUnknownLevel will default to 'info', but we only capture 'error'
 const UnmappedSentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 levels: ['error'],
 });

 const unmappedLogger = winston.createLogger({
 levels: customLevels.levels,
 level: 'error',
 transports: [new UnmappedSentryWinstonTransport()],
 });

 // This should NOT be captured (unknown level defaults to 'info', which is not in levels)
 // @ts-ignore - custom levels are not part of the winston logger
 unmappedLogger.myUnknownLevel('This unknown level message should be skipped');
 // This SHOULD be captured
 unmappedLogger.error('This error message should be captured');
 }

 // If custom level mapping is requested
 if (process.env.CUSTOM_LEVEL_MAPPING === 'true') {
 const customLevels = {
 levels: {
 customCritical: 0,
 customWarning: 1,
 customNotice: 2,
 },
 };

 const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 customLevelMap: {
 customCritical: 'fatal',
 customWarning: 'warn',
 customNotice: 'info',
 },
 });

 const mappedLogger = winston.createLogger({
 levels: customLevels.levels,
 // https://github.com/winstonjs/winston/issues/1491
 // when custom levels are set with a transport,
 // the level must be set on the logger
 level: 'customNotice',
 transports: [new SentryWinstonTransport()],
 });

 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customCritical('This is a critical message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customWarning('This is a warning message');
 // @ts-ignore - custom levels are not part of the winston logger
 mappedLogger.customNotice('This is a notice message');
 }

 await Sentry.flush();
}

Expand Down

223 changes: 223 additions & 0 deletions
dev-packages/node-integration-tests/suites/winston/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,71 @@ describe('winston integration', () => {
 await runner.completed();
 });

 test("should capture winston logs with filter but don't show custom level warnings", async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_FILTER: 'true' })
 .expect({
 log: {
 items: [
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level info is not captured by Sentry.'));

 expect(warning).not.toBeDefined();
 });

 test('should capture winston logs with metadata', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ WITH_METADATA: 'true' })
Expand DownExpand Up@@ -183,4 +248,162 @@ describe('winston integration', () => {

 await runner.completed();
 });

 test('should skip unmapped custom levels when not in the levels option', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ UNMAPPED_CUSTOM_LEVEL: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the unmapped logger only captures error (myUnknownLevel defaults to info, which is skipped)
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'This error message should be captured',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();

 const logs = runner.getLogs();

 const warning = logs.find(log => log.includes('Winston log level myUnknownLevel is not captured by Sentry.'));

 expect(warning).toBeDefined();
 });

 test('should map custom winston levels to Sentry severity levels', async () => {
 const runner = createRunner(__dirname, 'subject.ts')
 .withEnv({ CUSTOM_LEVEL_MAPPING: 'true' })
 .expect({
 log: {
 items: [
 // First, the default logger captures info and error
 {
 timestamp: expect.any(Number),
 level: 'info',
 body: 'Test info message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'error',
 body: 'Test error message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 // Then the mapped logger uses custom level mappings
 {
 timestamp: expect.any(Number),
 level: 'fatal', // 'critical' maps to 'fatal'
 body: 'This is a critical message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'warn', // 'warning' maps to 'warn'
 body: 'This is a warning message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 {
 timestamp: expect.any(Number),
 level: 'info', // 'notice' maps to 'info'
 body: 'This is a notice message',
 severity_number: expect.any(Number),
 trace_id: expect.any(String),
 attributes: {
 'sentry.origin': { value: 'auto.log.winston', type: 'string' },
 'sentry.release': { value: '1.0.0', type: 'string' },
 'sentry.environment': { value: 'test', type: 'string' },
 'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
 'sentry.sdk.version': { value: expect.any(String), type: 'string' },
 'server.address': { value: expect.any(String), type: 'string' },
 },
 },
 ],
 },
 })
 .start();

 await runner.completed();
 });
});

27 changes: 26 additions & 1 deletion
packages/node-core/src/integrations/winston.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */
import type { LogSeverityLevel } from '@sentry/core';
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';
import { captureLog } from '../logs/capture';

const DEFAULT_CAPTURED_LEVELS: Array<LogSeverityLevel> = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
Expand All@@ -25,6 +27,21 @@ interface WinstonTransportOptions {
 * ```
 */
 levels?: Array<LogSeverityLevel>;

 /**
 * Use this option to map custom levels to Sentry log severity levels.
 *
 * @example
 * ```ts
 * const SentryWinstonTransport = Sentry.createSentryWinstonTransport(Transport, {
 * customLevelMap: {
 * myCustomLevel: 'info',
 * customError: 'error',
 * },
 * });
 * ```
 */
 customLevelMap?: Record<string, LogSeverityLevel>;
}

/**
Expand DownExpand Up@@ -85,12 +102,20 @@ export function createSentryWinstonTransport<TransportStreamInstance extends obj
 attributes[MESSAGE_SYMBOL] = undefined;
 attributes[SPLAT_SYMBOL] = undefined;

 const logSeverityLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string] ?? 'info';
 const customLevel = sentryWinstonOptions?.customLevelMap?.[levelFromSymbol as string];
@nicohrubecnicohrubecJan 23, 2026•

edited

Loading

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.

m: would it make sense to warn the user in case he provides a sentry level that does not exist?
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That could actually make sense
@JPeer264JPeer264Jan 26, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@nicohrubec I added a debug warning now. This is however only then when levels are overwritten. In all other cases they will default to info already
 const winstonLogLevel = WINSTON_LEVEL_TO_LOG_SEVERITY_LEVEL_MAP[levelFromSymbol as string];
 const logSeverityLevel = customLevel ?? winstonLogLevel ?? 'info';

 if (this._levels.has(logSeverityLevel)) {
 captureLog(logSeverityLevel, message as string, {
 ...attributes,
 'sentry.origin': 'auto.log.winston',
 });
 } else if (!customLevel && !winstonLogLevel) {
 DEBUG_BUILD &&
 debug.log(
 `Winston log level ${levelFromSymbol} is not captured by Sentry. Please add ${levelFromSymbol} to the "customLevelMap" option of the Sentry Winston transport.`,
 );
Comment thread
cursor[bot] marked this conversation as resolved.

 }
 } catch {
 // do nothing
Expand Down
Loading