Mengumpulkan log uberAgent

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap log uberAgent ke Google Security Operations menggunakan agen Bindplane.

uberAgent adalah platform analisis keamanan endpoint dan pemantauan pengalaman pengguna untuk Windows dan macOS. Alat ini mengumpulkan data telemetri termasuk peristiwa proses, peristiwa login, koneksi jaringan, dan penggunaan aplikasi di endpoint yang dipantau.

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 endpoint uberAgent
• Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
• Akses istimewa ke konsol pengelolaan uberAgent atau endpoint tempat uberAgent diinstal

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)

1. Login ke konsolGoogle Cloud dan pilih project Google Cloud yang ditautkan ke instance Google SecOps Anda.
2. Buka IAM & Admin > Service Accounts.
3. Klik Create service account.
4. Berikan detail konfigurasi berikut:
   • Service account name: Masukkan nama akun (misalnya, bindplane-ingest).
   • Service account description: Masukkan deskripsi (misalnya, Bindplane agent log ingestion).
5. Klik Create and continue.
6. Di bagian Grant this service account access to project, klik Select a role, lalu pilih Chronicle Editor.
7. Klik Continue lalu klik Done.
8. Klik akun layanan yang Anda buat, lalu buka tab Keys.
9. Klik Add key > Create new key.
10. Pilih JSON dan klik Create. File kunci akan didownload ke komputer Anda.
11. Simpan file kunci sebagai ingestion-auth.json di direktori kolektor Bindplane (/opt/observiq-otel-collector/ingestion-auth.json di Linux atau C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json di Windows), atau perbarui creds_file_path di config.yaml agar sesuai dengan jalur tempat Anda menyimpannya.
12. Buka IAM & Admin > Settings dan salin Project number. Anda akan memerlukannya untuk konfigurasi pengekspor.

Catatan: Kunci JSON adalah kredensial. Batasi akses ke file di host Bindplane dan rotasikan kunci sesuai dengan kebijakan organisasi Anda.

Opsi 2: Mendownload file autentikasi penyerapan (lama)

1. Login ke konsol Google SecOps.
2. Buka Settings > Data Management > Collection Agents. Jika Anda menggunakan platform khusus SIEM, buka Settings > Collection Agents.
3. Download file autentikasi penyerapan.
4. Simpan file dengan aman di sistem tempat agen Bindplane akan diinstal.

Catatan: File ini mengautentikasi agen ke Ingestion API lama (malachiteingestion-pa.googleapis.com), yang telah dijadwalkan Google untuk dihentikan pada 20 Juli 2027. Rencanakan untuk beralih ke Opsi 1 sebelum tanggal tersebut.

Mendapatkan ID pelanggan Google SecOps

1. Login ke konsol Google SecOps.
2. Buka Setelan > Administrasi > Profil. Jika Anda menggunakan platform khusus SIEM, buka Settings > Profile.

3. Salin dan simpan ID Pelanggan dari bagian Detail Organisasi.

   Catatan: ID pelanggan diperlukan untuk mengonfigurasi pengekspor agen Bindplane.

Menginstal agen Bindplane

Instal agen Bindplane di sistem operasi Windows atau Linux Anda sesuai dengan petunjuk berikut.

Penginstalan Windows

1. Buka Command Prompt atau PowerShell sebagai administrator.

2. Jalankan perintah berikut:

   msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
   

3. Tunggu hingga penginstalan selesai.

4. Verifikasi penginstalan dengan menjalankan:

   sc query observiq-otel-collector
   

   Layanan akan ditampilkan sebagai RUNNING.

Penginstalan Linux

1. Buka terminal dengan hak istimewa root atau sudo.

2. Jalankan perintah berikut:

   sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
   

3. Tunggu hingga penginstalan selesai.

4. Verifikasi penginstalan dengan menjalankan:

   sudo systemctl status observiq-otel-collector
   

   Layanan akan ditampilkan sebagai active (running).

Referensi penginstalan tambahan

Untuk opsi pemasangan dan pemecahan masalah tambahan, lihat Panduan pemasangan agen Bindplane.

Catatan: Konfigurasi pengekspor Chronicle API memerlukan kolektor Bindplane v1.106.0 atau yang lebih baru. Perintah sebelumnya akan menginstal rilis terbaru. Jika Anda mengupdate penginstalan yang ada, upgrade kolektor sebelum mengubah konfigurasi.

Mengonfigurasi agen Bindplane untuk menyerap log dan mengirimkannya ke Google SecOps

Menemukan file konfigurasi

• Linux:

  sudo nano /opt/observiq-otel-collector/config.yaml
  

• Windows:

  notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
  

Mengedit file konfigurasi

