Contoh instrumentasi Node.js

Anda dapat melengkapi aplikasi JavaScript Node.js untuk mengumpulkan data trace dan metrik dengan SDK OpenTelemetry dan kolektor OpenTelemetry, serta menulis log JSON terstruktur yang berkorelasi ke output standar. Untuk bereksperimen dengan instrumentasi ini, Anda dapat mendownload dan menjalankan aplikasi Fastify contoh, yang menghasilkan data log, metrik, dan trace, serta mengekspornya ke projectGoogle Cloud Anda.

Tentang pendekatan instrumentasi

Saat menggunakan kolektor OpenTelemetry, Anda menginstrumentasi aplikasi dengan SDK dan pengekspor dalam proses OTLP SDK. Instrumentasi ini bersifat netral terhadap vendor. Anda juga men-deploy kolektor OpenTelemetry yang menerima telemetri dari pengekspor dalam proses, lalu mengekspor telemetri tersebut ke project Google Cloud Anda. Untuk mempelajari lebih lanjut kolektor, lihat Kolektor OpenTelemetry Buatan Google.

Sebaiknya gunakan kolektor OpenTelemetry untuk mengekspor data telemetri Anda jika lingkungan Anda mendukung penggunaan kolektor. Untuk beberapa lingkungan, Anda harus menggunakan pengekspor dalam proses yang langsung mengirim data ke projectGoogle Cloud Anda. Untuk mempelajari instrumentasi dalam proses, lihat Bermigrasi dari pengekspor Trace ke endpoint OTLP.

Untuk mempelajari instrumentasi lebih lanjut, lihat dokumen berikut:

• Kemampuan observasi untuk developer aplikasi
• Memilih pendekatan instrumentasi

Tentang instrumentasi manual dan tanpa kode

Untuk bahasa ini, OpenTelemetry mendefinisikan instrumentasi tanpa kode sebagai praktik pengumpulan telemetri dari library dan framework tanpa melakukan perubahan kode. Namun, Anda harus menginstal modul dan menetapkan variabel lingkungan.

Dokumen ini tidak menjelaskan instrumentasi tanpa kode. Untuk mengetahui informasi tentang topik tersebut, lihat Instrumentasi tanpa kode JavaScript.

Untuk mengetahui informasi umum, lihat Instrumentasi OpenTelemetry untuk Node.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Buat atau pilih project Google Cloud .

Peran yang diperlukan untuk memilih atau membuat project

