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
203 lines
5.9 KiB
Plaintext
203 lines
5.9 KiB
Plaintext
import { createCheckInEnvelope } from './checkin.js';
|
|
import { Client } from './client.js';
|
|
import { getIsolationScope } from './currentScopes.js';
|
|
import { DEBUG_BUILD } from './debug-build.js';
|
|
import { registerSpanErrorInstrumentation } from './tracing/errors.js';
|
|
import { debug } from './utils/debug-logger.js';
|
|
import { uuid4 } from './utils/misc.js';
|
|
import { addUserAgentToTransportHeaders } from './transports/userAgent.js';
|
|
import { eventFromUnknownInput, eventFromMessage } from './utils/eventbuilder.js';
|
|
import { resolvedSyncPromise } from './utils/syncpromise.js';
|
|
import { _getTraceInfoFromScope } from './utils/trace-info.js';
|
|
|
|
/**
|
|
* The Sentry Server Runtime Client SDK.
|
|
*/
|
|
class ServerRuntimeClient
|
|
|
|
extends Client {
|
|
/**
|
|
* Creates a new Edge SDK instance.
|
|
* @param options Configuration options for this SDK.
|
|
*/
|
|
constructor(options) {
|
|
// Server clients always support tracing
|
|
registerSpanErrorInstrumentation();
|
|
|
|
addUserAgentToTransportHeaders(options);
|
|
|
|
super(options);
|
|
|
|
this._setUpMetricsProcessing();
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
eventFromException(exception, hint) {
|
|
const event = eventFromUnknownInput(this, this._options.stackParser, exception, hint);
|
|
event.level = 'error';
|
|
|
|
return resolvedSyncPromise(event);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
eventFromMessage(
|
|
message,
|
|
level = 'info',
|
|
hint,
|
|
) {
|
|
return resolvedSyncPromise(
|
|
eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
captureException(exception, hint, scope) {
|
|
setCurrentRequestSessionErroredOrCrashed(hint);
|
|
return super.captureException(exception, hint, scope);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
captureEvent(event, hint, scope) {
|
|
// If the event is of type Exception, then a request session should be captured
|
|
const isException = !event.type && event.exception?.values && event.exception.values.length > 0;
|
|
if (isException) {
|
|
setCurrentRequestSessionErroredOrCrashed(hint);
|
|
}
|
|
|
|
return super.captureEvent(event, hint, scope);
|
|
}
|
|
|
|
/**
|
|
* Create a cron monitor check in and send it to Sentry.
|
|
*
|
|
* @param checkIn An object that describes a check in.
|
|
* @param upsertMonitorConfig An optional object that describes a monitor config. Use this if you want
|
|
* to create a monitor automatically when sending a check in.
|
|
*/
|
|
captureCheckIn(checkIn, monitorConfig, scope) {
|
|
const id = 'checkInId' in checkIn && checkIn.checkInId ? checkIn.checkInId : uuid4();
|
|
if (!this._isEnabled()) {
|
|
DEBUG_BUILD && debug.warn('SDK not enabled, will not capture check-in.');
|
|
return id;
|
|
}
|
|
|
|
const options = this.getOptions();
|
|
const { release, environment, tunnel } = options;
|
|
|
|
const serializedCheckIn = {
|
|
check_in_id: id,
|
|
monitor_slug: checkIn.monitorSlug,
|
|
status: checkIn.status,
|
|
release,
|
|
environment,
|
|
};
|
|
|
|
if ('duration' in checkIn) {
|
|
serializedCheckIn.duration = checkIn.duration;
|
|
}
|
|
|
|
if (monitorConfig) {
|
|
serializedCheckIn.monitor_config = {
|
|
schedule: monitorConfig.schedule,
|
|
checkin_margin: monitorConfig.checkinMargin,
|
|
max_runtime: monitorConfig.maxRuntime,
|
|
timezone: monitorConfig.timezone,
|
|
failure_issue_threshold: monitorConfig.failureIssueThreshold,
|
|
recovery_threshold: monitorConfig.recoveryThreshold,
|
|
};
|
|
}
|
|
|
|
const [dynamicSamplingContext, traceContext] = _getTraceInfoFromScope(this, scope);
|
|
if (traceContext) {
|
|
serializedCheckIn.contexts = {
|
|
trace: traceContext,
|
|
};
|
|
}
|
|
|
|
const envelope = createCheckInEnvelope(
|
|
serializedCheckIn,
|
|
dynamicSamplingContext,
|
|
this.getSdkMetadata(),
|
|
tunnel,
|
|
this.getDsn(),
|
|
);
|
|
|
|
DEBUG_BUILD && debug.log('Sending checkin:', checkIn.monitorSlug, checkIn.status);
|
|
|
|
// sendEnvelope should not throw
|
|
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
this.sendEnvelope(envelope);
|
|
|
|
return id;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
_prepareEvent(
|
|
event,
|
|
hint,
|
|
currentScope,
|
|
isolationScope,
|
|
) {
|
|
if (this._options.platform) {
|
|
event.platform = event.platform || this._options.platform;
|
|
}
|
|
|
|
if (this._options.runtime) {
|
|
event.contexts = {
|
|
...event.contexts,
|
|
runtime: event.contexts?.runtime || this._options.runtime,
|
|
};
|
|
}
|
|
|
|
if (this._options.serverName) {
|
|
event.server_name = event.server_name || this._options.serverName;
|
|
}
|
|
|
|
return super._prepareEvent(event, hint, currentScope, isolationScope);
|
|
}
|
|
|
|
/**
|
|
* Process a server-side metric before it is captured.
|
|
*/
|
|
_setUpMetricsProcessing() {
|
|
this.on('processMetric', metric => {
|
|
if (this._options.serverName) {
|
|
metric.attributes = {
|
|
'server.address': this._options.serverName,
|
|
...metric.attributes,
|
|
};
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
function setCurrentRequestSessionErroredOrCrashed(eventHint) {
|
|
const requestSession = getIsolationScope().getScopeData().sdkProcessingMetadata.requestSession;
|
|
if (requestSession) {
|
|
// We mutate instead of doing `setSdkProcessingMetadata` because the http integration stores away a particular
|
|
// isolationScope. If that isolation scope is forked, setting the processing metadata here will not mutate the
|
|
// original isolation scope that the http integration stored away.
|
|
const isHandledException = eventHint?.mechanism?.handled ?? true;
|
|
// A request session can go from "errored" -> "crashed" but not "crashed" -> "errored".
|
|
// Crashed (unhandled exception) is worse than errored (handled exception).
|
|
if (isHandledException && requestSession.status !== 'crashed') {
|
|
requestSession.status = 'errored';
|
|
} else if (!isHandledException) {
|
|
requestSession.status = 'crashed';
|
|
}
|
|
}
|
|
}
|
|
|
|
export { ServerRuntimeClient };
|
|
//# sourceMappingURL=server-runtime-client.js.map
|