hardhat/dist/src/internal/cli/telemetry/sentry/init.js

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

/* This file is inspired by https://github.com/getsentry/sentry-javascript/blob/9.4.0/packages/node/src/sdk/index.ts */
import os from "node:os";
import { getRuntimeInfo } from "@nomicfoundation/hardhat-utils/runtime";
import { applySdkMetadata, createStackParser, functionToStringIntegration, initAndBind, linkedErrorsIntegration, nodeStackLineParser, ServerRuntimeClient, stackParserFromStackParserOptions, } from "@sentry/core";
import { GENERIC_SERVER_NAME } from "./constants.js";
import { nodeContextIntegration } from "./vendor/integrations/context.js";
import { contextLinesIntegration } from "./vendor/integrations/contextlines.js";
import { createGetModuleFromFilename } from "./vendor/utils/module.js";
/**
 * This function initializes a custom global sentry reporter/client.
 *
 * There are two reasons why we customize it, instead of using the default one
 * provided by @sentry/node:
 *   - @sentry/node has an astronomical amount of dependencies -- See https://github.com/getsentry/sentry-javascript/discussions/13846
 *   - We customize the transport to avoid blocking the main Hardhat process
 *     while reporting errors.
 *
 * Once you initialize the custom global sentry reporter, you can use the usual
 * `captureException` and `captureMessage` functions exposed by @sentry/core.
 *
 * The reason that this uses the global instance of sentry (by calling
 * initAndBind), is that using the client directly doesn't work with the linked
 * errors integration.
 */
export function init(options) {
    const runtimeInfo = getRuntimeInfo();
    const runtime = {
        name: runtimeInfo?.runtime ?? "unknown",
        version: runtimeInfo?.version ?? "unknown",
    };
    const sentryOptions = {
        dsn: options.dsn,
        environment: options.environment,
        serverName: GENERIC_SERVER_NAME,
        release: options.release,
        runtime,
        initialScope: {
            contexts: {
                os: {
                    name: os.type(),
                    build: os.release(),
                    version: os.version(),
                },
                device: {
                    arch: os.arch(),
                },
                runtime,
            },
        },
        transport: () => options.transport,
        integrations: [
            functionToStringIntegration(),
            contextLinesIntegration(),
            linkedErrorsIntegration(),
            nodeContextIntegration(),
        ],
        platform: "javascript",
        stackParser: stackParserFromStackParserOptions(createStackParser(nodeStackLineParser(createGetModuleFromFilename()))),
    };
    applySdkMetadata(sentryOptions, "core");
    initAndBind(ServerRuntimeClient, sentryOptions);
}
//# sourceMappingURL=init.js.map