Sentry-javascript: GoogleCloudFunctions-Sentryクライアントのセットアップ

ねえ、ありがとう！ :)

それでも正確ですか？ SentryJSライブラリをGoogleCloudFunctionsで動作させることはできますか？

https://github.com/googleapis/nodejs-error-reporting#catching-and-reporting-application-wide-uncaught-errorsおよびhttps://github.com/googleapis/nodejs-error-reporting#unhandled-によると拒否は今は可能ですが、私はまだそれを自分でテストしていません。

私は数日でそうすることができます、しかしあなたが少しの暇があればあなたはそれにスピンを与えることができます:)

@kamilogorekに感謝します。 面白い！

それがGoogleCloudFunctionsとどのように相互作用するのかわかりません。 私は現在技術計画の真っ最中なので、すぐにテストすることはできません。 しかし、私がそうするかどうか/いつそうするかをあなたに知らせます。 :)

現在、すべてのクラウド関数を次のようにラップしています。

try () {
...
} catch (e) {
  Sentry.captureException(e);
}

しかし、Sentryにはソースコードやその他のコンテキストが表示されていません。

この統合を行うためのより良い方法はありますか？

@vpontisは自分でテストしたところ、コンテキスト解決は問題なく機能しているようです。 あなたの機能/構成は何ですか？

こんにちは@kamilogorek助けてくれてありがとう！

Hello Worldで得られるものを複製したので、それは素晴らしいことです。

ただし、コンテキスト変数はありません。 スコープ内の変数の値を確認できないように？ それとも、Pythonの機能だけですか？

また、データベースへの書き込み/読み取りを行っているときに発生するより複雑なエラーのように見えますが、ストリーム/イベントにエラーがあります。

たとえば、下のスクリーンショットでは、どの関数から呼び出されたのかさえわかりません。

あなたの推薦は何ですか？ 元の関数ハンドラーからの呼び出しを含む、より長いStackTraceを取得する方法はありますか？ それとも、パンくずリストを追加する必要がありますか？

また、これらのソースコードで何が起こっているのか、エラーが見つかりませんでしたか？

ただし、コンテキスト変数はありません。 スコープ内の変数の値を確認できないように？ それとも、Pythonの機能だけですか？

Pythonのみの機能です。 残念ながら、JSはこの機能を実装するメカニズムを提供していません。

たとえば、下のスクリーンショットでは、どの関数から呼び出されたのかさえわかりません。 あなたの推薦は何ですか？ 元の関数ハンドラーからの呼び出しを含む、より長いStackTraceを取得する方法はありますか？ それとも、パンくずリストを追加する必要がありますか？

ソケットによってトリガーされたため、この特定の関数が何と呼ばれるかを判断する方法はありません。 そして、あなたが述べたように、これを追跡する最良の方法は、dbクエリ、プロキシ呼び出し、または外部サービス要求を実行するときにブレッドクラムを使用することです。

また、サーバーレスインスタンスは存続期間が長いため、次のように呼び出すことができます。

Sentry.configureScope(scope => scope.clear())
// or
Sentry.configureScope(scope => scope.clearBreadcrumbs())

きれいなスレートを取得します。

また、これらのソースコードで何が起こっているのか、エラーが見つかりませんでしたか？

プロジェクト設定でEnable JavaScript source fetchingをオフにします。 https://sentry.io/settings/kamil-ogorek/projects/testing-project/
サーバーレスノードアプリなので、それを行う意味はありません。

Pythonのみの機能です。 残念ながら、JSはこの機能を実装するメカニズムを提供していません。

くそ。 私はPythonについてこれが大好きでした！

とても助かりました、カミルありがとう。 これらの変更を実装し、質問があればここに返信します。 この問題は、JSサーバーレスでSentryを使用している他の人に役立つと確信しています。

素晴らしい！ トリアージのために問題をクローズしますが、いつでもお気軽にpingを送信して、必要に応じて再開します。 :)

@kamilogorek Google Cloud Functionsにブレッドクラムを追加しましたが、さまざまな関数呼び出しからのブレッドクラムが表示されていると思います。