• Ganti seluruh konten config.yaml dengan konfigurasi berikut:

  receivers:
    filelog:
      include:
        - 'C:\uberAgent\logs\*.log'
        - 'C:\uberAgent\logs\*.csv'
      start_at: beginning
      poll_interval: 5s
  
  exporters:
    chronicle/uberagent:
      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: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: UBERAGENT
      raw_log_field: body
      ingestion_labels:
        env: production
  
  service:
    pipelines:
      logs/uberagent_to_chronicle:
        receivers:
          - filelog
        exporters:
          - chronicle/uberagent
  

Parameter konfigurasi

Ganti placeholder berikut:

• Konfigurasi penerima:

  • include: Jalur ke file log uberAgent:
    • Windows (lokal): C:\uberAgent\logs\*.log dan C:\uberAgent\logs\*.csv
    • Windows (berbagi file): \\SERVER\Share\uberagent-logs\*.log
    • Sesuaikan jalur berdasarkan konfigurasi output file uberAgent Anda
  • start_at: Tetapkan ke beginning untuk membaca log yang ada, atau end untuk hanya membaca entri baru
  • poll_interval: Seberapa sering memeriksa data log baru (default: 5s)

• Konfigurasi pengekspor:

  • uberagent: Nama deskriptif untuk 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
  • <customer_id>: ID Pelanggan dari langkah sebelumnya
  • location: Ganti <LOCATION> dengan region instance Google SecOps Anda (misalnya, us, europe, atau asia-southeast1). Pengekspor mengawali chronicle.googleapis.com dengan nilai ini. Lihat Endpoint Regional untuk mengetahui daftar lengkapnya.
  • project: Ganti <PROJECT_NUMBER> dengan nomor project dari IAM & Admin > Settings.
  • endpoint: Tetap tetapkan ke chronicle.googleapis.com.
  • UBERAGENT: Jenis log persis seperti yang muncul di Chronicle
  • ingestion_labels: Label opsional dalam format YAML (misalnya, env: production)

• Konfigurasi pipeline:

  • uberagent_to_chronicle: Nama deskriptif untuk pipeline

Pengekspor API penyerapan lama

