Mengumpulkan log NGINX
Dokumen ini menjelaskan cara menyerap log NGINX ke Google Security Operations menggunakan agen Bindplane.
NGINX adalah server web dan reverse proxy yang menghasilkan pesan syslog untuk peristiwa akses HTTP, peristiwa error, aktivitas autentikasi, dan informasi proses. Parser mengekstrak kolom dari beberapa format log (syslog, JSON, log akses) menggunakan pola grok dan memetakannya ke Model Data Terpadu (UDM).
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Windows Server 2016 atau yang lebih baru, atau host Linux dengan
systemd - Konektivitas jaringan antara agen Bindplane dan server NGINX
- Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
- Akses administratif ke host NGINX
Mendapatkan kredensial Google SecOps untuk agen Bindplane
Untuk mengautentikasi agen Bindplane ke Google SecOps, pilih salah satu metode berikut:
- Deployment baru: Gunakan Chronicle API (Opsi 1).
- Deployment lama: Terus gunakan file autentikasi penyerapan (Opsi 2) hingga Ingestion API dihentikan pada 20 Juli 2027.
Opsi 1: Membuat akun layanan untuk Chronicle API (direkomendasikan)
- Login ke Google Cloud konsol dan pilih project Google Cloud yang ditautkan ke instance Google SecOps Anda.
- Buka IAM & Admin > Service Accounts.
- Klik Create service account.
- Berikan detail konfigurasi berikut:
- Service account name: Masukkan nama akun (misalnya,
bindplane-ingest). - Deskripsi akun layanan: Masukkan deskripsi (misalnya,
Bindplane agent log ingestion).
- Service account name: Masukkan nama akun (misalnya,
- Klik Create and continue.
- Di bagian Grant this service account access to project, klik Select a role, lalu pilih Chronicle Editor.
- Klik Continue lalu klik Done.
- Klik akun layanan yang Anda buat, lalu buka tab Keys.
- Klik Add key > Create new key.
- Pilih JSON, lalu klik Create. File kunci didownload ke komputer Anda.
- Simpan file kunci sebagai
ingestion-auth.jsondi direktori Bindplane collector (/opt/observiq-otel-collector/ingestion-auth.jsondi Linux atauC:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.jsondi Windows), atau perbaruicreds_file_pathdiconfig.yamlagar sesuai dengan jalur tempat Anda menyimpannya. - Buka IAM & Admin > Settings dan salin Project number. Anda akan memerlukannya untuk konfigurasi pengekspor.
Opsi 2: Mendownload file autentikasi penyerapan (lama)
- Login ke konsol Google SecOps.
- Buka SIEM Settings > Collection Agents.
- Download file autentikasi penyerapan.
- Simpan file dengan aman di sistem tempat agen Bindplane akan diinstal.
Mendapatkan ID pelanggan Google SecOps
- Login ke konsol Google SecOps.
- Buka SIEM Settings > Profile.
Salin dan simpan ID Pelanggan dari bagian Detail Organisasi.
Menginstal agen Bindplane
Instal agen Bindplane di sistem operasi Windows atau Linux Anda sesuai dengan petunjuk berikut.
Penginstalan Windows
- Buka Command Prompt atau PowerShell sebagai administrator.
Jalankan perintah berikut:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietTunggu hingga penginstalan selesai.
Verifikasi penginstalan dengan menjalankan:
sc query observiq-otel-collectorLayanan akan ditampilkan sebagai RUNNING.
Penginstalan Linux
- Buka terminal dengan hak istimewa root atau sudo.
Jalankan perintah berikut:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shTunggu hingga penginstalan selesai.
Verifikasi penginstalan dengan menjalankan:
sudo systemctl status observiq-otel-collectorLayanan akan ditampilkan sebagai aktif (berjalan).
Referensi penginstalan tambahan
Untuk opsi penginstalan dan pemecahan masalah tambahan, lihat Panduan penginstalan agen BindPlane.
Mengonfigurasi agen Bindplane untuk menyerap syslog dan mengirimkannya ke Google SecOps
Menemukan file konfigurasi
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
Edit file konfigurasi
Ganti seluruh konten
config.yamldengan konfigurasi berikut:receivers: udplog: listen_address: "0.0.0.0:514" exporters: chronicle/nginx: protocol: https # Region of your instance, for example us, europe, asia-southeast1 location: <LOCATION> # Project number of the Google Cloud project linked to the instance project: '<PROJECT_NUMBER>' compression: gzip creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: chronicle.googleapis.com log_type: NGINX raw_log_field: body service: pipelines: logs/nginx_to_chronicle: receivers: - udplog exporters: - chronicle/nginx
Parameter konfigurasi
Ganti placeholder berikut:
Konfigurasi penerima:
listen_address: Alamat IP dan port untuk diproses:0.0.0.0untuk memproses semua antarmuka (direkomendasikan)- Port
514adalah port syslog standar (memerlukan root di Linux; gunakan1514untuk non-root)
Konfigurasi pengekspor:
creds_file_path: Jalur lengkap ke file kunci JSON akun layanan (Opsi 1):- Linux:
/opt/observiq-otel-collector/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
customer_id: ID Pelanggan yang disalin dari konsol Google SecOpslocation: Ganti<LOCATION>dengan region instance Google SecOps Anda (misalnya,us,europe, atauasia-southeast1). Pengekspor akan menambahkan awalanchronicle.googleapis.comdengan nilai ini. Lihat Endpoint Regional untuk mengetahui daftar lengkapnya.project: Ganti<PROJECT_NUMBER>dengan nomor project dari IAM & Admin > Settings.endpoint: Tetap disetel kechronicle.googleapis.com.
Pengekspor API penyerapan lama
Jika Anda menggunakan file autentikasi penyerapan dari Opsi 2, ganti blok
exportersdengan kode berikut. Tetapkancreds_file_pathke jalur ke file autentikasi penyerapan, dan jika instance Anda berada di luar AS, gantimalachiteingestion-pa.googleapis.comdengan endpoint regional Anda (misalnya,europe-malachiteingestion-pa.googleapis.com).exporters: chronicle/nginx: compression: gzip creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: NGINX raw_log_field: body
Simpan file konfigurasi
- Setelah mengedit, simpan file:
- Linux: Tekan
Ctrl+O, laluEnter, laluCtrl+X - Windows: Klik File > Save
- Linux: Tekan
Mulai ulang agen Bindplane untuk menerapkan perubahan
Untuk memulai ulang agen Bindplane di Linux, jalankan perintah berikut:
sudo systemctl restart observiq-otel-collectorPastikan layanan sedang berjalan:
sudo systemctl status observiq-otel-collectorPeriksa log untuk mengetahui error:
sudo journalctl -u observiq-otel-collector -f
Untuk memulai ulang agen Bindplane di Windows, pilih salah satu opsi berikut:
Command Prompt atau PowerShell sebagai administrator:
net stop observiq-otel-collector && net start observiq-otel-collectorKonsol layanan:
- Tekan
Win+R, ketikservices.msc, lalu tekan Enter. - Cari observIQ OpenTelemetry Collector.
- Klik kanan, lalu pilih Mulai ulang.
Pastikan layanan sedang berjalan:
sc query observiq-otel-collectorPeriksa log untuk mengetahui error:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- Tekan
Mengonfigurasi NGINX untuk meneruskan log ke Bindplane
Buka file konfigurasi NGINX (misalnya,
/etc/nginx/nginx.conf):sudo vi /etc/nginx/nginx.confEdit konfigurasi, ganti
<BINDPLANE_SERVER>dan<BINDPLANE_PORT>dengan nilai Anda:http { access_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_access; error_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_error; }Mulai ulang NGINX untuk menerapkan perubahan:
sudo systemctl reload nginx
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
_Internal_WorkspaceResourceId |
target.resource.product_object_id |
Dipetakan secara langsung |
Computer |
principal.asset.hostname |
Dipetakan secara langsung |
Facility |
additional.fields[fasilitas] |
Dipetakan secara langsung |
HostName |
principal.asset.hostname |
Dipetakan secara langsung jika src_ip tidak ada |
ProcessName |
principal.application |
Dipetakan secara langsung |
SeverityLevel |
security_result.severity |
Dipetakan ke INFORMASI jika nilainya adalah info |
SourceSystem |
principal.asset.platform |
Dipetakan ke LINUX jika nilainya cocok dengan Linux |
SyslogMessage |
Beberapa kolom | Diurai menggunakan grok untuk mengekstrak time, method, target_path, protocol, response_code, referral_url, user_agent, target_ip, target_host, dan cache |
TenantId |
additional.fields[TenantId] |
Dipetakan secara langsung |
acct |
principal.user.user_id |
Dipetakan langsung jika tidak kosong atau ? |
addr |
principal.asset.ip |
Dipetakan secara langsung |
audit_epoch |
metadata.event_timestamp |
Dikonversi menjadi stempel waktu menggunakan format UNIX. Nanodetik diekstrak dari pesan log asli. |
cache |
additional.fields[cache] |
Dipetakan secara langsung |
collection_time.nanos |
metadata.event_timestamp.nanos |
Digunakan untuk nanodetik stempel waktu peristiwa jika tersedia |
collection_time.seconds |
metadata.event_timestamp.seconds |
Digunakan untuk detik stempel waktu peristiwa jika tersedia |
data |
Beberapa kolom | Sumber data utama, yang diuraikan secara berbeda berdasarkan format log (Syslog, JSON, atau lainnya) |
exe |
target.process.command_line |
Dipetakan secara langsung setelah menghapus garis miring terbalik dan tanda petik |
hostname |
principal.asset.hostname ATAU principal.asset.ip |
Jika berupa alamat IP, dipetakan ke principal.asset.ip. Jika tidak, dipetakan ke principal.asset.hostname |
msg |
metadata.description |
Dipetakan langsung sebagai deskripsi |
node |
target.asset.hostname |
Dipetakan secara langsung |
pid |
target.process.pid |
Dipetakan secara langsung |
protocol |
network.application_protocol |
Dipetakan ke HTTP jika nilainya cocok dengan HTTP |
referral_url |
network.http.referral_url |
Dipetakan secara langsung jika tidak kosong atau - |
res |
security_result.action_details |
Dipetakan secara langsung |
response_code |
network.http.response_code |
Dipetakan dan dikonversi langsung ke bilangan bulat |
ses |
network.session_id |
Dipetakan secara langsung |
src_ip |
principal.asset.ip |
Dipetakan secara langsung |
target_host |
target.asset.hostname |
Dipetakan secara langsung |
target_ip |
target.asset.ip |
Dipetakan secara langsung, setelah mengonversi representasi string ke array JSON, lalu mengekstrak IP individual |
target_path |
target.url |
Dipetakan secara langsung |
time |
metadata.event_timestamp |
Diurai untuk mengekstrak stempel waktu menggunakan format dd/MMM/yyyy:HH:mm:ss Z |
user_agent |
network.http.user_agent |
Dipetakan langsung jika tidak kosong atau - |
metadata.event_type |
Awalnya ditetapkan ke GENERIC_EVENT, lalu berpotensi ditimpa berdasarkan kolom lain seperti terminal dan protocol. Nilai defaultnya adalah USER_UNCATEGORIZED jika pola grok utama tidak cocok. Tetapkan ke NETWORK_HTTP jika protocol adalah HTTP dan target_ip ada, dan STATUS_UPDATE jika protocol adalah HTTP, tetapi target_ip tidak ada |
|
metadata.log_type |
Tetapkan ke NGINX |
|
metadata.product_name |
Tetapkan ke NGINX |
|
metadata.vendor_name |
Tetapkan ke NGINX |
|
network.ip_protocol |
Disetel ke TCP jika terminal adalah sshd atau ssh, atau jika pola grok utama tidak cocok |
|
principal.asset_id |
Tetapkan ke GCP.GCE:0001 jika terminal adalah sshd atau ssh. Disetel ke GCP.GCE:0002 jika pola grok utama tidak cocok |
|
extensions.auth.type |
Disetel ke MACHINE jika terminal adalah sshd atau ssh |
|
log_hostname |
event.idm.read_only_udm.principal.asset.hostname |
Dipetakan dari log perubahan |
ip_part |
event.idm.read_only_udm.intermediary.ip |
Dipetakan dari log perubahan |
domain_part |
event.idm.read_only_udm.intermediary.administrative_domain |
Dipetakan dari log perubahan |
location_part |
event.idm.read_only_udm.intermediary.location.name |
Dipetakan dari log perubahan |
labels.compute_googleapis_com/resource_name |
event.idm.read_only_udm.target.hostname |
Dipetakan dari log perubahan |
resource.labels.instance_id |
event.idm.read_only_udm.target.resource.product_object_id |
Dipetakan dari log perubahan |
resource.labels.project_id |
event.idm.read_only_udm.target.resource_ancestors.name |
Dipetakan dari log perubahan |
resource.labels.zone |
event.idm.read_only_udm.target.resource.attribute.cloud.availability_zone |
Dipetakan dari log perubahan |
resource.type |
event.idm.read_only_udm.target.resource.resource_type |
Dipetakan dari log perubahan |
insertId |
event.idm.read_only_udm.metadata.product_log_id |
Dipetakan dari log perubahan |
jsonPayload.latency |
event.idm.read_only_udm.additional.fields |
Dipetakan dari log perubahan |
remoteIp |
event.idm.read_only_udm.target.ip |
Dipetakan dari log perubahan |
jsonPayload.requestMethod |
event.idm.read_only_udm.network.http.method |
Dipetakan dari log perubahan |
jsonPayload.requestSize |
event.idm.read_only_udm.network.sent_bytes |
Dipetakan dari log perubahan |
jsonPayload.requestUrl |
event.idm.read_only_udm.network.http.referral_url |
Dipetakan dari log perubahan |
jsonPayload.responseSize |
event.idm.read_only_udm.network.received_bytes |
Dipetakan dari log perubahan |
jsonPayload.serverIp |
event.idm.read_only_udm.target.ip |
Dipetakan dari log perubahan |
jsonPayload.status |
event.idm.read_only_udm.network.http.response_code |
Dipetakan dari log perubahan |
jsonPayload.userAgent |
event.idm.read_only_udm.network.http.user_agent |
Dipetakan dari log perubahan |
jsonPayload.userAgent |
event.idm.read_only_udm.network.http.parsed_user_agent |
Dipetakan dari log perubahan |
labels |
event.idm.read_only_udm.additional.fields |
Dipetakan dari log perubahan |
terminal |
event.idm.read_only_udm.additional.fields |
Dipetakan dari log perubahan |
logName |
event.idm.read_only_udm.additional.fields |
Dipetakan dari log perubahan |
resource.labels |
event.idm.read_only_udm.target.resource.attribute.labels |
Dipetakan dari log perubahan |
resource.type |
event.idm.read_only_udm.target.resource.attribute.labels |
Dipetakan dari log perubahan |
resource.name |
event.idm.read_only_udm.target.resource.name |
Dipetakan dari log perubahan |
timestamp |
event.idm.read_only_udm.metadata.event_timestamp |
Dipetakan dari log perubahan |
user_agent |
event.idm.read_only_udm.network.http.parsed_user_agent |
Dipetakan dari log perubahan |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.