Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
215 lines
7.6 KiB
Plaintext
215 lines
7.6 KiB
Plaintext
import { serializeAttributes } from '../attributes.js';
|
|
import { getGlobalSingleton } from '../carrier.js';
|
|
import { getClient, getIsolationScope, getCurrentScope } from '../currentScopes.js';
|
|
import { DEBUG_BUILD } from '../debug-build.js';
|
|
import { debug, consoleSandbox } from '../utils/debug-logger.js';
|
|
import { isParameterizedString } from '../utils/is.js';
|
|
import { getCombinedScopeData } from '../utils/scopeData.js';
|
|
import { _getSpanForScope } from '../utils/spanOnScope.js';
|
|
import { timestampInSeconds } from '../utils/time.js';
|
|
import { _getTraceInfoFromScope } from '../utils/trace-info.js';
|
|
import { SEVERITY_TEXT_TO_SEVERITY_NUMBER } from './constants.js';
|
|
import { createLogEnvelope } from './envelope.js';
|
|
|
|
const MAX_LOG_BUFFER_SIZE = 100;
|
|
|
|
/**
|
|
* Sets a log attribute if the value exists and the attribute key is not already present.
|
|
*
|
|
* @param logAttributes - The log attributes object to modify.
|
|
* @param key - The attribute key to set.
|
|
* @param value - The value to set (only sets if truthy and key not present).
|
|
* @param setEvenIfPresent - Whether to set the attribute if it is present. Defaults to true.
|
|
*/
|
|
function setLogAttribute(
|
|
logAttributes,
|
|
key,
|
|
value,
|
|
setEvenIfPresent = true,
|
|
) {
|
|
if (value && (!logAttributes[key] || setEvenIfPresent)) {
|
|
logAttributes[key] = value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Captures a serialized log event and adds it to the log buffer for the given client.
|
|
*
|
|
* @param client - A client. Uses the current client if not provided.
|
|
* @param serializedLog - The serialized log event to capture.
|
|
*
|
|
* @experimental This method will experience breaking changes. This is not yet part of
|
|
* the stable Sentry SDK API and can be changed or removed without warning.
|
|
*/
|
|
function _INTERNAL_captureSerializedLog(client, serializedLog) {
|
|
const bufferMap = _getBufferMap();
|
|
const logBuffer = _INTERNAL_getLogBuffer(client);
|
|
|
|
if (logBuffer === undefined) {
|
|
bufferMap.set(client, [serializedLog]);
|
|
} else {
|
|
if (logBuffer.length >= MAX_LOG_BUFFER_SIZE) {
|
|
_INTERNAL_flushLogsBuffer(client, logBuffer);
|
|
bufferMap.set(client, [serializedLog]);
|
|
} else {
|
|
bufferMap.set(client, [...logBuffer, serializedLog]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Captures a log event and sends it to Sentry.
|
|
*
|
|
* @param log - The log event to capture.
|
|
* @param scope - A scope. Uses the current scope if not provided.
|
|
* @param client - A client. Uses the current client if not provided.
|
|
* @param captureSerializedLog - A function to capture the serialized log.
|
|
*
|
|
* @experimental This method will experience breaking changes. This is not yet part of
|
|
* the stable Sentry SDK API and can be changed or removed without warning.
|
|
*/
|
|
function _INTERNAL_captureLog(
|
|
beforeLog,
|
|
currentScope = getCurrentScope(),
|
|
captureSerializedLog = _INTERNAL_captureSerializedLog,
|
|
) {
|
|
const client = currentScope?.getClient() ?? getClient();
|
|
if (!client) {
|
|
DEBUG_BUILD && debug.warn('No client available to capture log.');
|
|
return;
|
|
}
|
|
|
|
const { release, environment, enableLogs = false, beforeSendLog } = client.getOptions();
|
|
if (!enableLogs) {
|
|
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
|
|
return;
|
|
}
|
|
|
|
const [, traceContext] = _getTraceInfoFromScope(client, currentScope);
|
|
|
|
const processedLogAttributes = {
|
|
...beforeLog.attributes,
|
|
};
|
|
|
|
const {
|
|
user: { id, email, username },
|
|
attributes: scopeAttributes = {},
|
|
} = getCombinedScopeData(getIsolationScope(), currentScope);
|
|
|
|
setLogAttribute(processedLogAttributes, 'user.id', id, false);
|
|
setLogAttribute(processedLogAttributes, 'user.email', email, false);
|
|
setLogAttribute(processedLogAttributes, 'user.name', username, false);
|
|
|
|
setLogAttribute(processedLogAttributes, 'sentry.release', release);
|
|
setLogAttribute(processedLogAttributes, 'sentry.environment', environment);
|
|
|
|
const { name, version } = client.getSdkMetadata()?.sdk ?? {};
|
|
setLogAttribute(processedLogAttributes, 'sentry.sdk.name', name);
|
|
setLogAttribute(processedLogAttributes, 'sentry.sdk.version', version);
|
|
|
|
const replay = client.getIntegrationByName
|
|
|
|
('Replay');
|
|
|
|
const replayId = replay?.getReplayId(true);
|
|
setLogAttribute(processedLogAttributes, 'sentry.replay_id', replayId);
|
|
|
|
if (replayId && replay?.getRecordingMode() === 'buffer') {
|
|
// We send this so we can identify cases where the replayId is attached but the replay itself might not have been sent to Sentry
|
|
setLogAttribute(processedLogAttributes, 'sentry._internal.replay_is_buffering', true);
|
|
}
|
|
|
|
const beforeLogMessage = beforeLog.message;
|
|
if (isParameterizedString(beforeLogMessage)) {
|
|
const { __sentry_template_string__, __sentry_template_values__ = [] } = beforeLogMessage;
|
|
if (__sentry_template_values__?.length) {
|
|
processedLogAttributes['sentry.message.template'] = __sentry_template_string__;
|
|
}
|
|
__sentry_template_values__.forEach((param, index) => {
|
|
processedLogAttributes[`sentry.message.parameter.${index}`] = param;
|
|
});
|
|
}
|
|
|
|
const span = _getSpanForScope(currentScope);
|
|
// Add the parent span ID to the log attributes for trace context
|
|
setLogAttribute(processedLogAttributes, 'sentry.trace.parent_span_id', span?.spanContext().spanId);
|
|
|
|
const processedLog = { ...beforeLog, attributes: processedLogAttributes };
|
|
|
|
client.emit('beforeCaptureLog', processedLog);
|
|
|
|
// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
|
|
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
|
|
if (!log) {
|
|
client.recordDroppedEvent('before_send', 'log_item', 1);
|
|
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
|
|
return;
|
|
}
|
|
|
|
const { level, message, attributes: logAttributes = {}, severityNumber } = log;
|
|
|
|
const serializedLog = {
|
|
timestamp: timestampInSeconds(),
|
|
level,
|
|
body: message,
|
|
trace_id: traceContext?.trace_id,
|
|
severity_number: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
|
|
attributes: {
|
|
...serializeAttributes(scopeAttributes),
|
|
...serializeAttributes(logAttributes, true),
|
|
},
|
|
};
|
|
|
|
captureSerializedLog(client, serializedLog);
|
|
|
|
client.emit('afterCaptureLog', log);
|
|
}
|
|
|
|
/**
|
|
* Flushes the logs buffer to Sentry.
|
|
*
|
|
* @param client - A client.
|
|
* @param maybeLogBuffer - A log buffer. Uses the log buffer for the given client if not provided.
|
|
*
|
|
* @experimental This method will experience breaking changes. This is not yet part of
|
|
* the stable Sentry SDK API and can be changed or removed without warning.
|
|
*/
|
|
function _INTERNAL_flushLogsBuffer(client, maybeLogBuffer) {
|
|
const logBuffer = maybeLogBuffer ?? _INTERNAL_getLogBuffer(client) ?? [];
|
|
if (logBuffer.length === 0) {
|
|
return;
|
|
}
|
|
|
|
const clientOptions = client.getOptions();
|
|
const envelope = createLogEnvelope(logBuffer, clientOptions._metadata, clientOptions.tunnel, client.getDsn());
|
|
|
|
// Clear the log buffer after envelopes have been constructed.
|
|
_getBufferMap().set(client, []);
|
|
|
|
client.emit('flushLogs');
|
|
|
|
// sendEnvelope should not throw
|
|
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
client.sendEnvelope(envelope);
|
|
}
|
|
|
|
/**
|
|
* Returns the log buffer for a given client.
|
|
*
|
|
* Exported for testing purposes.
|
|
*
|
|
* @param client - The client to get the log buffer for.
|
|
* @returns The log buffer for the given client.
|
|
*/
|
|
function _INTERNAL_getLogBuffer(client) {
|
|
return _getBufferMap().get(client);
|
|
}
|
|
|
|
function _getBufferMap() {
|
|
// The reference to the Client <> LogBuffer map is stored on the carrier to ensure it's always the same
|
|
return getGlobalSingleton('clientToLogBufferMap', () => new WeakMap());
|
|
}
|
|
|
|
export { _INTERNAL_captureLog, _INTERNAL_captureSerializedLog, _INTERNAL_flushLogsBuffer, _INTERNAL_getLogBuffer };
|
|
//# sourceMappingURL=internal.js.map
|