Integrasi nginx mengumpulkan metrik koneksi dan mengakses log. Metrik koneksi merekam status koneksi saat ini: aktif, membaca, atau menunggu. Log akses diuraikan untuk mengetahui 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
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:
Edit file
status.conf
, atau buat file tersebut jika tidak ada. Anda dapat menemukan file ini di direktori konfigurasi nginx, yang biasanya ditemukan di/etc/nginx/conf.d
.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; } }
Muat ulang konfigurasi nginx.
sudo service nginx reload
Anda dapat menjalankan perintah berikut untuk mengotomatiskan langkah sebelumnya. Tindakan ini akan membuat
file status.conf
jika tidak ada, atau menimpa file yang sudah ada jika
ada. Perintah ini akan 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 output-nya adalah:
Active connections: 1 server accepts handled requests 23 23 74 Reading: 0 Writing: 1 Waiting: 0
Atau, sebagai ganti 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, lalu mulai ulang agen.
Contoh konfigurasi
Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk nginx dan memulai ulang Agen Operasional.
Mengonfigurasi koleksi log
Untuk menyerap log dari nginx, Anda harus membuat penerima untuk log yang dihasilkan nginx, lalu membuat pipeline untuk penerima baru.
Untuk mengonfigurasi penerima untuk log nginx_access
Anda, tentukan kolom
berikut:
Kolom | Default | Deskripsi |
---|---|---|
exclude_paths |
Daftar pola jalur sistem file yang akan dikecualikan dari kumpulan yang cocok dengan include_paths . |
|
include_paths |
[/var/log/nginx/access.log] |
Daftar jalur sistem file yang akan dibaca dengan melakukan tailing setiap file. Karakter pengganti (* ) dapat digunakan di jalur. |
record_log_file_path |
false |
Jika ditetapkan ke true , jalur ke file tertentu tempat data log diperoleh akan muncul dalam entri log output sebagai nilai label agent.googleapis.com/log_file_path . Saat menggunakan karakter pengganti, hanya jalur file tempat data diperoleh yang akan dicatat. |
type |
Nilai harus berupa nginx_access . |
|
wildcard_refresh_interval |
60s |
Interval tempat jalur file karakter pengganti di include_paths diperbarui. Diberikan sebagai durasi waktu yang dapat diuraikan oleh time.ParseDuration , misalnya 30s atau 2m . Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log diputar lebih cepat daripada interval default. |
Untuk mengonfigurasi penerima untuk log nginx_error
Anda, tentukan kolom
berikut:
Kolom | Default | Deskripsi |
---|---|---|
exclude_paths |
Daftar pola jalur sistem file yang akan dikecualikan dari kumpulan yang cocok dengan include_paths . |
|
include_paths |
[/var/log/nginx/error.log] |
Daftar jalur sistem file yang akan dibaca dengan melakukan tailing setiap file. Karakter pengganti (* ) dapat digunakan di jalur. |
record_log_file_path |
false |
Jika ditetapkan ke true , jalur ke file tertentu tempat data log diperoleh akan muncul dalam entri log output sebagai nilai label agent.googleapis.com/log_file_path . Saat menggunakan karakter pengganti, hanya jalur file tempat data diperoleh yang akan dicatat. |
type |
Nilai harus berupa nginx_error . |
|
wildcard_refresh_interval |
60s |
Interval tempat jalur file karakter pengganti di include_paths diperbarui. Diberikan sebagai durasi waktu yang dapat diuraikan oleh time.ParseDuration , misalnya 30s atau 2m . Properti ini mungkin berguna pada throughput logging yang tinggi dengan file log diputar lebih cepat daripada interval default. |
Apa itu log?
logName
berasal dari
ID penerima yang ditentukan dalam konfigurasi. Kolom mendetail di dalam
LogEntry
adalah sebagai berikut.
Log nginx_access
berisi kolom berikut di LogEntry
:
Kolom | Jenis | Deskripsi |
---|---|---|
httpRequest |
objek | Lihat HttpRequest |
jsonPayload.host |
string | Konten header Host (biasanya tidak dilaporkan oleh nginx) |
jsonPayload.level |
string | Level entri log |
jsonPayload.user |
string | Nama pengguna yang diautentikasi untuk permintaan |
severity |
string (LogSeverity ) |
Tingkat entri log (diterjemahkan). |
Log nginx_error
berisi kolom berikut di LogEntry
:
Kolom | Jenis | Deskripsi |
---|---|---|
jsonPayload.client |
string | Alamat IP klien (opsional) |
jsonPayload.connection |
angka | ID Koneksi |
jsonPayload.host |
string | Header host (opsional) |
jsonPayload.level |
string | Level entri log |
jsonPayload.message |
string | Pesan log |
jsonPayload.pid |
angka | ID proses yang menerbitkan log |
jsonPayload.referer |
string | Header perujuk (opsional) |
jsonPayload.request |
string | Permintaan HTTP asli (opsional) |
jsonPayload.server |
string | Nama server Nginx (opsional) |
jsonPayload.subrequest |
string | Subpermintaan Nginx (opsional) |
jsonPayload.tid |
angka | ID thread tempat log berasal |
jsonPayload.upstream |
string | URI permintaan upstream (opsional) |
severity |
string (LogSeverity ) |
Tingkat entri log (diterjemahkan). |
Mengonfigurasi pengumpulan metrik
Untuk menyerap metrik dari nginx, Anda harus membuat penerima untuk metrik yang dihasilkan nginx, lalu membuat pipeline untuk penerima baru tersebut.
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
Anda, tentukan kolom
berikut:
Kolom | Default | Deskripsi |
---|---|---|
collection_interval |
60s |
Durasi waktu, seperti 30s atau 5m . |
server_status_url |
http://localhost/status |
URL yang diekspos oleh modul status stub nginx. |
type |
Nilai ini harus nginx . |
Apa yang dipantau
Tabel berikut menyediakan daftar metrik yang dikumpulkan Agen Operasional dari instance nginx.
Jenis metrik | |
---|---|
Jenis, Jenis Resource yang dipantau |
Label |
workload.googleapis.com/nginx.connections_accepted
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/nginx.connections_current
|
|
GAUGE , INT64 gce_instance |
state
|
workload.googleapis.com/nginx.connections_handled
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/nginx.requests
|
|
CUMULATIVE , INT64 gce_instance |
Memverifikasi konfigurasi
Bagian ini menjelaskan cara memverifikasi bahwa Anda telah mengonfigurasi penerima nginx dengan benar. Mungkin perlu waktu satu atau dua menit bagi Agen Operasional untuk mulai mengumpulkan telemetri.
Untuk memastikan bahwa log nginx dikirim ke Cloud Logging, lakukan langkah berikut:
-
Di panel navigasi konsol Google Cloud, pilih Logging, lalu pilih Logs Explorer:
- Masukkan kueri berikut di editor, lalu klik Run query:
resource.type="gce_instance" (log_id("nginx_access") OR log_id("nginx_error"))
Untuk memastikan bahwa metrik nginx dikirim ke Cloud Monitoring, lakukan langkah berikut:
-
Di panel navigasi Konsol Google Cloud, pilih Monitoring, lalu pilih leaderboard Metrics Explorer:
- Di toolbar panel pembuat kueri, pilih tombol dengan nama code MQL atau code PromQL.
- Pastikan MQL dipilih di tombol Language. Tombol bahasa berada di toolbar yang sama yang memungkinkan Anda memformat kueri.
- Masukkan kueri berikut di editor, lalu klik Run query:
fetch gce_instance | metric 'workload.googleapis.com/nginx.requests' | every 1m
Lihat dasbor
Untuk melihat metrik nginx, Anda harus mengonfigurasi diagram atau dasbor. Integrasi nginx menyertakan satu atau beberapa dasbor untuk Anda. Setiap dasbor 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 hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih Dashboards:
- Pilih tab Dashboard List, lalu pilih kategori Integrations.
- Klik nama dasbor yang ingin Anda lihat.
Jika Anda telah mengonfigurasi integrasi tetapi dasbor belum diinstal, pastikan Agen Operasional berjalan. Jika tidak ada data metrik untuk diagram di dasbor, penginstalan dasbor akan gagal. Setelah Agen Operasional mulai mengumpulkan metrik, dasbor akan diinstal untuk Anda.
Untuk melihat pratinjau statis dasbor, lakukan hal berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
- Klik filter platform deployment Compute Engine.
- Temukan entri untuk nginx lalu klik View Details.
- Pilih tab Dashboards untuk melihat pratinjau statis. Jika dasbor sudah diinstal, Anda dapat membukanya dengan mengklik View dasbor.
Untuk mengetahui informasi lebih lanjut tentang dasbor di Cloud Monitoring, lihat Dasbor dan diagram.
Untuk informasi lebih lanjut tentang penggunaan halaman Integrasi, lihat Mengelola integrasi.
Menginstal kebijakan pemberitahuan
Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat terjadi kondisi tertentu. Integrasi nginx mencakup satu atau beberapa kebijakan pemberitahuan untuk Anda gunakan. Anda dapat melihat dan menginstal kebijakan pemberitahuan ini dari halaman Integrations di Monitoring.
Untuk melihat deskripsi kebijakan pemberitahuan yang tersedia dan menginstalnya, lakukan langkah berikut:
-
Di panel navigasi konsol Google Cloud, pilih Monitoring, lalu pilih Integrations:
- Temukan entri untuk nginx lalu klik View Details.
- Pilih tab Alerts. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
- Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui ke mana harus mengirim notifikasi ketika pemberitahuan telah dipicu, sehingga memerlukan informasi dari Anda untuk penginstalan.
Untuk menginstal kebijakan pemberitahuan, lakukan hal berikut:
- Dari daftar kebijakan pemberitahuan yang tersedia, pilih yang ingin Anda instal.
Di bagian Configure notifications, pilih satu atau beberapa saluran notifikasi. Anda memiliki opsi untuk menonaktifkan penggunaan saluran notifikasi. Namun, jika Anda melakukannya, kebijakan pemberitahuan akan diaktifkan secara otomatis. Anda dapat memeriksa statusnya di Monitoring, tetapi tidak akan menerima notifikasi.
Untuk mengetahui informasi selengkapnya tentang saluran notifikasi, lihat Mengelola saluran notifikasi.
- Klik Create Policies.
Untuk mengetahui informasi selengkapnya tentang kebijakan pemberitahuan di Cloud Monitoring, lihat Pengantar pemberitahuan.
Untuk informasi lebih lanjut tentang penggunaan halaman Integrasi, lihat Mengelola integrasi.
Pemecahan masalah
Pada 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
dengan mengikuti dokumentasi
publik nginx.
Langkah selanjutnya
Untuk panduan cara menggunakan Ansible untuk menginstal Agen Operasional, mengonfigurasi aplikasi pihak ketiga, dan menginstal contoh dasbor, lihat video Menginstal Agen Operasional untuk memecahkan masalah aplikasi pihak ketiga.