Skip to content

fix(effect): Set sentry.origin on logs from SentryEffectLogger #22762

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
Lms24 merged 1 commit into from
Jul 29, 2026
+42 −18
Merged

fix(effect): Set sentry.origin on logs from SentryEffectLogger #22762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions packages/effect/src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { isObjectLike, logger as sentryLogger } from '@sentry/core';
import { isObjectLike, logger as sentryLogger, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as Logger from 'effect/Logger';
import type * as LogLevel from 'effect/LogLevel';

const LOG_ATTRIBUTES = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.log.effect',
};

function getLogLevelTag(logLevel: LogLevel.LogLevel): LogLevel.LogLevel | 'Warning' {
// Effect v4: logLevel is a string literal directly
if (typeof logLevel === 'string') {
Expand Down Expand Up @@ -34,23 +38,23 @@ export const SentryEffectLogger = Logger.make(({ logLevel, message }) => {

switch (tag) {
case 'Fatal':
sentryLogger.fatal(msg);
sentryLogger.fatal(msg, LOG_ATTRIBUTES);
break;
case 'Error':
sentryLogger.error(msg);
sentryLogger.error(msg, LOG_ATTRIBUTES);
break;
case 'Warning': // Effect v3
case 'Warn': // Effect v4
sentryLogger.warn(msg);
sentryLogger.warn(msg, LOG_ATTRIBUTES);
break;
case 'Info':
sentryLogger.info(msg);
sentryLogger.info(msg, LOG_ATTRIBUTES);
break;
case 'Debug':
sentryLogger.debug(msg);
sentryLogger.debug(msg, LOG_ATTRIBUTES);
break;
case 'Trace':
sentryLogger.trace(msg);
sentryLogger.trace(msg, LOG_ATTRIBUTES);
break;
case 'All':
case 'None':
Expand Down
42 changes: 31 additions & 11 deletions packages/effect/test/logger.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ vi.mock('@sentry/core', async importOriginal => {
};
});

const LOG_ATTRIBUTES = { 'sentry.origin': 'auto.log.effect' };

describe('SentryEffectLogger', () => {
afterEach(() => {
vi.clearAllMocks();
Expand All @@ -34,49 +36,49 @@ describe('SentryEffectLogger', () => {
it.effect('forwards fatal logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logFatal('This is a fatal message');
expect(sentryCore.logger.fatal).toHaveBeenCalledWith('This is a fatal message');
expect(sentryCore.logger.fatal).toHaveBeenCalledWith('This is a fatal message', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

it.effect('forwards error logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logError('This is an error message');
expect(sentryCore.logger.error).toHaveBeenCalledWith('This is an error message');
expect(sentryCore.logger.error).toHaveBeenCalledWith('This is an error message', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

it.effect('forwards warning logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logWarning('This is a warning message');
expect(sentryCore.logger.warn).toHaveBeenCalledWith('This is a warning message');
expect(sentryCore.logger.warn).toHaveBeenCalledWith('This is a warning message', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

it.effect('forwards info logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logInfo('This is an info message');
expect(sentryCore.logger.info).toHaveBeenCalledWith('This is an info message');
expect(sentryCore.logger.info).toHaveBeenCalledWith('This is an info message', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

it.effect('forwards debug logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logDebug('This is a debug message');
expect(sentryCore.logger.debug).toHaveBeenCalledWith('This is a debug message');
expect(sentryCore.logger.debug).toHaveBeenCalledWith('This is a debug message', LOG_ATTRIBUTES);
}).pipe(withAllLogLevels, Effect.provide(loggerLayer)),
);

it.effect('forwards trace logs to Sentry', () =>
Effect.gen(function* () {
yield* Effect.logTrace('This is a trace message');
expect(sentryCore.logger.trace).toHaveBeenCalledWith('This is a trace message');
expect(sentryCore.logger.trace).toHaveBeenCalledWith('This is a trace message', LOG_ATTRIBUTES);
}).pipe(withAllLogLevels, Effect.provide(loggerLayer)),
);

it.effect('handles object messages by stringifying', () =>
Effect.gen(function* () {
yield* Effect.logInfo({ key: 'value', nested: { foo: 'bar' } });
expect(sentryCore.logger.info).toHaveBeenCalledWith('{"key":"value","nested":{"foo":"bar"}}');
expect(sentryCore.logger.info).toHaveBeenCalledWith('{"key":"value","nested":{"foo":"bar"}}', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

Expand All @@ -86,9 +88,9 @@ describe('SentryEffectLogger', () => {
yield* Effect.logInfo('Second message');
yield* Effect.logWarning('Third message');
expect(sentryCore.logger.info).toHaveBeenCalledTimes(2);
expect(sentryCore.logger.info).toHaveBeenNthCalledWith(1, 'First message');
expect(sentryCore.logger.info).toHaveBeenNthCalledWith(2, 'Second message');
expect(sentryCore.logger.warn).toHaveBeenCalledWith('Third message');
expect(sentryCore.logger.info).toHaveBeenNthCalledWith(1, 'First message', LOG_ATTRIBUTES);
expect(sentryCore.logger.info).toHaveBeenNthCalledWith(2, 'Second message', LOG_ATTRIBUTES);
expect(sentryCore.logger.warn).toHaveBeenCalledWith('Third message', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

Expand All @@ -99,7 +101,25 @@ describe('SentryEffectLogger', () => {
Effect.map(d => d.toUpperCase()),
);
expect(result).toBe('DATA');
expect(sentryCore.logger.info).toHaveBeenCalledWith('Processing: data');
expect(sentryCore.logger.info).toHaveBeenCalledWith('Processing: data', LOG_ATTRIBUTES);
}).pipe(Effect.provide(loggerLayer)),
);

it.effect('sets the sentry.origin attribute on every log level', () =>
Effect.gen(function* () {
yield* Effect.logFatal('fatal');
yield* Effect.logError('error');
yield* Effect.logWarning('warning');
yield* Effect.logInfo('info');
yield* Effect.logDebug('debug');
yield* Effect.logTrace('trace');

for (const level of ['fatal', 'error', 'warn', 'info', 'debug', 'trace'] as const) {
expect(sentryCore.logger[level]).toHaveBeenCalledWith(
expect.any(String),
expect.objectContaining({ 'sentry.origin': 'auto.log.effect' }),
);
}

@cursor cursor Bot Jul 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Loop over log levels in test

Low Severity

Flagged because it was mentioned in the review rules file: the Testing Conventions rule against loops that cover multiple scenarios in one test. The new origin coverage test iterates log levels in a for loop instead of using it.each / test.each (or separate cases). The per-level cases above already assert LOG_ATTRIBUTES, so this looped case is also largely redundant.

Fix in Cursor Fix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit dd27fc1. Configure here.

@Lms24 Lms24 Jul 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Not sure if effect even supports it.each and my logaf here is really low. if reviewers have more opinions/insights happy to change

}).pipe(withAllLogLevels, Effect.provide(loggerLayer)),
);
});
Loading