Node.js용 Error Reporting 설정

Node.js용 Stackdriver Error Reporting 라이브러리를 사용하여 Node.js 애플리케이션에서 Stackdriver Error Reporting에 오류 보고서를 보낼 수 있습니다.

Error Reporting은 Cloud Functions, App Engine, Compute Engine, Google Kubernetes Engine과 같은 일부 Google Cloud Platform 제품에 통합되어 있습니다. Error Reporting은 해당 제품에서 실행되는 애플리케이션에서 Stackdriver Logging에 로깅한 오류를 표시합니다. 자세한 내용은 Google Cloud Platform에서 실행을 참조하세요.

또한 Stackdriver Logging을 사용하여 Error Reporting에 오류 데이터를 보낼 수도 있습니다. 데이터 형식 지정 요구사항에 대한 자세한 내용은 Stackdriver Logging의 형식 지정 오류 메시지를 참조하세요.

시작하기 전에

  1. Google 계정에 로그인합니다.

    아직 계정이 없으면 새 계정을 등록하세요.

  2. Google Cloud Platform 프로젝트를 선택하거나 만듭니다.

    리소스 관리 페이지로 이동

  3. Google Cloud Platform 프로젝트에 결제가 사용 설정되어 있는지 확인하세요.

    결제 사용 설정 방법 알아보기

  4. Error Reporting API 를 사용 설정합니다.

    API 사용 설정

  5. Node.js 개발 환경을 준비합니다.

    Node.js 설정 가이드로 이동

클라이언트 라이브러리 설치

Node.js용 Stackdriver Error Reporting 라이브러리를 사용하면 거의 모든 곳에서 실행되는 Node.js 애플리케이션에서 보고된 오류를 모니터링하고 볼 수 있습니다.

  1. npm을 사용하여 패키지를 설치합니다.

    npm install --save @google-cloud/error-reporting
  2. 오류 보고를 시작하려면 라이브러리를 가져와서 클라이언트를 인스턴스화합니다.

    // Imports the Google Cloud client library
    const ErrorReporting = require('@google-cloud/error-reporting')
      .ErrorReporting;
    
    // On Node 6+ the following syntax can be used instead:
    // const {ErrorReporting} = require('@google-cloud/error-reporting');
    
    // With ES6 style imports via TypeScript or Babel, the following
    // syntax can be used instead:
    // import {ErrorReporting} from '@google-cloud/error-reporting';
    
    // Instantiates a client
    const errors = new ErrorReporting();
    
    // Reports a simple error
    errors.report('Something broke!');

설치에 관한 자세한 내용은 Node.js용 Stackdriver Error Reporting 라이브러리 문서를 참조하세요. 또한 문제 추적기를 통해 문제를 신고할 수도 있습니다.

클라이언트 라이브러리 구성

Node.js용 Stackdriver Error Reporting 라이브러리의 동작을 맞춤설정할 수 있습니다. 가능한 구성 옵션 목록은 라이브러리 구성을 참조하세요. 이러한 옵션을 options 객체로 전달하여 라이브러리의 생성자에게 전달할 수 있습니다.

오류 보고

다음 예와 같이 report 메소드를 호출하여 오류를 수동으로 보고할 수 있습니다.

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting')
  .ErrorReporting;

// On Node 6+ the following syntax can be used instead:
// const {ErrorReporting} = require('@google-cloud/error-reporting');

// With ES6 style imports via TypeScript or Babel, the following
// syntax can be used instead:
// import {ErrorReporting} from '@google-cloud/error-reporting';

// Instantiates a client
const errors = new ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Express.js로 오류 보고

Node.js용 Stackdriver Error Reporting 라이브러리는 Stackdriver Error Reporting을 Express.js와 같이 널리 사용되는 Node.js 웹 프레임워크에 통합할 수 있습니다.

const express = require('express');

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting')
  .ErrorReporting;

// On Node 6+ the following syntax can be used instead:
// const {ErrorReporting} = require('@google-cloud/error-reporting');

