nginx

Integrasi nginx mengumpulkan metrik koneksi dan log akses. Metrik koneksi merekam status koneksi saat ini: aktif, membaca, atau menunggu. Log akses diuraikan untuk mendapatkan detail koneksinya, yang mencakup kolom yang dipetakan ke permintaan, klien, server, dan pesan.

Untuk mengetahui informasi selengkapnya tentang nginx, lihat dokumentasi nginx.

Prasyarat

Untuk mengumpulkan telemetri nginx, Anda harus menginstal Agen Operasional:

• Untuk metrik, instal versi 2.1.0 atau yang lebih tinggi.
• Untuk log, instal versi 2.1.0 atau yang lebih tinggi.

Integrasi ini mendukung nginx versi 1.18 dan 1.20.

Mengonfigurasi instance nginx

Anda harus mengaktifkan modul stub_status di file konfigurasi nginx untuk menyiapkan URL yang dapat dijangkau secara lokal, misalnya, http://www.example.com/nginx_status untuk halaman status. Untuk mengaktifkan modul stub_status, selesaikan langkah-langkah berikut:

1. Edit file status.conf, atau buat file jika tidak ada. Anda dapat menemukan file ini di direktori konfigurasi nginx, biasanya ditemukan di /etc/nginx/conf.d.

2. Tambahkan baris berikut ke bagian server:

   location /nginx_status {
       stub_status on;
       access_log off;
       allow 127.0.0.1;
       deny all;
   }
   

   File konfigurasi Anda mungkin terlihat seperti contoh berikut:

   server {
      listen 80;
      server_name 127.0.0.1;
      location /nginx_status {
          stub_status on;
          access_log off;
          allow 127.0.0.1;
          deny all;
      }
      location / {
          root /dev/null;
      }
   }
   

3. Muat ulang konfigurasi nginx.

   sudo service nginx reload
   

Anda dapat menjalankan perintah berikut untuk mengotomatiskan langkah-langkah sebelumnya. File ini akan membuat file status.conf jika belum ada atau menimpa file yang sudah ada jika ada. Perintah ini mengaktifkan stub_status, memuat ulang nginx, dan memverifikasi bahwa informasi yang diharapkan diekspos melalui endpoint.

sudo tee /etc/nginx/conf.d/status.conf > /dev/null << EOF
server {
    listen 80;
    server_name 127.0.0.1;
    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    location / {
       root /dev/null;
    }
}
EOF
sudo service nginx reload
curl http://127.0.0.1:80/nginx_status

Contoh outputnya adalah:

Active connections: 1
server accepts handled requests
 23 23 74
Reading: 0 Writing: 1 Waiting: 0

Atau, alih-alih menggunakan file status.conf terpisah, Anda juga dapat langsung menyematkan baris ke file nginx.conf utama, yang biasanya terletak di salah satu direktori berikut: /etc/nginx, /usr/local/nginx/conf, atau /usr/local/etc/nginx.

Mengonfigurasi Agen Operasional untuk nginx

Dengan mengikuti panduan untuk Mengonfigurasi Agen Operasional, tambahkan elemen yang diperlukan untuk mengumpulkan telemetri dari instance nginx, dan mulai ulang agen.

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk nginx:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    nginx:
      type: nginx
      stub_status_url: http://127.0.0.1:80/nginx_status
  service:
    pipelines:
      nginx:
        receivers:
          - nginx
logging:
  receivers:
    nginx_access:
      type: nginx_access
    nginx_error:
      type: nginx_error
  service:
    pipelines:
      nginx:
        receivers:
          - nginx_access
          - nginx_error
EOF

Agar perubahan ini diterapkan, Anda harus memulai ulang Agen Operasi:

Mengonfigurasi pengumpulan log

Untuk menyerap log dari nginx, Anda harus membuat penerima untuk log yang dihasilkan nginx, lalu membuat pipeline untuk penerima baru.

Untuk mengonfigurasi penerima log nginx_access, tentukan kolom berikut:

Untuk mengonfigurasi penerima log nginx_error, tentukan kolom berikut:

Apa itu log?

logName berasal dari ID penerima yang ditentukan dalam konfigurasi. Kolom mendetail dalam LogEntry adalah sebagai berikut.

Log nginx_access berisi kolom berikut dalam LogEntry:

Log nginx_error berisi kolom berikut dalam LogEntry:

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari nginx, Anda harus membuat penerima untuk metrik yang dihasilkan nginx, lalu membuat pipeline untuk penerima baru.

Penerima ini tidak mendukung penggunaan beberapa instance dalam konfigurasi, misalnya, untuk memantau beberapa endpoint. Semua instance tersebut menulis ke deret waktu yang sama, dan Cloud Monitoring tidak dapat membedakannya.

Untuk mengonfigurasi penerima metrik nginx, tentukan kolom berikut:

Yang dipantau

Tabel berikut berisi daftar metrik yang dikumpulkan Ops Agent dari instance nginx.

Memverifikasi konfigurasi