• Jika Anda menggunakan file autentikasi penyerapan dari Opsi 2, ganti blok exporters dengan kode berikut. Tetapkan creds_file_path ke jalur ke file autentikasi penyerapan, dan jika instance Anda berada di luar AS, ganti malachiteingestion-pa.googleapis.com dengan endpoint regional Anda (misalnya, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/uberagent:
      compression: gzip
      creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: UBERAGENT
      raw_log_field: body
      ingestion_labels:
        env: production
  

Catatan: Pengekspor ini akan berhenti berfungsi saat Ingestion API dihentikan pada 20 Juli 2027.

Simpan file konfigurasi

• Setelah mengedit, simpan file:
  • Linux: Tekan Ctrl+O, lalu Enter, lalu Ctrl+X
  • Windows: Klik File > Save

Mulai ulang agen Bindplane untuk menerapkan perubahan

• Untuk memulai ulang agen Bindplane di Linux, jalankan perintah berikut:

  sudo systemctl restart observiq-otel-collector
  

  1. Pastikan layanan sedang berjalan:

     sudo systemctl status observiq-otel-collector
     

  2. Periksa 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-collector
    

  • Konsol Services:

    1. Tekan Win+R, ketik services.msc, lalu tekan Enter.
    2. Cari observIQ OpenTelemetry Collector.
    3. Klik kanan, lalu pilih Restart.

    4. Pastikan layanan sedang berjalan:

       sc query observiq-otel-collector
       

    5. Periksa log untuk mengetahui error:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
       

Mengonfigurasi output file uberAgent

uberAgent mendukung beberapa backend output. Untuk mengekspor data sebagai file untuk dikumpulkan oleh agen Bindplane:

1. Buka file konfigurasi uberAgent (uberAgent.conf) di endpoint atau melalui Group Policy.

2. Konfigurasikan penerima output berbasis file:

   [Receiver]
   Name = FileOutput
   Type = File
   Path = C:\uberAgent\logs\
   

   Catatan: Ganti C:\uberAgent\logs\` with the desired output path. For centralized collection, use a network file share path such as\SERVER\Share\uberagent-logs`. uberAgent menghasilkan data dalam format CSV secara default.

3. Konfigurasikan metrik dan jenis sumber yang akan diekspor:

   • Proses: Peristiwa mulai/berhenti proses, penggunaan resource.
   • Logon: Peristiwa login/logout pengguna.
   • Jaringan: Peristiwa koneksi jaringan.
   • Aplikasi: Penggunaan dan error aplikasi.

4. Simpan konfigurasi dan mulai ulang layanan uberAgent.

5. Pastikan file log dibuat di direktori output yang dikonfigurasi.

6. Pastikan agen Bindplane memiliki izin baca pada direktori dan file log.

   Catatan: Untuk mengetahui opsi konfigurasi mendetail, lihat dokumentasi uberAgent.

Tabel pemetaan UDM

Kolom Log	Pemetaan UDM	Logika
SessionRpLatencyMs2, SessionHRes, SessionVRes, SessionColorDepth, SessionClientPlatform, SessionClientVersion, SessionClientOsLanguage, SessionPublishedName, SessionPublishedAppsCtx, SessionAppStateCtx, SessionEncryptionCtx, SessionClientTypeCtx, SessionBrokerDnsVmw, SessionBrokerUrlVmw, SessionBrokerTunneledVmw, SessionBrokerTunnelUrlVmw, SessionBrokerRemoteIpVmw, SessionBrokerUserVmw, SessionBrokerDomainVmw, SessionClientTimezoneVmw, SessionClientIdVmw, SessionTypeVmw, SessionBrokerType, SessionFgAppId, SessionFgAppVersion, SessionFgProcessName, SessionFgProcessId, SessionFgBrowserType, SessionFgBrowserActiveTabHost, SessionFgWindowTitle, SessionClientHwIdCtx2, SessionRoundTripTimeMs, SessionFps, SessionTransportProtocols, SessionProcessCount, SessionIOMB, SessionCPUTimeMs, SessionConnectionState, SessionUser, SessionIOCount, SessionNetKBPS, SessionWorkingSetMB, SessionCPUUsagePercent, SessionIOPS, SessionClientName, SessionIOLatencyMs, PowerSupportsS3, IsBatteryPresent, PowerSupportsS1, PowerSupportsS2, PowerSupportsS5, CPUMaxMhz, BaseboardSerial, CtxMachineCatalogName, AdDomainDns, HwHypervisorVendor, OsBuild, HwBiosVersion, PowerSupportsS4, HwIsVirtualMachine, IsUpsPresent, PowerSupportsConnectedStandby, OsInstallDate, Sourcetype, uberagent_index_name, data_stream.namespace, data_stream.dataset, data_stream.type, data_stream.subset, CPUCoresLogical, AdOu, AdDomainNetBios, logstash_pipeline, AdSite, CtxFarmName, CPUSockets, OsSpName, OsName, OsType, OsUpdateBuildRevision, ComputerNameCanonical, ComputerNameDn, CtxDeliveryGroupName, tags, user_agent.original	additional.fields	Digabungkan sebagai key-value pair dari kolom yang tercantum
	metadata.event_type	Ditetapkan ke STATUS_UPDATE jika has_principal benar dan has_target salah, NETWORK_CONNECTION jika keduanya benar, GENERIC_EVENT jika tidak
SessionGUID	metadata.product_log_id	Nilai disalin langsung
user_agent.original	network.http.parsed_user_agent	Dikonversi menjadi agen pengguna yang diuraikan
user_agent.original	network.http.user_agent	Nilai disalin langsung
SessionTransportProtocols	network.ip_protocol	Tetapkan ke UDP jika cocok dengan (?i)udp, TCP jika (?i)tcp
SessionID	network.session_id	Nilai disalin langsung
SessionClientUserDomain	principal.administrative_domain	Nilai disalin langsung
CPUCoresPhysical, RAMSizeGB, CPUName, HwManufacturer, OsArchitecture, BIOSSerial, HwModel	principal.asset.hardware	Digabungkan ke objek hardware
SessionClientDomain, host	principal.asset.hostname	Nilai dari SessionClientDomain jika tidak kosong, jika tidak, host
prin_ip, SessionClientIp, system_ip	principal.asset.ip	Nilai dari prin_ip jika tidak kosong, jika tidak, SessionClientIp, jika tidak, system_ip
SessionClientDomain, host	principal.hostname	Nilai dari SessionClientDomain jika tidak kosong, jika tidak, host
prin_ip, SessionClientIp, system_ip	principal.ip	Nilai dari prin_ip jika tidak kosong, jika tidak, SessionClientIp, jika tidak, system_ip
SessionClientMac	principal.mac	Nilai dari SessionClientMac, dengan - diganti dengan :, dalam huruf kecil
SessionClientPlatform	principal.platform	Setel ke WINDOWS jika cocok dengan (?i)windows
SessionClientVersion	principal.platform_version	Setel ke nilai jika cocok dengan (?i)windows
SessionUser, SessionClientUser	principal.user.user_display_name	Nilai dari SessionUser jika tidak kosong, jika tidak, SessionClientUser
SessionBrokerRemoteIpVmw	target.ip	Nilai disalin langsung
SessionBrokerUserVmw	target.user.user_display_name	Nilai disalin langsung
SessionClientIdVmw	target.user.userid	Nilai disalin langsung
	metadata.product_name	Tetapkan ke "UBERAGENT"
	metadata.vendor_name	Tetapkan ke "UBERAGENT"

Log Perubahan

Melihat Log Perubahan untuk parser ini

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.