Node.js로 trace 및 측정항목 생성

이 문서에서는 오픈소스 OpenTelemetry 프레임워크를 사용하여 trace 및 측정항목 데이터를 수집하도록 Node.js JavaScript 앱을 수정하는 방법과 구조화된 JSON 로그를 표준 출력에 작성하는 방법을 설명합니다. 이 문서에서는 설치 및 실행할 수 있는 샘플 Node.js 앱에 대한 정보도 제공합니다. 이 앱은 Fastify 웹 프레임워크를 사용하며 측정항목, trace, 로그를 생성하도록 구성됩니다.

계측에 대한 자세한 내용은 다음 문서를 참조하세요.

수동 계측 및 자동 계측 안내

이 언어의 경우 OpenTelemetry는 자동 계측을 코드를 변경하지 않고 라이브러리 및 프레임워크에서 원격 분석을 수집하는 방법으로 정의합니다. 그러나 설치 모듈이 있고 환경 변수를 설정해야 합니다.

이 문서에서는 자동 계측에 대해 설명하지 않습니다. 해당 주제에 대해서는 Node용 자동 계측을 참조하세요.

일반적인 정보는 Node용 OpenTelemetry 계측을 참조하세요.

시작하기 전에

Enable the Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.

Enable the APIs

앱을 계측하여 trace, 측정항목, 로그 수집

trace 및 측정항목 데이터를 수집하고 구조화된 JSON을 표준 출력에 작성하도록 앱을 계측하려면 이 문서의 이어지는 섹션에 설명된 대로 다음 단계를 수행합니다.

OpenTelemetry 구성
OpenTelemetry 구성을 미리 로드하도록 앱 구성
구조화된 로깅 구성
구조화된 로그 작성

OpenTelemetry 구성

OpenTelemetry Node.js SDK의 기본 구성은 OTLP 프로토콜을 사용하여 trace를 내보냅니다. 또한 trace 컨텍스트 전파에 W3C Trace 컨텍스트 형식을 사용하도록 OpenTelemetry를 구성합니다. 이 구성을 통해 스팬이 trace 내에서 올바른 상위-하위 관계를 갖도록 할 수 있습니다.

다음 코드 샘플은 OpenTelemetry를 설정하는 JavaScript 모듈을 보여줍니다.

전체 샘플을 보려면 더보기를 클릭한 다음 GitHub에서 보기를 선택합니다.


diag.setLogger(
  new DiagConsoleLogger(),
  opentelemetry.core.getEnv().OTEL_LOG_LEVEL
);

const sdk = new opentelemetry.NodeSDK({
  instrumentations: getNodeAutoInstrumentations({
    // Disable noisy instrumentations
    '@opentelemetry/instrumentation-fs': {enabled: false},
  }),
  resourceDetectors: getResourceDetectorsFromEnv(),
  metricReader: getMetricReader(),
});

try {
  sdk.start();
  diag.info('OpenTelemetry automatic instrumentation started successfully');
} catch (error) {
  diag.error(
    'Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry',
    error
  );
}

// Gracefully shut down the SDK to flush telemetry when the program exits
process.on('SIGTERM', () => {
  sdk
    .shutdown()
    .then(() => diag.debug('OpenTelemetry SDK terminated'))
    .catch(error => diag.error('Error terminating OpenTelemetry SDK', error));
});

이전 코드 샘플은 OTLP 프로토콜을 사용하여 측정항목을 내보내도록 OpenTelemetry를 구성하고, @opentelemetry/auto-instrumentations-node 패키지를 사용하여 사용 가능한 모든 Node.js 계측을 구성합니다.

대기 중인 모든 원격 분석이 플러시되고 애플리케이션이 종료되기 전에 연결이 단계적으로 종료되도록 SIGTERM 핸들러가 shutdown을 호출합니다.

자세한 내용과 구성 옵션은 OpenTelemetry Node.js 자동 계측을 참조하세요.

OpenTelemetry 구성을 미리 로드하도록 앱 구성

OpenTelemetry를 사용하여 구조화된 로그를 작성하고 측정항목 및 trace 데이터를 수집하도록 앱을 구성하려면 Node.js --require 플래그를 사용하여 계측 모듈을 미리 로드하도록 앱 호출을 업데이트합니다. --require 플래그를 사용하면 앱이 시작되기 전에 OpenTelemetry가 초기화됩니다. 자세한 내용은 OpenTelemetry Node.js 시작하기를 참조하세요.

다음 코드 샘플은 --require 플래그를 전달하는 Dockerfile을 보여줍니다.

CMD node --require ./build/src/instrumentation.js build/src/index.js 2>&1 | tee /var/log/app.log

구조화된 로깅 구성

표준 출력에 작성된 JSON 형식 로그의 일부로 trace 정보를 포함하려면 JSON 형식으로 구조화된 로그를 출력하도록 앱을 구성합니다. Fastify는 Pino 로그 프레임워크를 사용하고 각 요청 핸들러에 로거를 제공합니다. 다음 코드 샘플은 구조화된 JSON 로그를 출력하도록 앱을 구성하는 Pino LoggerOptions 객체를 보여줍니다.


