Sentry-javascript: Google Cloud Functions - Sentry 클라이언트 설정

헤이, 고마워! :)

그래도 정확한가요? Google Cloud Functions에서 Sentry JS 라이브러리를 사용할 수 있나요?

https://github.com/googleapis/nodejs-error-reporting#catching -and-reporting-application-wide-uncaught-errors 및 https://github.com/googleapis/nodejs-error-reporting#unhandled - 거부 지금 그렇게 할 수 있지만 아직 직접 테스트하지 않았습니다.

며칠 만에 할 수 있지만, 시간이 되시면 한 번 해보셔도 좋습니다. :)

@kamilogorek 감사합니다. 흥미로운!

그것이 Google Cloud Functions와 어떻게 상호 작용하는지 잘 모르겠습니다. 나는 지금 기술 계획의 한가운데에 있으므로 곧 테스트하지 못할 것입니다. 그러나 만약 / 내가 할 때 나는 당신에게 알려줄 것입니다. :)

지금 우리는 모든 Cloud Functions를 다음으로 래핑하고 있습니다.

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

그러나 Sentry에서 소스 코드나 다른 컨텍스트를 볼 수 없습니다.

이 통합을 수행하는 더 좋은 방법이 있습니까?

@vpontis 가 직접 테스트했으며 컨텍스트 확인이 제대로 작동하는 것 같습니다. 당신의 기능/구성은 무엇입니까?

안녕하세요 @kamilogorek 도와주셔서 감사합니다!

Hello World로 얻을 수 있는 것을 복제했으므로 훌륭합니다.

그러나 컨텍스트 변수가 없습니다. 범위에서 변수의 값을 볼 수 없는 것처럼? 아니면 파이썬 기능만 있습니까?

또한 내가 받고 있는 더 복잡한 오류는 데이터베이스에 쓰기/읽기를 할 때 스트림/이벤트에 오류가 있는 것 같습니다.

예를 들어 아래 스크린샷에서는 어떤 함수에서 호출되었는지조차 알 수 없습니다.

당신의 추천은 무엇입니까? 원래 함수 처리기의 호출을 포함하는 더 긴 StackTrace를 얻는 방법이 있습니까? 아니면 빵가루를 더 추가해야 하나요?

또한 이러한 소스 코드를 찾을 수 없음 오류로 인해 무슨 일이 일어나고 있는지 아십니까?

그러나 컨텍스트 변수가 없습니다. 범위에서 변수의 값을 볼 수 없는 것처럼? 아니면 파이썬 기능만 있습니까?

파이썬만의 기능입니다. 불행히도 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/
서버리스 노드 앱이므로 그렇게 할 필요가 없습니다.

파이썬만의 기능입니다. 불행히도 JS는 이 기능을 구현하는 메커니즘을 제공하지 않습니다.

젠장. 나는 파이썬에 대해 이것을 좋아했습니다!

매우 도움이되었습니다. Kamil에게 감사드립니다. 이러한 변경 사항을 구현하고 더 이상 질문이 있는 경우 여기에서 다시 연락하겠습니다. 이 문제가 JS 서버리스에서 Sentry를 사용하는 다른 사람들에게 도움이 될 것이라고 확신합니다.

엄청난! 분류를 위해 문제를 닫을 것이지만 언제든지 저에게 핑을 보내주시면 필요하면 다시 열겠습니다! :)

@kamilogorek Google Cloud Functions에 Breadcrumbs를 추가했는데 다른 함수 호출에서 이동 경로를 보고 있는 것 같습니다.

말이 돼? Google Cloud Functions를 사용하여 하나의 HTTP 요청에서만 이동 경로를 제한하려면 어떻게 해야 하나요?

말이 되지만 클라우드 기능에서 사용하는 예제 코드를 보여주실 수 있습니까? 이렇게하면 모든 것을 이해하기가 더 쉬울 것입니다.

@kamilogorek 정말 도움이 많이 되었습니다!

Docker / Node.js와 함께 Koa를 사용하도록 전환했습니다. 그래서 우리는 Koa 통합을 다음과 같이 설정했습니다: https://docs.sentry.io/platforms/node/koa/