• Memilih project: Memilih project tidak memerlukan peran IAM tertentu—Anda dapat memilih project apa pun yang perannya telah diberikan kepada Anda.
• Membuat project: Untuk membuat project, Anda memerlukan peran Project Creator (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang akan menghapus semua resource yang terkait dengan project ini.

• Buat project Google Cloud :

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih project Google Cloud yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama project Google Cloud Anda.

Pastikan penagihan diaktifkan untuk project Google Cloud Anda.

Aktifkan Cloud Logging, Cloud Monitoring, Cloud Trace, dan Telemetry API, jika belum diaktifkan:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Service Usage Admin (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

gcloud services enable logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com telemetry.googleapis.com

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Buat atau pilih project Google Cloud .

Peran yang diperlukan untuk memilih atau membuat project

• Memilih project: Memilih project tidak memerlukan peran IAM tertentu—Anda dapat memilih project apa pun yang perannya telah diberikan kepada Anda.
• Membuat project: Untuk membuat project, Anda memerlukan peran Project Creator (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang akan menghapus semua resource yang terkait dengan project ini.

• Buat project Google Cloud :

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih project Google Cloud yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama project Google Cloud Anda.

Pastikan penagihan diaktifkan untuk project Google Cloud Anda.

Aktifkan Cloud Logging, Cloud Monitoring, Cloud Trace, dan Telemetry API, jika belum diaktifkan:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Service Usage Admin (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

gcloud services enable logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com telemetry.googleapis.com

1. Untuk mendapatkan izin yang Anda perlukan agar aplikasi contoh dapat menulis data log, metrik, dan trace, minta administrator untuk memberi Anda peran IAM berikut:

   • Logs Writer (roles/logging.logWriter) di project Anda
   • Monitoring Metric Writer (roles/monitoring.metricWriter) di project Anda
   • Cloud Telemetry Traces Writer (roles/telemetry.tracesWriter) di project Anda
   • Service Usage Consumer (roles/serviceusage.serviceUsageConsumer) di project kuota Anda

   Izin ini sudah cukup jika Anda menjalankan contoh di Cloud Shell, di resource Google Cloud , atau di lingkungan pengembangan lokal. Untuk mempelajari cara mengonfigurasi project kuota, lihat Menetapkan project kuota.

   Penting: Aplikasi produksi biasanya mengandalkan akun layanan untuk memberikan kredensial yang diperlukan untuk menulis data log, metrik, dan trace. Dalam skenario tersebut, berikan peran sebelumnya ke akun layanan.

   Untuk mendapatkan izin yang Anda perlukan untuk melihat data log, metrik, dan trace, minta administrator untuk memberi Anda peran IAM berikut pada project Anda:

   • Logs Viewer (roles/logging.viewer)
   • Monitoring Viewer (roles/monitoring.viewer)
   • Cloud Trace User (roles/cloudtrace.user)

   Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

   Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Melengkapi aplikasi Anda untuk mengumpulkan trace, metrik, dan log

Catatan: Dokumen ini hanya menampilkan bagian tertentu dari aplikasi yang berfungsi. Misalnya, contoh tidak menampilkan daftar paket yang diimpor. Namun, aplikasi lengkapnya tersedia di GitHub. Untuk melihat contoh lengkap, di toolbar contoh, pilih logo GitHub.

Untuk melengkapi aplikasi Anda agar dapat mengumpulkan data trace dan metrik serta menulis log JSON terstruktur ke output standar, lakukan langkah-langkah berikut:

1. Mengonfigurasi OpenTelemetry
2. Mengonfigurasi aplikasi untuk melakukan pramuat konfigurasi OpenTelemetry
3. Mengonfigurasi logging terstruktur
4. Menulis log terstruktur

Mengonfigurasi OpenTelemetry

Konfigurasi default untuk SDK Node.js OpenTelemetry mengekspor trace menggunakan protokol OTLP. Kode ini juga mengonfigurasi OpenTelemetry untuk menggunakan format W3C Trace Context untuk menyebarkan konteks trace. Konfigurasi ini memastikan bahwa span memiliki hubungan induk-turunan yang benar dalam trace.

Contoh kode berikut mengilustrasikan modul JavaScript untuk menyiapkan OpenTelemetry.

Untuk melihat contoh lengkap, di toolbar contoh, pilih logo GitHub.

diag.setLogger(
  new DiagConsoleLogger(),
  opentelemetry.core.diagLogLevelFromString(
    opentelemetry.core.getStringFromEnv('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));
});

Contoh kode sebelumnya mengonfigurasi OpenTelemetry untuk mengekspor metrik menggunakan protokol OTLP, dan menggunakan paket @opentelemetry/auto-instrumentations-node untuk mengonfigurasi semua instrumentasi Node.js yang tersedia.

Untuk memastikan bahwa semua telemetri yang tertunda dihapus dan koneksi ditutup dengan baik sebelum aplikasi dihentikan, pengendali SIGTERM memanggil shutdown.

Untuk mengetahui informasi dan opsi konfigurasi selengkapnya, lihat Konfigurasi Instrumentasi Tanpa Kode.

Mengonfigurasi aplikasi Anda untuk melakukan pramuat konfigurasi OpenTelemetry

Untuk mengonfigurasi aplikasi agar menulis log terstruktur dan mengumpulkan data metrik dan trace menggunakan OpenTelemetry, perbarui pemanggilan aplikasi Anda untuk melakukan pramuat modul instrumentasi dengan flag --require Node.js. Menggunakan flag --require memastikan bahwa OpenTelemetry diinisialisasi sebelum aplikasi Anda dimulai. Untuk mengetahui informasi selengkapnya, lihat Panduan Memulai OpenTelemetry Node.js.

Contoh kode berikut mengilustrasikan Dockerfile yang meneruskan flag --require:

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

Mengonfigurasi logging terstruktur

Untuk menyertakan informasi trace sebagai bagian dari log berformat JSON yang ditulis ke output standar, konfigurasikan aplikasi Anda untuk menghasilkan log terstruktur dalam format JSON.

Catatan: Contoh kode berikut bergantung pada Fastify, yang menggunakan framework log Pino dan menyediakan logger di setiap pengendali permintaan. Fungsi timestamp yang ditentukan dalam contoh menampilkan pasangan nilai kunci, dengan kunci diberi label "timestamp". Jika data log Anda tidak muncul seperti yang diharapkan, coba tetapkan kunci ke "time", bukan "timestamp".

Contoh kode berikut mengilustrasikan objek LoggerOptions Pino yang mengonfigurasi aplikasi untuk menghasilkan log terstruktur JSON:

// 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;

Konfigurasi sebelumnya mengekstrak informasi tentang span aktif dari pesan log, lalu menambahkan informasi tersebut sebagai atribut ke log terstruktur JSON. Atribut ini kemudian dapat digunakan untuk menghubungkan log dengan trace:

• logging.googleapis.com/trace: Nama resource trace yang terkait dengan entri log.
• logging.googleapis.com/spanId: ID span dalam trace yang terkait dengan entri log.
• logging.googleapis.com/trace_sampled: Nilai kolom ini harus berupa true atau false.

Untuk mengetahui informasi selengkapnya tentang kolom ini, lihat struktur LogEntry.

Untuk menggunakan konfigurasi Pino dengan Fastify, teruskan objek konfigurasi logger saat membuat aplikasi Fastify:

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

Menulis log terstruktur

Untuk menulis log terstruktur yang ditautkan ke trace, gunakan pencatat log Pino yang disediakan Fastify. Misalnya, pernyataan berikut menunjukkan cara memanggil metode Logger.info():

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

OpenTelemetry otomatis mengisi entri log Pino dengan konteks span dari span aktif saat ini di Konteks OpenTelemetry. Konteks span ini kemudian disertakan dalam log JSON seperti yang dijelaskan dalam Mengonfigurasi logging terstruktur.

Menjalankan aplikasi contoh yang dikonfigurasi untuk mengumpulkan telemetri

Instrumentasi dalam aplikasi contoh menggunakan format yang tidak bergantung pada vendor, seperti JSON untuk data log dan OTLP untuk data metrik dan trace. Aplikasi ini juga menggunakan framework Fastify. Collector OpenTelemetry mengirimkan data log, metrik, dan trace ke project Anda menggunakan Telemetry API, yang menggunakan OTLP.

Aplikasi ini memiliki dua endpoint:

• Endpoint /multi ditangani oleh fungsi handleMulti. Generator beban di aplikasi mengeluarkan permintaan ke endpoint /multi. Saat endpoint ini menerima permintaan, endpoint ini akan mengirimkan antara tiga hingga tujuh permintaan ke endpoint /single di server lokal.

  /**
   * 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';
  });

• Endpoint /single ditangani oleh fungsi handleSingle. Saat menerima permintaan, endpoint ini akan tidur selama penundaan singkat, lalu merespons dengan string.

  /**
   * 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`;
  });

Mendownload dan men-deploy aplikasi

Catatan: Sebaiknya jalankan aplikasi contoh menggunakan Cloud Shell. Namun, jika Anda ingin menjalankan aplikasi contoh secara lokal di Linux atau Mac, lewati langkah pertama dalam petunjuk berikut.

Untuk menjalankan contoh, lakukan hal berikut:

1. Di konsol Google Cloud , aktifkan Cloud Shell.

   Aktifkan Cloud Shell

   Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan prompt command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.

2. Buat clone repositori:

   git clone https://github.com/GoogleCloudPlatform/opentelemetry-samples
   

3. Buka direktori contoh:

   cd opentelemetry-samples/javascript/instrumentation-quickstart
   

4. Bangun dan jalankan contoh:

   docker compose up --abort-on-container-exit
   

   Jika Anda tidak menjalankannya di Cloud Shell, jalankan aplikasi dengan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS yang mengarah ke file kredensial. Kredensial Default Aplikasi menyediakan file kredensial di $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
   

Melihat metrik Anda

Instrumentasi OpenTelemetry di aplikasi contoh menghasilkan metrik Prometheus yang dapat Anda lihat menggunakan Metrics Explorer:

• Prometheus/http_server_duration_milliseconds/histogram mencatat durasi permintaan server dan menyimpan hasilnya dalam histogram.

• Prometheus/http_client_duration_milliseconds/histogram mencatat durasi permintaan klien dan menyimpan hasilnya dalam histogram.

Untuk melihat metrik yang dihasilkan oleh aplikasi contoh, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman  Metrics explorer:

   Buka Metrics explorer

   Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Monitoring.

2. Di toolbar konsol Google Cloud , pilih project Google Cloud Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan folder khusus aplikasi.
3. Pada elemen Metrik, luaskan menu Pilih metrik, masukkan http_server di panel filter, lalu gunakan submenu untuk memilih jenis dan metrik resource tertentu:
   1. Di menu Active resources, pilih Prometheus Target.
   2. Di menu Active metric categories, pilih Http.
   3. Di menu Active metrics, pilih metrik.
   4. Klik Terapkan.

4. Untuk menambahkan filter, yang menghapus deret waktu dari hasil kueri, gunakan elemen Filter.

5. Konfigurasi cara data dilihat.
   

   Jika pengukuran untuk metrik bersifat kumulatif, Metrics Explorer akan otomatis menormalisasi data yang diukur berdasarkan periode penyelarasan, sehingga diagram menampilkan rasio. Untuk mengetahui informasi selengkapnya, lihat Jenis, tipe, dan konversi.

   Saat nilai bilangan bulat atau ganda diukur, seperti dengan dua metrik counter, Metrics Explorer akan otomatis menjumlahkan semua deret waktu. Untuk melihat data rute HTTP /multi dan /single, tetapkan menu pertama entri Aggregation ke None.

   Untuk informasi selengkapnya tentang cara mengonfigurasi diagram, lihat Memilih metrik saat menggunakan Metrics Explorer.

Melihat trace Anda

Mungkin perlu waktu beberapa menit sebelum data trace Anda tersedia. Misalnya, saat data trace diterima oleh project Anda, Google Cloud Observability mungkin perlu membuat database untuk menyimpan data tersebut. Pembuatan database dapat memerlukan waktu beberapa menit, dan selama periode tersebut, tidak ada data trace yang tersedia untuk dilihat.

Untuk melihat data trace, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman Trace explorer:

   Buka Trace explorer

   Anda juga dapat menemukan halaman ini menggunakan kotak penelusuran.

2. Di bagian tabel halaman, pilih baris dengan nama span /multi.

3. Di diagram Gantt pada panel Trace details, pilih span berlabel /multi.

   Panel yang menampilkan informasi tentang permintaan HTTP akan terbuka. Detail ini mencakup metode, kode status, jumlah byte, dan agen pengguna pemanggil.

4. Untuk melihat log yang terkait dengan trace ini, pilih tab Logs & Events.

   Tab ini menampilkan setiap log. Untuk melihat detail entri log, luaskan entri log. Anda juga dapat mengklik View Logs dan melihat log menggunakan Logs Explorer.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Trace Explorer, lihat Menemukan dan menjelajahi trace.

Melihat log

Dari Logs Explorer, Anda dapat memeriksa log, dan juga dapat melihat trace terkait, jika ada.

1. Di konsol Google Cloud , buka halaman segmen Logs Explorer:

   Buka Logs Explorer

   Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

2. Temukan log dengan deskripsi handle /multi request.

   Untuk melihat detail log, luaskan entri log.

3. Klik Traces pada entri log dengan pesan "handle /multi request", lalu pilih View trace details.

   Panel Trace details akan terbuka dan menampilkan trace yang dipilih.

   Data log Anda mungkin tersedia beberapa menit sebelum data trace Anda tersedia. Jika Anda mengalami error saat melihat data trace, baik dengan menelusuri trace berdasarkan ID atau dengan mengikuti langkah-langkah dalam tugas ini, tunggu satu atau dua menit, lalu coba lagi tindakan tersebut.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan Logs Explorer, lihat Melihat log menggunakan Logs Explorer.

Langkah berikutnya

• OpenTelemetry
• Spesifikasi OTLP
• Logging terstruktur
• Memecahkan masalah Managed Service for Prometheus
• Memecahkan masalah Cloud Trace