// Expected attributes that OpenTelemetry adds to correlate logs with spans
interface LogRecord {
  trace_id?: string;
  span_id?: string;
  trace_flags?: string;
  [key: string]: unknown;
}

// https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity
const PinoLevelToSeverityLookup: Record<string, string | undefined> = {
  trace: 'DEBUG',
  debug: 'DEBUG',
  info: 'INFO',
  warn: 'WARNING',
  error: 'ERROR',
  fatal: 'CRITICAL',
};

export const loggerConfig = {
  messageKey: 'message',
  // Same as pino.stdTimeFunctions.isoTime but uses "timestamp" key instead of "time"
  timestamp(): string {
    return `,"timestamp":"${new Date(Date.now()).toISOString()}"`;
  },
  formatters: {
    log(object: LogRecord): Record<string, unknown> {
      // Add trace context attributes following Cloud Logging structured log format described
      // in https://cloud.google.com/logging/docs/structured-logging#special-payload-fields
      const {trace_id, span_id, trace_flags, ...rest} = object;

      return {
        'logging.googleapis.com/trace': trace_id,
        'logging.googleapis.com/spanId': span_id,
        'logging.googleapis.com/trace_sampled': trace_flags
          ? trace_flags === '01'
          : undefined,
        ...rest,
      };
    },
    // See
    // https://getpino.io/#/docs/help?id=mapping-pino-log-levels-to-google-cloud-logging-stackdriver-severity-levels
    level(label: string) {
      return {
        severity:
          PinoLevelToSeverityLookup[label] ?? PinoLevelToSeverityLookup['info'],
      };
    },
  },
} satisfies LoggerOptions;

이전 구성은 로그 메시지에서 활성 스팬에 대한 정보를 추출한 후 해당 정보를 구조화된 JSON 로그에 속성으로 추가합니다. 그런 다음, 다음 속성을 사용하여 로그와 trace의 상관관계를 보여줄 수 있습니다.

logging.googleapis.com/trace: 로그 항목과 연결된 trace의 리소스 이름입니다.
logging.googleapis.com/spanId: 로그 항목과 연결된 trace가 있는 스팬 ID입니다.
logging.googleapis.com/trace_sampled: 이 필드의 값은 true 또는 false여야 합니다.

이러한 필드에 대한 자세한 내용은 LogEntry 구조를 참조하세요.

Fastify에서 Pino 구성을 사용하려면 Fastify 앱을 만들 때 로거 구성 객체를 전달합니다.

// Create the Fastify app providing the Pino logger config
const fastify = Fastify({
  logger: loggerConfig,
});

구조화된 로그 작성

trace에 연결되는 구조화된 로그를 작성하려면 Fastify에서 제공하는 Pino 로거를 사용합니다. 예를 들어 다음 문은 Logger.info() 메서드를 호출하는 방법을 보여줍니다.

request.log.info({subRequests}, 'handle /multi request');

OpenTelemetry는 OpenTelemetry 컨텍스트에서 현재 활성 스팬의 스팬 컨텍스트로 Pino 로그 항목을 자동으로 채웁니다. 그러면 이 스팬 컨텍스트가 구조화된 로깅 구성에 설명된 대로 JSON 로그에 포함됩니다.

원격 분석을 수집하도록 구성된 샘플 앱 실행

예시 앱은 로그용 JSON, 측정항목 및 trace용 OTLP, Fastify 프레임워크를 포함하여 공급업체 중립적인 형식을 사용합니다. 원격 분석을 Google Cloud로 라우팅하기 위해 이 샘플은 Google 내보내기 도구로 구성된 OpenTelemetry Collector를 사용합니다. 이 앱에는 2개의 엔드포인트가 있습니다.

/multi 엔드포인트는 handleMulti 함수로 처리됩니다. 앱의 부하 생성기는 /multi 엔드포인트로 요청을 보냅니다. 이 엔드포인트가 요청을 수신하면 로컬 서버의 /single 엔드포인트로 3~7개의 요청을 보냅니다.

/**
 * handleMulti handles an http request by making 3-7 http requests to the /single endpoint.
 *
 * OpenTelemetry instrumentation requires no changes here. It will automatically generate a
 * span for the handler body.
 */
fastify.get('/multi', async request => {
  const subRequests = randInt(3, 8);
  request.log.info({subRequests}, 'handle /multi request');

  for (let i = 0; i < subRequests; i++) {
    await axios.get(`http://localhost:${port}/single`);
  }
  return 'ok';
});

/single 엔드포인트는 handleSingle 함수로 처리됩니다. 이 엔드포인트가 요청을 수신하면 짧은 지연 동안 절전 모드로 전환된 후 문자열로 응답합니다.

/**
 * handleSingle handles an http request by sleeping for 100-200 ms. It writes the number of
 * milliseconds slept as its response.
 */
fastify.get('/single', async request => {
  // Sleep between 100-200 milliseconds
  const sleepMillis = randInt(100, 200);
  request.log.info({sleepMillis}, 'Going to sleep');
  await sleep(sleepMillis);
  return `slept ${sleepMillis}\n`;
});