이동 경로를 제외하고는 꽤 잘 작동하고 있으며 현재 요청에 연결된 이동 경로뿐만 아니라 서버의 모든 요청에 ​​대한 이동 경로도 보고 있습니다.

그것을 고칠 방법이 있습니까?

그것을 고칠 방법이 있습니까?

하지만 여기에 코드를 제공하기 전에 테스트해야 합니다. :)
~1-2일 후에 다시 연락 드리겠습니다.

@kamilogorek 당신은 절대 레전드입니다 내 친구

@vpontis 이므로 실제로 해야 할 일은 미들웨어 중 하나에서 도메인 인스턴스를 만드는 것입니다. 일단 거기에 있으면 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 는 추출 하려는 요청 데이터를 선택하는 데 사용할 수 있는 몇 가지 옵션을 허용합니다.

@kamilogorek 감사합니다!

몇 가지 생각:

1. ctx.req 및 `ctx.res에 저장된 도메인에 실제 노드 req 및 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에서 허브와 메시지 처리가 어떻게 작동하는지 잘 모르겠습니다...

이 코드는 작동하지만(이것은 두 개의 연속적인 미들웨어 기능입니다) 작동하는 _이유_가 마음에 들지 않습니다...

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() 가 필요하고 이동 경로가 할당되어야 하기 때문입니다. 그리고 그것을 감지하는 방법 중 하나는 domain.active 를 사용하는 것입니다.

그러나 도메인은 비동기 기능으로 신뢰할 수 없는 것 같으며 곧 사라질 것입니다...

불행히도 2014년 12월 이후로 사라지고 있으며 명확한 교체(비동기 후크가 있지만 완벽하지도 않음)가 없으며 5년 동안 노드의 코어에서 제거되지 않았습니다.

우리는 지금 zone.js 를 가지고 놀고 있습니다. 매우 도움이 될 것이기 때문입니다. 그러나 현재로서는 여전히 거대한 PoC이며 도메인을 교체하는 데 사용할 시기나 사용 여부를 알 수 없습니다.

안녕하세요 @kamilogorek 입니다 .

처리되지 않은 오류를 Sentry로 캡처하려고 시도 중이며 https://github.com/getsentry/sentry-javascript/issues/2122#issuecomment -503440087에서 언급한 내용을 시도했습니다.

그러나 Google은 process.on('uncaughtException') 연결을 허용하지 않는 것 같습니다. 해당 접근 방식을 사용하여 Sentry에 오류를 기록할 수 없었습니다.

시도해 볼 것을 권장하는 다른 방법이 있습니까? 모든 함수 본문을 try catch 블록으로 래핑하는 것은 이상적인 방법이 아닌 것 같습니다.

우리는 wrap 방식을 제공하지만 try/catch 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 수동 호출도 사용합니다.

흠 흥미롭네요. 저는 (배후에서 Google 클라우드 기능을 사용하는) Firebase 클라우드 기능에서 Sentry를 설정했고 방금 오류 보고서를 받았습니다. 그래서 작동하는 것 같습니다!

다음은 모든 Sentry 코드가 있는 index.js입니다.

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%로 설정한다는 의미입니까? (오류를 잡아서 수동으로 보고하기 때문에 트랜잭션이 제대로 닫혀서 ok 상태인가요?)

@axelvaindal 우리는 아직 서버리스에 대한 성능 모니터링을 지원하지 않습니다. 이 질문에 대해:

처리되지 않은 오류를 Sentry로 보내는 방법이 있습니까?

그러면 그렇지 않습니다. GCF는 처리되지 않은 예외/거부에 연결하는 방법을 제공하지 않으므로 이를 가로챌 수 없습니다. 핸들러를 수동으로 잡으려면 핸들러를 래핑해야 합니다(위 주석 참조).

AWSLambda 핸들러 구현을 읽고 해당 스니펫을 개선하는 방법에 대한 아이디어를 얻을 수도 있습니다. https://github.com/getsentry/sentry-javascript/blob/master/packages/serverless/src/awslambda.ts