それは理にかなっていますか？ ブレッドクラムをGoogleCloudFunctionsを使用した1つのHTTPリクエストからのみに制限するにはどうすればよいですか？

理にかなっていますが、クラウド関数で使用するサンプルコードを教えていただけますか？ このようにすると、すべてを理解しやすくなります。

@kamilogorekあなたは本当に役に立ちました！

Docker/NodeでKoaを使用するように切り替えました。 したがって、Koa統合は次のように設定されています： https ：//docs.sentry.io/platforms/node/koa/

ブレッドクラムを除いて、かなりうまく機能しています。現在のリクエストに関連付けられているブレッドクラムだけでなく、サーバー上のすべてのリクエストに対してブレッドクラムが表示されています。

それを修正する方法はありますか？

それを修正する方法はありますか？

ありますが、ここにコードを提供する前にテストする必要があります:)
1〜2日以内にご連絡を差し上げます。

@kamilogorekあなたは私の友人の絶対的な伝説です

@vpontisなので、実際に行う必要があるのは、ミドルウェアの1つにドメインインスタンスを作成することだけです。 そこに到達すると、SDKはそれを検出し、コンテキストを分離するために使用します。 parseRequestをそこに移動することもできます。 （https://github.com/koajs/examples/blob/master/errors/app.jsに基づく例）

const Sentry = require("@sentry/node");
const Koa = require("koa");
const app = (module.exports = new Koa());
const domain = require("domain");

Sentry.init({
  // ...
});

app.use(async function(ctx, next) {
  const local = domain.create();
  local.add(ctx);
  local.on("error", next);
  local.run(() => {
    Sentry.configureScope(scope => {
      scope.addEventProcessor(event => Sentry.Handlers.parseRequest(event, ctx.request));
    });
    next();
  });
});

app.use(async function(ctx, next) {
  try {
    await next();
  } catch (err) {
    // some errors will have .status
    // however this is not a guarantee
    ctx.status = err.status || 500;
    ctx.type = "html";
    ctx.body = "<p>Something <em>exploded</em>, please contact Maru.</p>";

    // since we handled this manually we'll
    // want to delegate to the regular app
    // level error handling as well so that
    // centralized still functions correctly.
    ctx.app.emit("error", err, ctx);
  }
});

// response

app.use(async function() {
  throw new Error("boom boom");
});

// error handler

app.on("error", function(err) {
  Sentry.captureException(err);
});

if (!module.parent) app.listen(3000);

parseRequestは、抽出するリクエストデータを選択するために使用できるいくつかのオプションを受け入れます-https://github.com/getsentry/sentry-javascript/blob/f71c17426c7053d46fe3e2e35e77c564749d0eb7/packages/node/src/handlers .ts＃L177

ありがとう@kamilogorek！

いくつかの考え：