// With ES6 style imports via TypeScript or Babel, the following
// syntax can be used instead:
// import {ErrorReporting} from '@google-cloud/error-reporting';

// Instantiates a client
const errors = new ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

기타 통합

Node.js용 Stackdriver Error Reporting 라이브러리와 다른 Node.js 웹 프레임워크 간의 통합에 대한 자세한 내용은 GitHub의 라이브러리 저장소를 참조하세요.

Google Cloud Platform에서 실행

Node.js용 Stackdriver Error Reporting 라이브러리를 사용하려면 Cloud IAM Error Reporting 작성자 역할이 필요합니다. 대부분의 Google Cloud Platform 컴퓨팅 플랫폼은 기본적으로 이 역할을 제공합니다.

App Engine 가변형 환경

App Engine은 기본적으로 Error Reporting 작성자 역할을 부여합니다.

Node.js용 Stackdriver Error Reporting 라이브러리는 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Error Reporting은 App Engine 가변형 환경 애플리케이션에서 자동으로 사용 설정되며 추가 설정은 필요하지 않습니다.

GKE

GKE에서는 다음 예시 명령어에 표시된 것처럼 클러스터를 만들 때 cloud-platform 액세스 범위를 추가해야 합니다.

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Compute Engine VM 인스턴스를 사용할 때 각 인스턴스에 cloud-platform 액세스 범위를 추가하세요. Google Cloud Platform Console을 통해 새 인스턴스를 만들 때 인스턴스 만들기 패널의 ID 및 API 액세스 섹션에서 이 작업을 수행할 수 있습니다. 선택한 Compute Engine 기본 서비스 계정 또는 다른 서비스 계정을 사용하고 ID 및 API 액세스 섹션에서 모든 Cloud API에 대한 전체 액세스 허용을 선택하세요. 어떤 서비스 계정을 선택하든 GCP Console의 IAM 및 관리자 섹션에서 Error Reporting 작성자 역할이 부여되었는지 확인하세요.

Cloud Functions

Cloud Functions는 기본적으로 Error Reporting 작성자 역할을 부여합니다.

Node.js용 Stackdriver Error Reporting 라이브러리는 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Cloud Functions는 Error Reporting을 사용하도록 자동으로 구성됩니다. 처리되지 않은 자바스크립트 예외는 Stackdriver Logging에 나타나고 Node.js용 Stackdriver Error Reporting 라이브러리를 사용하지 않아도 Stackdriver Error Reporting에서 처리합니다.

로컬 및 기타 위치에서 실행

Google Cloud Platform 외부에서 Node.js용 Stackdriver Error Reporting 라이브러리를 사용하려면 GCP 프로젝트 ID와 적절한 서비스 계정 자격 사용자 인증 정보를 Node.js용 Stackdriver Error Reporting 라이브러리에 직접 제공해야 합니다. 이 내용은 자체 워크스테이션, 데이터 센터의 컴퓨터 또는 다른 클라우드 공급업체의 VM 인스턴스에서 라이브러리를 실행하는 경우에 적용됩니다. 자세한 내용은 수동으로 서비스 계정 사용자 인증 정보 획득 및 제공을 참조하세요.

예를 들면 다음과 같습니다.

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting')
  .ErrorReporting;

// On Node 6+ the following syntax can be used instead:
// const {ErrorReporting} = require('@google-cloud/error-reporting');

// With ES6 style imports via TypeScript or Babel, the following
// syntax can be used instead:
// import {ErrorReporting} from '@google-cloud/error-reporting';

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

오류 보고서 보기

배포 후 GCP Console의 Error Reporting 대시보드에서 오류 보고서를 볼 수 있습니다.

Error Reporting 대시보드로 이동

자세한 내용은 오류 보기를 참조하세요.

이 페이지가 도움이 되었나요? 평가를 부탁드립니다.

다음에 대한 의견 보내기...

Stackdriver Error Reporting
도움이 필요하시나요? 지원 페이지를 방문하세요.