Mengumpulkan log Metabase
Dokumen ini menjelaskan cara menyerap log Metabase ke Google Security Operations menggunakan Google Cloud Storage V2.
Metabase adalah platform business intelligence dan analisis open source yang memungkinkan organisasi membuat kueri database, membuat visualisasi, dan membangun dasbor. Pada paket Pro dan Enterprise, Metabase menyimpan data audit dan analisis penggunaan di database aplikasinya, termasuk log aktivitas, log tampilan, dan catatan eksekusi kueri. Fungsi Cloud Run mengkueri Metabase API untuk mengambil data ini dan menuliskannya ke bucket GCS untuk penyerapan oleh Google SecOps.
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Project GCP dengan Cloud Storage, Cloud Run, Pub/Sub, dan Cloud Scheduler API yang diaktifkan
- Izin untuk membuat dan mengelola bucket GCS
- Izin untuk mengelola kebijakan IAM di bucket GCS
- Izin untuk membuat layanan Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
- Paket Metabase Pro atau Enterprise (analisis penggunaan tidak tersedia di edisi Open Source atau Cloud Starter)
- Akses administrator Metabase untuk membuat kunci API
- Database aplikasi Metabase ditambahkan sebagai sumber data dalam Metabase (diperlukan untuk membuat kueri tabel audit melalui API)
Mengonfigurasi akses Metabase API
Agar Google SecOps dapat mengambil data analisis penggunaan, Anda harus membuat kunci API di Metabase dan menambahkan database aplikasi sebagai sumber data yang dapat dikueri.
Membuat kunci API
- Login ke instance Metabase Anda sebagai administrator.
- Klik ikon roda gigi di sudut kanan atas.
- Pilih Setelan admin.
- Buka tab Setelan.
- Klik tab Autentikasi di menu kiri.
- Scroll ke API Keys, lalu klik Manage.
- Klik tombol Buat Kunci API.
- Berikan detail konfigurasi berikut:
- Nama kunci: Masukkan nama deskriptif (misalnya,
Google SecOps Integration) - Grup: Pilih grup dengan akses ke pengumpulan Analytics Penggunaan dan izin kueri untuk database aplikasi
- Nama kunci: Masukkan nama deskriptif (misalnya,
- Klik Create.
Salin dan simpan kunci API dengan aman.
Menambahkan database aplikasi sebagai sumber data
Untuk membuat kueri tabel audit melalui API, Anda harus menambahkan database aplikasi Metabase sebagai sumber data dalam Metabase.
- Di Metabase, klik ikon roda gigi di sudut kanan atas.
- Pilih Setelan admin.
- Buka tab Databases.
- Klik Tambahkan database.
- Konfigurasi koneksi database:
- Jenis database: Pilih PostgreSQL atau MySQL (bergantung pada database aplikasi Anda)
- Nama: Masukkan
Metabase Application Database - Host: Masukkan nama host database aplikasi Anda
- Port: Masukkan port database (default:
5432untuk PostgreSQL,3306untuk MySQL) - Nama database: Masukkan nama database aplikasi (misalnya,
metabase) - Nama pengguna: Masukkan pengguna database dengan izin SELECT pada tabel
audit_log,view_log, danquery_execution - Sandi: Masukkan sandi database
- Klik Simpan.
- Setelah menyimpan, catat ID Database dari URL (misalnya,
https://metabase.example.com/admin/databases/5berarti ID database adalah5).
Memverifikasi izin
Untuk memverifikasi bahwa kunci API memiliki izin yang diperlukan:
- Login ke Metabase sebagai administrator.
- Klik ikon roda gigi > Setelan admin > Orang.
- Temukan grup yang ditetapkan ke kunci API.
- Pastikan grup memiliki akses ke kumpulan Analytics Penggunaan.
- Buka Setelan admin > Izin > Data.
- Pastikan grup memiliki akses Tidak dibatasi atau Kueri ke database aplikasi.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual values METABASE_URL="https://your-metabase-instance.com" API_KEY="mb_your_api_key_here" DATABASE_ID="5" # Test API key authentication curl -s -H "x-api-key: ${API_KEY}" \ "${METABASE_URL}/api/database" \ | python3 -m json.tool # Test querying the application database for audit_log records curl -s -X POST "${METABASE_URL}/api/dataset/json" \ -H "x-api-key: ${API_KEY}" \ -H "Content-Type: application/json" \ -d "{\"database\": ${DATABASE_ID}, \"type\": \"native\", \"native\": {\"query\": \"SELECT * FROM audit_log ORDER BY id DESC LIMIT 5\", \"template-tags\": {}}, \"parameters\": []}" \ | python3 -m json.tool
Respons yang berhasil akan menampilkan array JSON dari catatan log audit terbaru.
Buat bucket Google Cloud Storage
- Buka Konsol Google Cloud.
- Pilih project Anda atau buat project baru.
- Di menu navigasi, buka Cloud Storage > Buckets.
- Klik Create bucket.
Berikan detail konfigurasi berikut:
Setelan Nilai Beri nama bucket Anda Masukkan nama yang unik secara global (misalnya, metabase-audit-logs)Location type Pilih berdasarkan kebutuhan Anda (Region, Dual-region, Multi-region) Location Pilih lokasi (misalnya, us-central1)Kelas penyimpanan Standar (direkomendasikan untuk log yang sering diakses) Kontrol akses Seragam (direkomendasikan) Alat perlindungan Opsional: Aktifkan pembuatan versi objek atau kebijakan retensi Klik Create.
Buat akun layanan untuk fungsi Cloud Run
Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket GCS dan dipanggil oleh Pub/Sub.
Membuat akun layanan
- Di Konsol GCP, buka IAM & Admin > Service Accounts.
- Klik Create Service Account.
- Berikan detail konfigurasi berikut:
- Nama akun layanan: Masukkan
metabase-audit-collector-sa - Deskripsi akun layanan: Masukkan
Service account for Cloud Run function to collect Metabase audit logs
- Nama akun layanan: Masukkan
- Klik Create and Continue.
- Di bagian Grant this service account access to project, tambahkan peran berikut:
- Klik Pilih peran.
- Telusuri dan pilih Storage Object Admin.
- Klik + Add another role.
- Telusuri dan pilih Cloud Run Invoker.
- Klik + Add another role.
- Telusuri dan pilih Cloud Functions Invoker.
- Klik Lanjutkan.
- Klik Done.
Peran ini diperlukan untuk:
- Storage Object Admin: Menulis log ke bucket GCS dan mengelola file status
- Cloud Run Invoker: Izinkan Pub/Sub memanggil fungsi
- Cloud Functions Invoker: Mengizinkan pemanggilan fungsi
Memberikan izin IAM pada bucket GCS
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (
metabase-audit-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan prinsipal: Masukkan email akun layanan (
metabase-audit-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - Menetapkan peran: Pilih Storage Object Admin
- Tambahkan prinsipal: Masukkan email akun layanan (
- Klik Simpan.
Membuat topik Pub/Sub
- Di Konsol GCP, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
metabase-audit-trigger - Biarkan setelan lainnya sesuai default
- ID Topik: Masukkan
- Klik Create.
Membuat fungsi Cloud Run untuk mengumpulkan log
Fungsi Cloud Run akan dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil data audit dari Metabase API dan menuliskannya ke GCS.
- Di Konsol GCP, buka Cloud Run.
- Klik Create service.
- Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Konfigurasi, berikan detail konfigurasi berikut:
Setelan Nilai Nama layanan metabase-audit-collectorRegion Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Pemicu (opsional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih
metabase-audit-trigger. - Klik Simpan.
Di bagian Authentication:
- Pilih Wajibkan autentikasi.
- Periksa Identity and Access Management (IAM).
Scroll ke bawah dan luaskan Containers, Networking, Security.
Buka tab Security:
- Akun layanan: Pilih
metabase-audit-collector-sa
- Akun layanan: Pilih
Buka tab Containers:
- Klik Variables & Secrets.
- Klik + Tambahkan variabel untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh Deskripsi GCS_BUCKETmetabase-audit-logsNama bucket GCS GCS_PREFIXmetabase-auditAwalan untuk file log STATE_KEYmetabase-audit/state.jsonJalur file status METABASE_URLhttps://metabase.yourcompany.comURL dasar instance Metabase METABASE_API_KEYmb_your_api_key_hereKunci API Metabase DATABASE_ID5ID database aplikasi LOOKBACK_HOURS24Periode lihat balik awal PAGE_SIZE2000Rekaman per kueri API Di bagian Variables & Secrets, scroll ke bawah ke Requests:
- Waktu tunggu permintaan: Masukkan
600detik (10 menit)
- Waktu tunggu permintaan: Masukkan
Buka tab Setelan:
- Di bagian Referensi:
- Memori: Pilih 512 MiB atau lebih tinggi
- CPU: Pilih 1
- Di bagian Referensi:
Di bagian Penskalaan revisi:
- Minimum number of instances: Masukkan
0 - Maximum number of instances: Masukkan
100
- Minimum number of instances: Masukkan
Klik Create.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan terbuka secara otomatis.
Menambahkan kode fungsi
- Masukkan main di kolom Entry point.
Di editor kode inline, buat dua file:
main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone, timedelta http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=10.0, read=60.0), retries=False, ) storage_client = storage.Client() GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'metabase-audit') STATE_KEY = os.environ.get('STATE_KEY', 'metabase-audit/state.json') METABASE_URL = os.environ.get('METABASE_URL', '').rstrip('/') API_KEY = os.environ.get('METABASE_API_KEY') DATABASE_ID = int(os.environ.get('DATABASE_ID', '1')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '2000')) TABLES = ['audit_log', 'view_log', 'query_execution'] TABLE_TIME_COLUMNS = { 'audit_log': 'timestamp', 'view_log': 'timestamp', 'query_execution': 'started_at', } @functions_framework.cloud_event def main(cloud_event): if not all([GCS_BUCKET, METABASE_URL, API_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) state = load_state(bucket) now = datetime.now(timezone.utc) if isinstance(state, dict) and state.get('last_event_time'): try: last_val = state['last_event_time'] if last_val.endswith('Z'): last_val = last_val[:-1] + '+00:00' last_time = datetime.fromisoformat(last_val) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") last_time = now - timedelta(hours=LOOKBACK_HOURS) else: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") all_records = [] newest_time = None for table in TABLES: time_col = TABLE_TIME_COLUMNS[table] records = fetch_table(table, time_col, last_time, now) for r in records: r['_metabase_table'] = table t = r.get(time_col) if t and (newest_time is None or str(t) > str(newest_time)): newest_time = t all_records.extend(records) print(f"Table {table}: fetched {len(records)} records") if not all_records: print("No new records found.") save_state(bucket, now.isoformat()) return timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/metabase_audit_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join( [json.dumps(r, ensure_ascii=False, default=str) for r in all_records] ) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(all_records)} records to gs://{GCS_BUCKET}/{object_key}") save_state(bucket, str(newest_time) if newest_time else now.isoformat()) print(f"Successfully processed {len(all_records)} records") except Exception as e: print(f'Error processing logs: {str(e)}') raise def fetch_table(table, time_col, start_time, end_time): start_str = start_time.strftime('%Y-%m-%d %H:%M:%S') end_str = end_time.strftime('%Y-%m-%d %H:%M:%S') all_records = [] offset = 0 max_pages = 50 for page in range(max_pages): sql = ( f"SELECT * FROM {table} " f"WHERE {time_col} >= '{start_str}' " f"AND {time_col} < '{end_str}' " f"ORDER BY {time_col} ASC " f"LIMIT {PAGE_SIZE} OFFSET {offset}" ) query_body = { "database": DATABASE_ID, "type": "native", "native": { "query": sql, "template-tags": {} }, "parameters": [] } url = f"{METABASE_URL}/api/dataset/json" response = http.request( 'POST', url, body=json.dumps(query_body).encode('utf-8'), headers={ 'x-api-key': API_KEY, 'Content-Type': 'application/json' } ) if response.status == 429: print(f"Rate limited on {table} query. Stopping pagination.") break if response.status != 200: print(f"{table} query failed: {response.status} - " f"{response.data.decode('utf-8')}") break page_results = json.loads(response.data.decode('utf-8')) if not page_results: break all_records.extend(page_results) print(f"{table} page {page + 1}: {len(page_results)} records " f"(total: {len(all_records)})") if len(page_results) < PAGE_SIZE: break offset += PAGE_SIZE return all_records def load_state(bucket): try: blob = bucket.blob(STATE_KEY) if blob.exists(): return json.loads(blob.download_as_text()) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, last_event_time_iso): try: state = { 'last_event_time': last_event_time_iso, 'last_run': datetime.now(timezone.utc).isoformat() } blob = bucket.blob(STATE_KEY) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}")requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0Klik Deploy untuk menyimpan dan men-deploy fungsi.
Tunggu hingga deployment selesai (2-3 menit).
Buat tugas Cloud Scheduler
- Di Konsol GCP, buka Cloud Scheduler.
- Klik Create Job.
Berikan detail konfigurasi berikut:
Setelan Nilai Nama metabase-audit-collector-hourlyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 * * * *(setiap jam, tepat pada waktunya)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih metabase-audit-triggerIsi pesan {}(objek JSON kosong)Klik Create.
Opsi frekuensi jadwal
Pilih frekuensi berdasarkan volume log dan persyaratan latensi:
| Frekuensi | Ekspresi Cron | Kasus Penggunaan |
|---|---|---|
| Setiap 5 menit | */5 * * * * |
Volume tinggi, latensi rendah |
| Setiap 15 menit | */15 * * * * |
Volume sedang |
| Setiap jam | 0 * * * * |
Standar (direkomendasikan) |
| Setiap 6 jam | 0 */6 * * * |
Volume rendah, pemrosesan batch |
| Harian | 0 0 * * * |
Pengumpulan data historis |
Menguji integrasi
- Di konsol Cloud Scheduler, temukan tugas Anda (
metabase-audit-collector-hourly). - Klik Force run untuk memicu tugas secara manual.
- Tunggu beberapa detik.
- Buka Cloud Run > Services.
- Klik
metabase-audit-collector. - Klik tab Logs.
Pastikan fungsi berhasil dieksekusi. Cari:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Table audit_log: fetched X records Table view_log: fetched X records Table query_execution: fetched X records Wrote X records to gs://metabase-audit-logs/metabase-audit/metabase_audit_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsBuka Cloud Storage > Buckets.
Klik
metabase-audit-logs.Buka folder
metabase-audit/.Pastikan file
.ndjsonbaru dibuat dengan stempel waktu saat ini.
Jika Anda melihat error dalam log:
- HTTP 401: Pastikan variabel lingkungan
METABASE_API_KEYsudah benar dan kunci belum dihapus atau dibuat ulang - HTTP 403: Pastikan grup kunci API memiliki izin kueri untuk database aplikasi
- HTTP 429: Pembatasan kecepatan -- fungsi akan menghentikan penomoran halaman dan dilanjutkan pada eksekusi terjadwal berikutnya
- Variabel lingkungan tidak ada: Pastikan semua variabel yang diperlukan ditetapkan dalam konfigurasi fungsi Cloud Run
- Hasil kosong: Verifikasi bahwa
DATABASE_IDsudah benar, database aplikasi ditambahkan sebagai sumber data, dan Anda menggunakan Metabase Pro atau Enterprise
Mengambil akun layanan Google SecOps
- Buka Setelan SIEM > Feed.
- Klik Tambahkan Feed Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Metabase Audit Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih METABASE sebagai Jenis log.
Klik Get Service Account. Email akun layanan yang unik akan ditampilkan, misalnya:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comSalin alamat email ini untuk digunakan di langkah berikutnya.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
gs://metabase-audit-logs/metabase-audit/Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
- Jangan pernah: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
- Hapus file yang ditransfer: Menghapus file setelah transfer berhasil.
Hapus file yang ditransfer dan direktori kosong: Menghapus file dan direktori kosong setelah transfer berhasil.
Usia File Maksimum: Menyertakan file yang diubah dalam beberapa hari terakhir (default adalah 180 hari)
Namespace aset: Namespace aset
Label penyerapan: Label yang akan diterapkan ke peristiwa dari feed ini
Klik Berikutnya.
Tinjau konfigurasi feed baru Anda di layar Selesaikan, lalu klik Kirim.
Memberikan izin IAM ke akun layanan Google SecOps
Akun layanan Google SecOps memerlukan peran Storage Object Viewer di bucket GCS Anda.
- Buka Cloud Storage > Buckets.
- Klik
metabase-audit-logs. - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps
- Tetapkan peran: Pilih Storage Object Viewer
Klik Simpan.
Tabel analisis penggunaan
Fungsi Cloud Run membuat kueri tabel berikut dari database aplikasi Metabase:
| Nama Tabel | Deskripsi |
|---|---|
| audit_log | Catatan perubahan konfigurasi, tindakan pengguna, dan peristiwa sistem |
| view_log | Melacak tampilan kartu (pertanyaan/model), dasbor, dan tabel |
| query_execution | Informasi tentang semua kueri yang dijalankan di semua dasbor |
Retensi data
Secara default, Metabase menyimpan data analisis penggunaan selama 720 hari (sekitar 2 tahun). Dua kali sehari, Metabase akan otomatis menghapus baris yang lebih lama dari batas ini. Untuk mengubah periode retensi, tetapkan variabel lingkungan MB_AUDIT_MAX_RETENTION_DAYS saat menjalankan Metabase.
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
| tambahan | tambahan | Diganti namanya dari tambahan |
| locale | additional.fields | Digabungkan dengan label masing-masing (misalnya, locale_label untuk locale, is_active_label untuk is_active, dll.) |
| is_active | additional.fields | |
| is_qbnewb | additional.fields | |
| group_ids | additional.fields | |
| is_superuser | additional.fields | |
| login_attributes | additional.fields | |
| id | additional.fields | |
| sso_source | additional.fields | |
| personal_collection_id | additional.fields | |
| metadata | metadata | Diganti namanya dari metadata |
| updated_at | metadata.event_timestamp | Tanggal yang diuraikan dari updated_at menggunakan ISO8601, RFC 3339, atau yyyy-MM-ddTHH:mm:ss.SSSSSSZ |
| has_userid | metadata.event_type | Ditetapkan ke "USER_UNCATEGORIZED" jika has_userid == "true", atau "GENERIC_EVENT" |
| utama | utama | Diganti namanya dari principal |
| metabase_host | principal.url | Nilai disalin secara langsung |
| date_joined | principal.user.attribute.creation_time | Tanggal yang diuraikan dari date_joined menggunakan ISO8601, RFC 3339, atau yyyy-MM-ddTHH:mm:ss.SSSSSSZ |
| principal.user.email_addresses | Digabungkan dari email | |
| first_name | principal.user.first_name | Nilai disalin secara langsung |
| last_login | principal.user.last_login_time | Tanggal yang diuraikan dari last_login menggunakan ISO8601, RFC 3339, atau yyyy-MM-ddTHH:mm:ss.SSSSSSZ |
| last_name | principal.user.last_name | Nilai disalin secara langsung |
| common_name | principal.user.user_display_name | Nilai disalin secara langsung |
| principal.user.userid | Nilai disalin langsung dari email | |
| security_result | security_result | Digabungkan dari security_result |
| target | target | Diganti namanya dari target |
| metadata.product_name | metadata.product_name | Tetapkan ke "METABASE" |
| metadata.vendor_name | metadata.vendor_name | Tetapkan ke "METABASE" |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.