Bagian ini menjelaskan cara memverifikasi bahwa Anda telah mengonfigurasi penerima nginx dengan benar. Mungkin perlu waktu satu atau dua menit agar Agen Operasi mulai mengumpulkan telemetri.

Untuk memverifikasi bahwa log nginx dikirim ke Cloud Logging, lakukan hal berikut:

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

   Buka Logs Explorer

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

2. Masukkan kueri berikut di editor, lalu klik Run query:
   

   resource.type="gce_instance"
   (log_id("nginx_access") OR log_id("nginx_error"))
   

Untuk memverifikasi bahwa metrik nginx dikirim ke Cloud Monitoring, lakukan hal berikut:

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

   Buka Metrics explorer

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

2. Di toolbar panel pembuat kueri, pilih tombol yang namanya code MQL atau code PromQL.
3. Pastikan PromQL dipilih di tombol Language. Tombol bahasa ada di toolbar yang sama yang memungkinkan Anda memformat kueri.
4. Masukkan kueri berikut di editor, lalu klik Run query:
   

   {"workload.googleapis.com/nginx.requests", monitored_resource="gce_instance"}
   

Lihat dasbor

Untuk melihat metrik nginx, Anda harus mengonfigurasi diagram atau dasbor. Integrasi nginx menyertakan satu atau beberapa dasbor untuk Anda. Dasbor apa pun akan otomatis diinstal setelah Anda mengonfigurasi integrasi dan Agen Operasional mulai mengumpulkan data metrik.

Anda juga dapat melihat pratinjau statis dasbor tanpa menginstal integrasi.

Untuk melihat dasbor yang terinstal, lakukan tindakan berikut:

1. Di konsol Google Cloud , buka halaman  Dasbor:

   Buka Dasbor

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

2. Pilih tab Daftar Dasbor, lalu pilih kategori Integrasi.
3. Klik nama dasbor yang ingin Anda lihat.

Jika Anda telah mengonfigurasi integrasi, tetapi dasbor belum diinstal, periksa apakah Agen Operasional sedang berjalan. Jika tidak ada data metrik untuk diagram di dasbor, penginstalan dasbor akan gagal. Setelah Agen Operasi mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.

Untuk melihat pratinjau statis dasbor, lakukan tindakan berikut:

1. Di konsol Google Cloud , buka halaman  Integrations:

   Buka Integrations

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

2. Klik filter platform deployment Compute Engine.
3. Temukan entri untuk nginx lalu klik Lihat Detail.
4. Pilih tab Dasbor untuk melihat pratinjau statis. Jika dasbor telah diinstal, Anda dapat membukanya dengan mengklik Lihat dasbor.

Untuk mengetahui informasi selengkapnya tentang dasbor di Cloud Monitoring, lihat Dasbor dan diagram.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi tertentu terjadi. Integrasi nginx mencakup satu atau beberapa kebijakan pemberitahuan yang dapat Anda gunakan. Anda dapat melihat dan menginstal kebijakan pemberitahuan ini dari halaman Integrasi di Monitoring.

Untuk melihat deskripsi kebijakan pemberitahuan yang tersedia dan menginstalnya, lakukan langkah berikut:

1. Di konsol Google Cloud , buka halaman  Integrations:

   Buka Integrations

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

2. Temukan entri untuk nginx lalu klik Lihat Detail.
3. Pilih tab Peringatan. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
4. Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana harus mengirimkan notifikasi bahwa pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan. Untuk menginstal kebijakan pemberitahuan, lakukan hal berikut:
   1. Dari daftar kebijakan pemberitahuan yang tersedia, pilih kebijakan yang ingin Anda instal.

   2. Di bagian Konfigurasi notifikasi, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi, tetapi jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara diam-diam. Anda dapat memeriksa statusnya di Monitoring, tetapi Anda tidak menerima notifikasi.

      Untuk mengetahui informasi selengkapnya tentang saluran notifikasi, lihat Mengelola saluran notifikasi.

   3. Klik Buat Kebijakan.

Untuk mengetahui informasi selengkapnya tentang kebijakan pemberitahuan di Cloud Monitoring, lihat Pengantar tentang pemberitahuan.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Pemecahan masalah

Di sebagian besar distribusi, nginx dilengkapi dengan ngx_http_stub_status_module yang diaktifkan. Anda dapat memeriksa apakah modul diaktifkan dengan menjalankan perintah berikut:

sudo nginx -V 2>&1 | grep -o with-http_stub_status_module

Output yang diharapkan adalah with-http_stub_status_module, yang berarti modul diaktifkan. Dalam kasus yang jarang terjadi, jika perintah tidak menampilkan output, Anda harus mengompilasi nginx dari sumber dengan -with-http_stub_status_module mengikuti dokumentasi publik nginx.

Langkah berikutnya

Untuk melihat panduan cara menggunakan Ansible guna menginstal Agen Operasional, mengonfigurasi aplikasi pihak ketiga, dan menginstal dasbor contoh, tonton video Menginstal Agen Operasional untuk memecahkan masalah aplikasi pihak ketiga.