1. 実際のノードreqとresを、 ctx.reqと`ctx.resに保存されているドメインにバインドできます。

2. ノードreqをparseRequestに渡すことができます

3. エラーを手動でキャッチした後、なぜctx.app.emit("error", err, ctx);を呼び出すのですか？

    // since we handled this manually we'll
    // want to delegate to the regular app
    // level error handling as well so that
    // centralized still functions correctly.
    ctx.app.emit("error", err, ctx);

それは、応答を返すだけで、エラーを一元化されたエラーハンドラーに渡さない場合ではないでしょうか。

1. コアnextはasyncです。 ノード内で問題が発生しますかdomain.run(...)

それが理にかなっているかどうか教えてください。 これはすでにとても、とても役に立ちます。 今週後半にテストします。

Ah re 3例からコピーしているだけなので、その部分は無視します:)。 今それをテストしています...

うーん、これを機能させるのに問題があります。 これは、Koaのドメインコールバックとasync関数が混在しているためだと思います。

また、ドメインはノード12でも機能しないようです（非同期スタックトレースのサポートを取得するために、すぐにアップグレードする予定です）。

いずれにせよ、ドメインを使用したこのコードがどのように機能するかを理解していないため、アプリの重要な部分に配置することを躊躇しています。

現在の「ハブ」をctxに配置し、現在のリクエストに関連付けられたaddBreadcrumbを呼び出す別の方法はありますか？ Sentryでハブとメッセージ処理がどのように機能するかはよくわかりません...

私はこのコードを機能させました（これらは2つの連続したミドルウェア関数です）が、それが機能する_理由_に満足していません...

export const setSentryDomain = async (ctx, next) => {
  await new Promise(async (resolve, reject) => {
    const local = domain.create();

    local.add(ctx.req);
    local.add(ctx.res);

    local.run(async () => {
      Sentry.configureScope((scope) => {
        scope.addEventProcessor((event) => Sentry.Handlers.parseRequest(event, ctx.req));
      });

      await next();
      resolve();
    });
  });
};

export const catchErrors = async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    console.log('got error');
    ctx.app.emit('error', err, ctx);
  }
};

私はそれを夜と呼んでいます。 満足できる実用的なソリューションが得られませんでした。

また、私のブレッドクラムのほとんどは、Sentryによって自動的にキャプチャされるconsole.logステートメントからのものであることに気付きました。 したがって、これらのブレッドクラムを適切な範囲に収める方法を理解する必要があります...

コードをざっと見てみると、ドメインはこの問題を解決しているように聞こえます。 しかし、ドメインは非同期関数では信頼できないようで、まもなく廃止されます...

現在の「ハブ」をctxに配置し、現在のリクエストに何らかの形で関連付けられたaddBreadcrumbを呼び出す別の方法はありますか？

ハブをctxに直接割り当てることができますが、ハブを返すためにSentry.getCurrentHub()が必要なため、自動的にキャプチャされたブレッドクラムでは機能しません。ブレッドクラムを割り当てる必要があります。 そして、それを検出する方法の1つは、 domain.activeを使用することです。

しかし、ドメインは非同期関数では信頼できないようで、まもなく廃止されます...

残念ながら、これらは2014年12月以降廃止され、明確な置き換えは見られず（非同期フックもありますが、完全ではありません）、この5年間でノードのコアから削除されていません。

zone.jsは非常に役立つので、今は遊んでいますが、それでも今のところ巨大なPoCであり、ドメインの代わりにいつ使用するか、または使用するかどうかさえわかりません。

こんにちは@kamilogorek 、

未処理のエラーをSentryにキャプチャしようとしていますが、 https： //github.com/getsentry/sentry-javascript/issues/2122#issuecomment-503440087で言及した内容を試しました。

しかし、グーグルはあなたがprocess.on('uncaughtException')に接続することを許可していないと思います、私はそのアプローチを使用してセントリーにエラーを記録することができませんでした。

試してみることをお勧めする他の方法はありますか？すべての関数本体をtry catchブロックでラップすることは、理想的な方法ではないようです。

wrapメソッドを提供していますが、tbhを試して/キャッチするよりもはるかに優れているとは思いません。

exports.helloBackground = (data, context) => {
  return `Hello ${data.name || 'World'}!`;
};

// becomes

exports.helloBackground = (data, context) => {
  return Sentry.wrap(() => {
    return `Hello ${data.name || 'World'}!`;
  })
};

この問題は、firebase/googleクラウド機能をより簡単にサポートするための機能リクエストとして開いたままにしておく価値があるように思われます。

クライアント側でのセットアップのしやすさに非常に感銘を受け、サーバー側のセットアップがはるかに複雑になることに気付いたときはがっかりしました。 GCPのエクスペリエンス（特に機能）を改善する計画はありますか？

@goleary見たいものを正確に説明した新しい号を開いていただけませんか？
このスレッドはすでにかなり大きく、追跡するのが困難です。

ありがとう

これを設定する簡単な方法はまだありませんか？ 理想的には、すべての機能に対して設定しなくても、グローバルに一度設定できるのでしょうか。

@marcospgpいいえ、そして残念ながら、Google自体がそれを可能にするメカニズムを提供していないので、ありません。 独自のレポーターをご覧ください-https://cloud.google.com/error-reporting/docs/setup/nodejs手動呼び出しも使用しています。

興味深いことに、Firebaseクラウド関数（Googleクラウド関数を舞台裏で使用）にSentryを設定しましたが、エラーレポートが表示されたので、機能しているようです。

これが私のindex.jsで、すべてのSentryコードは次のとおりです。

const admin = require("firebase-admin");
const functions = require("firebase-functions");
const Sentry = require("@sentry/node");

/**
 * Set up Sentry for error reporting
 */
if (functions.config().sentry && functions.config().sentry.dsn) {
  Sentry.init({ dsn: functions.config().sentry.dsn });
} else {
  console.warn(
    "/!\\ sentry.dsn environment variable not found. Skipping setting up Sentry..."
  );
}

admin.initializeApp();

const { function1 } = require("./cloud-functions/function1");
const { function2 } = require("./cloud-functions/function2");

module.exports = {
  function1,
  function2
};

@marcospgpは、上記のindex.jsが./cloud-functions/function1および./cloud-functions/function2内のキャッチされない例外をSentryに送信できましたか、それともこれらのファイル内でSentryにアクティブにログインする必要がありましたか？

@marcospgpソリューションを試しましたが、キャッチされなかった例外をログに記録していないようです。手動でログに記録する必要があります（ sentry.captureException()を使用しますか？）

ここの@golearyと同じように、何もログに記録されません。

また、 .wrap()はもう利用できないようです。

これは、すべてのコードをtry / catch内に手動でラップする必要があることを意味しますか？

@Dinduksそれが私がやっていることです。 オーバーヘッドは少し面倒ですが、歩哨を使用できるようにすることは、firebaseクラウド関数のログ記録よりも努力する価値があります（あまり良くありません）。

@Dinduks wrapはまだあります。https ：//github.com/getsentry/sentry-javascript/blob/master/packages/browser/src/exports.ts#L40を参照してください。
ただし、関数はすぐに実行され、戻り値が返されることに注意してください。 したがって、これが通常のtry / catchよりも役立つかどうかはわかりません。これにより、ユーザーのフォールバックアクションも実行できます。

const myHandler = (req, res) => Sentry.wrap(() => {
  someFunctionThatCanBreak(req);
  return res.send(200);
});

良い考えではないと思いますが、このようなラッパーを作成しました。

import * as Sentry from "@sentry/node";

export const sentryWrapper = (f) => {
  return async function () {
    try {
      // eslint-disable-next-line prefer-rest-params
      return await f.apply(this, arguments);
    } catch (e) {
      Sentry.captureException(e);
      await Sentry.flush(2000);
      throw new Error(e);
    }
  };
};

以下のように使用します。

export const getChannelVideoTest = functions.https.onRequest(
  sentryWrapper(async (req, res) => {
    someFunctionThatCanBreak(req);
    return res.send(200);
  }),
);

もっと良い方法があるかどうか知りたいのですが。

@kamilogorek
私もこれに苦労しています。

Sentry.init()に成功し、すべてのコードをtry {} catch {}ステートメントでラップし、 Sentry.captureExceptionとSentry.flush()を手動で呼び出すと、問題が発生します。
ただし、 try/catchステートメントを削除すると、何も報告されません。
関数の先頭でSentry.startTransaction()を使用してトランザクションを手動で作成しない限り、何も得られないパフォーマンス監視についても同じことが言えます。

これは期待されていますか？
未処理のエラーをSentryに送信する方法はありますか？
そうでない場合、これは、パフォーマンスタブが常に失敗率を0％に設定することを意味しますか？ （エラーをキャッチして手動で報告するため、トランザクションは適切に閉じられており、正常なステータスになっていますか？）

@axelvaindalサーバーレスのパフォーマンスモニタリングはまだサポートされていません。 この質問に関して：

未処理のエラーをSentryに送信する方法はありますか？

そうではありません。GCFは未処理の例外/拒否にフックする方法を提供していないため、それを傍受することはできません。 手動でキャッチするには、ハンドラーをラップする必要があります（上のコメントを参照）。

AWSLambdaハンドラーの実装を読んで、そのスニペットを改善する方法のアイデアを得ることができます-https ://github.com/getsentry/sentry-javascript/blob/master/packages/serverless/src/awslambda.ts