Cache HTTP Varnish

Integrasi Varnish mengumpulkan metrik cache dan sesi. Memantau jumlah objek yang masuk dan keluar dari cache, serta jumlah sesi dan koneksi backend. Integrasi ini juga mengumpulkan log Varnish dan mengurainya menjadi payload JSON standar.

Untuk informasi selengkapnya tentang Varnish, lihat dokumentasi Cache HTTP Varnish.

Prasyarat

Untuk mengumpulkan telemetri Varnish, Anda harus menginstal Agen Operasional:

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

Integrasi ini mendukung Varnish versi 6.x dan 7.0.x.

Mengonfigurasi instance Varnish

Pemroses logging Varnish memproses log menggunakan varnishncsa. Varnish dapat mengaktifkan logging varnishncsa dengan mengikuti panduan ini, bergantung pada sistem operasi.

Secara default, log ditulis ke /var/log/varnish/varnishncsa.log. Jika memilih tujuan lain, Anda harus memperbarui konfigurasi penerima. Log diharapkan dalam format default, dan rotasi log harus disiapkan.

Mengonfigurasi Agen Operasional untuk Varnish

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

Contoh konfigurasi

Perintah berikut membuat konfigurasi untuk mengumpulkan dan menyerap telemetri untuk Varnish dan memulai ulang Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# 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:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish
logging:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish

EOF

sudo service google-cloud-ops-agent restart
sleep 30

Mengonfigurasi pengumpulan log

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

Untuk mengonfigurasi penerima log varnish, tentukan kolom berikut:

Kolom Default Deskripsi
exclude_paths Daftar pola jalur sistem file yang akan dikecualikan dari kumpulan yang dicocokkan oleh include_paths.
include_paths [/var/log/varnish/varnishncsa.log] Jalur log default varnishncsa yang akan dibaca dengan mengikuti setiap file.
record_log_file_path false Jika ditetapkan ke true, jalur ke file tertentu tempat data log diperoleh akan muncul di entri log output sebagai nilai label agent.googleapis.com/log_file_path. Saat menggunakan karakter pengganti, hanya jalur file tempat data diperoleh yang dicatat.
type Nilai ini harus varnish.
wildcard_refresh_interval 60s Interval saat jalur file karakter pengganti di include_paths diperbarui. Diberikan sebagai durasi waktu, misalnya 30s atau 2m. Properti ini mungkin berguna dalam throughput logging yang tinggi, dengan file log dirotasi 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 varnish berisi kolom berikut di LogEntry:

Kolom Jenis Deskripsi
httpRequest objek Lihat HttpRequest
jsonPayload.host string Konten header Host
jsonPayload.user string Nama pengguna terautentikasi untuk permintaan
severity string (LogSeverity) Level entri log (diterjemahkan).

Mengonfigurasi pengumpulan metrik

Untuk menyerap metrik dari Varnish, Anda harus membuat penerima untuk metrik yang dihasilkan Varnish, 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 varnish, tentukan kolom berikut:

Kolom Default Deskripsi
cache_dir Ini menentukan nama instance cache dir yang akan digunakan saat mengumpulkan metrik. Jika tidak ditentukan, setelan defaultnya adalah host.
collection_interval 60s Nilai durasi waktu, seperti 30s atau 5m.
exec_dir Direktori tempat file yang dapat dieksekusi varnishadm dan varnishstat berada. Jika tidak diberikan, bergantung pada file yang dapat dieksekusi yang ada di PATH pengguna.
type Nilai ini harus varnish.

Yang dipantau

Tabel berikut memberikan daftar metrik yang dikumpulkan Ops Agent dari instance Varnish.

Jenis metrik 
Jenis, Tipe
Resource yang dimonitor		 Label
workload.googleapis.com/varnish.backend.connection.count
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/varnish.backend.request.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.cache.operation.count
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/varnish.client.request.count
CUMULATIVE, INT64
gce_instance 		state
workload.googleapis.com/varnish.client.request.error.count
CUMULATIVE, INT64
gce_instance 		status_code
workload.googleapis.com/varnish.object.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.expired
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.moved
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.nuked
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.session.count
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/varnish.thread.operation.count
CUMULATIVE, INT64
gce_instance 		operation

Memverifikasi konfigurasi

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

Untuk memverifikasi bahwa log Varnish dikirim ke Cloud Logging, lakukan tindakan 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("varnish")

Untuk memverifikasi bahwa metrik Varnish dikirim ke Cloud Monitoring, lakukan tindakan 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 panel pembuat kueri, pilih tombol yang namanya adalah  MQL atau  PromQL.
  3. Pastikan MQL dipilih di tombol Language. Tombol bahasa berada di toolbar yang sama yang memungkinkan Anda memformat kueri.
  4. Masukkan kueri berikut di editor, lalu klik Run query: 
    fetch gce_instance
| metric 'workload.googleapis.com/varnish.backend.connection.count'
| every 1m

Lihat dasbor

Untuk melihat metrik Varnish, Anda harus mengonfigurasi diagram atau dasbor. Integrasi Varnish menyertakan satu atau beberapa dasbor untuk Anda. Dasbor apa pun akan otomatis diinstal setelah Anda mengonfigurasi integrasi dan Agen Operasional telah 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, pastikan Agen Operasional berjalan. Jika tidak ada data metrik untuk diagram di dasbor, penginstalan dasbor akan gagal. Setelah Ops Agent 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 Varnish dan 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 informasi selengkapnya tentang cara menggunakan halaman Integrasi, lihat Mengelola integrasi.

Menginstal kebijakan pemberitahuan

Kebijakan pemberitahuan menginstruksikan Cloud Monitoring untuk memberi tahu Anda saat kondisi yang ditentukan terjadi. Integrasi Varnish menyertakan satu atau beberapa kebijakan pemberitahuan untuk 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 hal 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 Varnish dan klik Lihat Detail.
  3. Pilih tab Notifikasi. Tab ini memberikan deskripsi tentang kebijakan pemberitahuan yang tersedia dan menyediakan antarmuka untuk menginstalnya.
  4. Instal kebijakan pemberitahuan. Kebijakan pemberitahuan perlu mengetahui tempat untuk mengirim 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 otomatis. Anda dapat memeriksa statusnya di Pemantauan, tetapi Anda tidak menerima notifikasi.

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

    3. Klik Create Policies.

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

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

Langkah selanjutnya

Untuk panduan tentang 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.