앱 다운로드 및 배포

샘플을 실행하려면 다음을 수행합니다.

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

저장소를 복제합니다.

git clone https://github.com/GoogleCloudPlatform/opentelemetry-operations-js

샘플 디렉터리로 이동합니다.

cd opentelemetry-operations-js/samples/instrumentation-quickstart

샘플을 빌드하고 실행합니다.
```
docker compose up --abort-on-container-exit
```
Cloud Shell에서 실행하지 않는 경우 사용자 인증 정보 파일을 가리키는 GOOGLE_APPLICATION_CREDENTIALS 환경 변수를 사용하여 애플리케이션을 실행합니다. 애플리케이션 기본 사용자 인증 정보는 $HOME/.config/gcloud/application_default_credentials.json에서 사용자 인증 정보 파일을 제공합니다.
```
# Set environment variables
export GOOGLE_CLOUD_PROJECT="PROJECT_ID"
export GOOGLE_APPLICATION_CREDENTIALS="$HOME/.config/gcloud/application_default_credentials.json"
export USERID="$(id -u)"

# Run
docker compose -f docker-compose.yaml -f docker-compose.creds.yaml up --abort-on-container-exit
```

측정항목 보기

샘플 앱의 OpenTelemetry 계측은 측정항목 탐색기를 사용하여 볼 수 있는 Prometheus 측정항목을 생성합니다.

Prometheus/http_server_duration_milliseconds/histogram은 서버 요청 기간을 기록하고 결과를 히스토그램에 저장합니다.
Prometheus/http_client_duration_milliseconds/histogram은 클라이언트 요청 기간을 기록하고 결과를 히스토그램에 저장합니다.

샘플 앱에서 생성된 측정항목을 보려면 다음을 실행합니다.

Google Cloud 콘솔에서 측정항목 탐색기 페이지로 이동합니다.
측정항목 탐색기로 이동

검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Monitoring인 결과를 선택합니다.
측정항목 요소에서 측정항목 선택 메뉴를 펼치고 필터 표시줄에 http_server을 입력한 후 하위 메뉴를 사용하여 특정 리소스 유형과 측정항목을 선택합니다.
1. 활성 리소스 메뉴에서 Prometheus 대상을 선택합니다.
2. 활성 측정항목 카테고리 메뉴에서 Http를 선택합니다.
3. 활성 측정항목 메뉴에서 측정항목을 선택합니다.
4. 적용을 클릭합니다.
데이터를 보는 방법을 구성합니다.
측정항목의 측정값이 누적되면 측정항목 탐색기는 측정된 데이터를 정렬 기간에 따라 자동으로 정규화하므로 차트에 비율이 표시됩니다. 자세한 내용은 종류, 유형, 변환을 참조하세요.

두 개의 counter 측정항목과 같이 정수 값 또는 Double 값이 측정되면 측정항목 탐색기가 모든 시계열을 자동으로 합산합니다. /multi 및 /single HTTP 경로의 데이터를 보려면 집계 항목의 첫 번째 메뉴를 없음으로 설정합니다.

차트 구성에 대한 자세한 내용은 측정항목 탐색기 사용 시 측정항목 선택을 참조하세요.

trace 보기

trace 데이터를 보려면 다음을 수행합니다.

Google Cloud 콘솔에서 Trace 탐색기 페이지로 이동합니다.
Trace 탐색기로 이동

검색창을 사용하여 이 페이지를 찾을 수도 있습니다.
분산형 차트에서 URI가 /multi인 trace를 선택합니다.
trace 세부정보 패널의 Gantt 차트에서 /multi 라벨이 지정된 스팬을 선택합니다.

HTTP 요청에 대한 정보가 표시된 패널이 열립니다. 이러한 세부정보에는 메서드, 상태 코드, 바이트 수, 호출자의 사용자 에이전트가 포함됩니다.
이 trace와 연결된 로그를 보려면 로그 및 이벤트 탭을 선택합니다.

탭에는 개별 로그가 표시됩니다. 로그 항목의 세부정보를 보려면 로그 항목을 펼칩니다. 로그 보기를 클릭하고 로그 탐색기를 사용하여 로그를 볼 수도 있습니다.

Cloud Trace 탐색기 사용에 대한 자세한 내용은 trace 찾기 및 탐색을 참조하세요.

로그 보기

로그 탐색기에서 로그를 검사할 수 있으며 연결된 trace가 있는 경우 이를 볼 수도 있습니다.

Google Cloud 콘솔에서 로그 탐색기 페이지로 이동합니다.
로그 탐색기로 이동

검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Logging인 결과를 선택합니다.
handle /multi request라는 설명이 포함된 로그를 찾습니다.

로그 세부정보를 보려면 로그 항목을 확장합니다.
'handle /multi request' 메시지가 있는 로그 항목에서 trace를 클릭한 후 trace 세부정보 보기를 선택합니다.

trace 세부정보 패널이 열리고 선택한 trace가 표시됩니다.

로그 탐색기 사용에 대한 자세한 내용은 로그 탐색기를 사용하여 로그 보기를 참조하세요.