Mengumpulkan log Sentry
Dokumen ini menjelaskan cara menyerap log Sentry ke Google Security Operations menggunakan Google Cloud Storage. Sentry menghasilkan data operasional dalam bentuk peristiwa, masalah, data pemantauan performa, dan informasi pelacakan error. Integrasi ini memungkinkan Anda mengirim log ini ke Google SecOps untuk analisis dan pemantauan, sehingga memberikan visibilitas ke error aplikasi, masalah performa, dan interaksi pengguna dalam aplikasi yang dipantau Sentry.
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Project GCP dengan Cloud Storage API yang diaktifkan
- Izin untuk membuat dan mengelola bucket GCS
- Izin untuk mengelola kebijakan IAM di bucket GCS
- Izin untuk membuat fungsi Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
- Akses istimewa ke tenant Sentry (Token Auth dengan cakupan API)
Mengumpulkan prasyarat Sentry (ID, kunci API, ID organisasi, token)
- Login ke Sentry.
- Temukan Slug organisasi Anda:
- Buka Settings > Organization > Settings > Organization ID (slug akan muncul di samping nama organisasi).
- Buat Token Auth:
- Buka Settings > Developer Settings > Personal Tokens.
- Klik Create New Token.
- Cakupan (minimum):
org:read,project:read,event:read. - Klik Create Token.
- Salin nilai token (ditampilkan sekali). Ini digunakan sebagai:
Authorization: Bearer <token>.
(Jika dihosting sendiri): Catat URL dasar Anda (misalnya,
https://<your-domain>); jika tidak, gunakanhttps://sentry.io.
Membuat 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 Memberi nama bucket Anda Masukkan nama yang unik secara global (misalnya, sentry-logs)Location type Pilih sesuai kebutuhan Anda (Region, Dual-region, Multi-region) Location Pilih lokasi (misalnya, us-central1)Storage class Standard (direkomendasikan untuk log yang sering diakses) Kontrol akses Seragam (direkomendasikan) Alat perlindungan Opsional: Mengaktifkan pembuatan versi objek atau kebijakan retensi Klik Create.
Membuat 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:
- Service account name: Masukkan
sentry-logs-collector-sa. - Service account description: Masukkan
Service account for Cloud Run function to collect Sentry logs.
- Service account name: 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 state file
- Cloud Run Invoker: Mengizinkan Pub/Sub memanggil fungsi
- Cloud Functions Invoker: Mengizinkan pemanggilan fungsi
Memberikan izin IAM di bucket GCS
Beri akun layanan izin tulis di bucket GCS:
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda.
- Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
sentry-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com). - Assign roles: Pilih Storage Object Admin.
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
- Klik Simpan.
Membuat topik Pub/Sub
Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan di-subscribe oleh fungsi Cloud Run.
- Di Konsol GCP, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
sentry-logs-trigger. - Biarkan setelan lainnya sesuai default.
- ID Topik: Masukkan
- Klik Create.
Membuat fungsi Cloud Run untuk mengumpulkan log
Fungsi Cloud Run dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil log dari Sentry API dan menulisnya ke GCS.
- Di Konsol GCP, buka Cloud Run.
- Klik Create service.
- Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Configure, berikan detail konfigurasi berikut:
Setelan Nilai Nama layanan sentry-logs-collectorRegion Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Trigger (optional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih topik (
sentry-logs-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 Keamanan:
- Service account: Pilih akun layanan (
sentry-logs-collector-sa).
- Service account: Pilih akun layanan (
Buka tab Penampung:
- Klik Variables & Secrets.
- Klik + Add variable untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh Deskripsi GCS_BUCKETsentry-logsNama bucket GCS tempat data akan disimpan. GCS_PREFIXsentry/events/Awalan GCS opsional (subfolder) untuk objek. STATE_KEYsentry/events/state.jsonKunci file status/checkpoint opsional. SENTRY_ORGyour-org-slugSlug organisasi Sentry. SENTRY_AUTH_TOKENsntrys_************************Token Autentikasi Sentry dengan org:read, project:read, event:read. SENTRY_API_BASEhttps://sentry.ioURL dasar Sentry API (dihosting sendiri: https://<your-domain>).MAX_PROJECTS100Jumlah maksimum project yang akan diproses. MAX_PAGES_PER_PROJECT5Halaman maksimum per project per eksekusi. Scroll ke bawah di tab Variables & Secrets ke Requests:
- Request timeout: Masukkan
600detik (10 menit).
- Request timeout: Masukkan
Buka tab Setelan di Penampung:
- Di bagian Resources:
- Memory: Pilih 512 MiB atau lebih tinggi.
- CPU: Pilih 1.
- Klik Done.
- Di bagian Resources:
Scroll ke Execution environment:
- Pilih Default (direkomendasikan).
Di bagian Revision scaling:
- Minimum number of instances: Masukkan
0. - Maximum number of instances: Masukkan
100(atau sesuaikan berdasarkan beban yang diharapkan).
- Minimum number of instances: Masukkan
Klik Create.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan otomatis terbuka.
Menambahkan kode fungsi
- Masukkan main di Function entry point
Di editor kode inline, buat dua file:
- File pertama: main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone import time # Initialize HTTP client http = urllib3.PoolManager() # Initialize Storage client storage_client = storage.Client() @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Sentry events and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ # Get environment variables bucket_name = os.environ.get('GCS_BUCKET') prefix = os.environ.get('GCS_PREFIX', 'sentry/events/') state_key = os.environ.get('STATE_KEY', 'sentry/events/state.json') org = os.environ.get('SENTRY_ORG', '').strip() token = os.environ.get('SENTRY_AUTH_TOKEN', '').strip() api_base = os.environ.get('SENTRY_API_BASE', 'https://sentry.io').rstrip('/') max_projects = int(os.environ.get('MAX_PROJECTS', '100')) max_pages_per_project = int(os.environ.get('MAX_PAGES_PER_PROJECT', '5')) if not all([bucket_name, org, token]): print('Error: Missing required environment variables') return try: # Get GCS bucket bucket = storage_client.bucket(bucket_name) # Load state state = load_state(bucket, state_key) state.setdefault('projects', {}) # Get list of projects projects = list_projects(api_base, org, token, max_projects) print(f'Found {len(projects)} projects') summary = [] # Process each project for slug in projects: start_prev = state['projects'].get(slug, {}).get('prev_cursor') res = fetch_project_events( api_base, org, token, slug, start_prev, max_pages_per_project, bucket, prefix ) if res.get('store_prev_cursor'): state['projects'][slug] = {'prev_cursor': res['store_prev_cursor']} summary.append(res) # Save state save_state(bucket, state_key, state) print(f'Successfully processed {len(projects)} projects') print(f'Summary: {json.dumps(summary)}') except Exception as e: print(f'Error processing logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) if state_data else {'projects': {}} except Exception as e: print(f'Warning: Could not load state: {str(e)}') return {'projects': {}} def save_state(bucket, key, state): """Save state to GCS.""" try: blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, separators=(',', ':')), content_type='application/json' ) except Exception as e: print(f'Warning: Could not save state: {str(e)}') def sentry_request(api_base, token, path, params=None): """Make request to Sentry API.""" url = f"{api_base}{path}" if params: url = f"{url}?{urllib3.request.urlencode(params)}" headers = { 'Authorization': f'Bearer {token}', 'Accept': 'application/json', 'User-Agent': 'chronicle-gcs-sentry-function/1.0' } response = http.request('GET', url, headers=headers, timeout=60.0) data = json.loads(response.data.decode('utf-8')) link = response.headers.get('Link') return data, link def parse_link_header(link_header): """Parse Link header to extract cursors.""" if not link_header: return None, False, None, False prev_cursor, next_cursor = None, None prev_more, next_more = False, False parts = [p.strip() for p in link_header.split(',')] for p in parts: if '<' not in p or '>' not in p: continue url = p.split('<', 1)[1].split('>', 1)[0] rel = 'previous' if 'rel="previous"' in p else ('next' if 'rel="next"' in p else None) has_more = 'results="true"' in p try: from urllib.parse import urlparse, parse_qs q = urlparse(url).query cur = parse_qs(q).get('cursor', [None])[0] except Exception: cur = None if rel == 'previous': prev_cursor, prev_more = cur, has_more elif rel == 'next': next_cursor, next_more = cur, has_more return prev_cursor, prev_more, next_cursor, next_more def write_page(bucket, prefix, project_slug, payload, page_idx): """Write page of events to GCS.""" ts = time.gmtime() key = f"{prefix.rstrip('/')}/{time.strftime('%Y/%m/%d', ts)}/sentry-{project_slug}-{page_idx:05d}.json" blob = bucket.blob(key) blob.upload_from_string( json.dumps(payload, separators=(',', ':')), content_type='application/json' ) return key def list_projects(api_base, org, token, max_projects): """List Sentry projects.""" projects, cursor = [], None while len(projects) < max_projects: params = {'cursor': cursor} if cursor else {} data, link = sentry_request(api_base, token, f'/api/0/organizations/{org}/projects/', params) for p in data: slug = p.get('slug') if slug: projects.append(slug) if len(projects) >= max_projects: break _, _, next_cursor, next_more = parse_link_header(link) cursor = next_cursor if next_more else None if not next_more: break return projects def fetch_project_events(api_base, org, token, project_slug, start_prev_cursor, max_pages, bucket, prefix): """Fetch events for a project.""" pages = 0 total = 0 latest_prev_cursor_to_store = None def fetch_one(cursor): nonlocal pages, total, latest_prev_cursor_to_store params = {'cursor': cursor} if cursor else {} data, link = sentry_request(api_base, token, f'/api/0/projects/{org}/{project_slug}/events/', params) write_page(bucket, prefix, project_slug, data, pages) total += len(data) if isinstance(data, list) else 0 prev_c, prev_more, next_c, next_more = parse_link_header(link) latest_prev_cursor_to_store = prev_c or latest_prev_cursor_to_store pages += 1 return prev_c, prev_more, next_c, next_more if start_prev_cursor: # Poll new pages toward "previous" until no more cur = start_prev_cursor while pages < max_pages: prev_c, prev_more, _, _ = fetch_one(cur) if not prev_more: break cur = prev_c else: # First run: start at newest, then backfill older pages prev_c, _, next_c, next_more = fetch_one(None) cur = next_c while next_more and pages < max_pages: _, _, next_c, next_more = fetch_one(cur) cur = next_c return { 'project': project_slug, 'pages': pages, 'written': total, 'store_prev_cursor': latest_prev_cursor_to_store } ``` * Second file: **requirements.txt:**functions-framework3.* google-cloud-storage2.* urllib3>=2.0.0 ```
Klik Deploy untuk menyimpan dan men-deploy fungsi.
Tunggu hingga deployment selesai (2-3 menit).
Buat tugas Cloud Scheduler
Cloud Scheduler memublikasikan pesan ke topik Pub/Sub secara berkala, sehingga memicu fungsi Cloud Run.
- Di Konsol GCP, buka Cloud Scheduler.
- Klik Create Job.
Berikan detail konfigurasi berikut:
Setelan Nilai Nama sentry-logs-collector-hourlyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 * * * *(setiap jam, tepat pada jamnya)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih topik ( sentry-logs-trigger)Isi 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 tugas penjadwal
- Di konsol Cloud Scheduler, temukan tugas Anda.
- Klik Force run untuk memicu secara manual.
- Tunggu beberapa detik dan buka Cloud Run > Services > sentry-logs-collector > Logs.
- Pastikan fungsi berhasil dieksekusi.
- Periksa bucket GCS untuk mengonfirmasi bahwa log telah ditulis.
Mengambil akun layanan Google SecOps
Google SecOps menggunakan akun layanan unik untuk membaca data dari bucket GCS Anda. Anda harus memberi akun layanan ini akses ke bucket Anda.
Mendapatkan email akun layanan
- Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
- Klik Tambahkan Feed Berita Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Sentry Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih Sentry sebagai Log type.
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.
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 nama bucket Anda.
- Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps.
- Assign roles: Pilih Storage Object Viewer.
Klik Simpan.
Mengonfigurasi feed di Google SecOps untuk menyerap log Sentry
- Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
- Klik Tambahkan Feed Berita Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Sentry Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih Sentry sebagai Log type.
- Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
Storage bucket URL: Masukkan URI bucket GCS dengan jalur awalan:
gs://sentry-logs/sentry/events/Ganti:
sentry-logs: Nama bucket GCS Anda.sentry/events/: Jalur awalan/folder opsional tempat log disimpan (biarkan kosong untuk root).
Contoh:
- Bucket root:
gs://company-logs/ - Dengan awalan:
gs://company-logs/sentry-logs/ - Dengan subfolder:
gs://company-logs/sentry/events/
- Bucket root:
Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
- Never: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
- Delete transferred files: Menghapus file setelah transfer berhasil.
Delete transferred files and empty directories: Menghapus file dan direktori kosong setelah transfer berhasil.
Usia File Maksimum: Sertakan file yang diubah dalam jumlah hari terakhir. Defaultnya adalah 180 hari.
Namespace aset: Namespace aset.
Label penyerapan: Label yang akan diterapkan ke peristiwa dari feed ini.
Klik Berikutnya.
Tinjau konfigurasi feed berita baru Anda di layar Finalize, lalu klik Submit.
Tabel pemetaan UDM
| Kolom log | Pemetaan UDM | Logika |
|---|---|---|
environment_label |
additional.fields |
Digabung |
exception_type_label |
additional.fields |
Digabung |
exception_value_label |
additional.fields |
Digabung |
type_label |
additional.fields |
Digabung |
msg |
metadata.description |
Dipetakan secara langsung |
timestamp |
metadata.event_timestamp |
Diurai sebagai ISO8601 |
has_principal |
metadata.event_type |
Dipetakan: true → NETWORK_CONNECTION, true → STATUS_UPDATE |
has_target_user |
metadata.event_type |
Dipetakan: true → USER_UNCATEGORIZED |
event_id |
metadata.product_log_id |
Dipetakan secara langsung |
application_protocol |
network.application_protocol |
Dipetakan secara langsung |
response_code |
network.http.response_code |
Dipetakan secara langsung |
host |
principal.asset.ip |
Digabung |
host |
principal.ip |
Digabung |
host_label |
principal.resource.attribute.labels |
Digabung |
release_label |
principal.resource.attribute.labels |
Digabung |
source_type_label |
principal.resource.attribute.labels |
Digabung |
splunk_index_label |
principal.resource.attribute.labels |
Digabung |
splunk_source_label |
principal.resource.attribute.labels |
Digabung |
issue_id |
principal.resource.product_object_id |
Dipetakan secara langsung |
tag_label |
security_result.detection_fields |
Digabung |
transaction_label |
security_result.detection_fields |
Digabung |
project_id |
target.asset.attribute.cloud.project.id |
Dipetakan secara langsung |
user_ip_trunc |
target.asset.ip |
Digabung |
user_ip_trunc |
target.ip |
Digabung |
user_id |
target.user.userid |
Dipetakan secara langsung |
| T/A | metadata.event_type |
Konstanta: NETWORK_CONNECTION |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.