Mengumpulkan log UKG
Dokumen ini menjelaskan cara menyerap log UKG ke Google Security Operations menggunakan Google Cloud Storage V2.
UKG (Ultimate Kronos Group) adalah platform pengelolaan sumber daya manusia yang menghasilkan log pengelolaan tenaga kerja, autentikasi, dan jejak audit. UKG Pro menyediakan REST API untuk akses terprogram ke data audit.
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 layanan Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
- Akses istimewa ke UKG Pro dengan izin administrator dan akses API
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, ukg-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.
Mengumpulkan kredensial UKG Pro API
Mendapatkan kredensial API
- Login ke portal administrasi UKG Pro.
- Buka Menu > Administration > System Configuration > Web Services.
- Buat atau temukan kredensial API Anda:
- Kunci API (US-Customer-Api-Key): Kunci API pelanggan untuk autentikasi.
- Service Account Username: Nama pengguna akun layanan.
- Service Account Password: Sandi akun layanan.
Catat Service Host URL (misalnya,
https://SERVICE_HOST).
Memverifikasi izin
Untuk memverifikasi bahwa kredensial API memiliki akses yang diperlukan:
- Login ke portal administrasi UKG Pro.
- Buka Menu > Administration > System Configuration > Security > Audit Trail.
- Pastikan Anda dapat melihat data audit.
- Jika Anda tidak dapat mengakses data audit, hubungi administrator UKG Pro Anda untuk memberikan izin yang diperlukan.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual credentials ACCESS_TOKEN="your-access-token" API_KEY="your-api-key" SERVICE_HOST="your-service-host" # Test API access - fetch audit logs curl -v -H "Authorization: Bearer ${ACCESS_TOKEN}" \ -H "US-Customer-Api-Key: ${API_KEY}" \ "https://${SERVICE_HOST}/personnel/v1/audit-logs?startDate=2024-01-01&endDate=2024-01-02"
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
ukg-collector-sa. - Service account description: Masukkan
Service account for Cloud Run function to collect UKG 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 (misalnya,
ukg-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
ukg-collector-sa@your-project.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
ukg-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 log dari UKG Pro 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 ukg-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
ukg-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
ukg-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_BUCKETukg-logsNama bucket GCS GCS_PREFIXukgAwalan untuk file log STATE_KEYukg/state.jsonJalur file status SERVICE_HOSTyour-service-hostURL host layanan UKG Pro UKG_USERNAMEyour-service-usernameNama pengguna akun layanan UKG_PASSWORDyour-service-passwordSandi akun layanan UKG_API_KEYyour-api-keyKunci API pelanggan MAX_RECORDS10000Data maksimum per operasi PAGE_SIZE100Data per halaman LOOKBACK_HOURS24Periode lihat balik awal 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.
- Di bagian Resources:
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 terbuka secara otomatis.
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, timedelta import time import base64 # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'ukg') STATE_KEY = os.environ.get('STATE_KEY', 'ukg/state.json') SERVICE_HOST = os.environ.get('SERVICE_HOST', '').rstrip('/') UKG_USERNAME = os.environ.get('UKG_USERNAME', '') UKG_PASSWORD = os.environ.get('UKG_PASSWORD', '') UKG_API_KEY = os.environ.get('UKG_API_KEY', '') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) def get_token(): """Get OAuth 2.0 access token from UKG Pro.""" token_url = f"https://{SERVICE_HOST}/authentication/token" auth_string = f"{UKG_USERNAME}:{UKG_PASSWORD}" auth_bytes = auth_string.encode('utf-8') auth_b64 = base64.b64encode(auth_bytes).decode('utf-8') headers = { 'Authorization': f'Basic {auth_b64}', 'US-Customer-Api-Key': UKG_API_KEY, 'Content-Type': 'application/x-www-form-urlencoded', 'Accept': 'application/json' } body = 'grant_type=client_credentials' backoff = 1.0 max_retries = 3 for attempt in range(max_retries): response = http.request('POST', token_url, body=body.encode('utf-8'), headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429) on token request. Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue if response.status != 200: raise RuntimeError(f"Failed to get access token: {response.status} - {response.data.decode('utf-8')}") data = json.loads(response.data.decode('utf-8')) return data['access_token'] raise RuntimeError(f"Failed to get token after {max_retries} retries due to rate limiting") @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch UKG logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, SERVICE_HOST, UKG_USERNAME, UKG_PASSWORD, UKG_API_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Get access token token = get_token() # Fetch logs records, newest_event_time = fetch_logs( token=token, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new log records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}") if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") 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) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(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}") def fetch_logs(token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch audit logs from UKG Pro API with pagination and rate limiting. Args: token: OAuth 2.0 access token start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ endpoint = f"https://{SERVICE_HOST}/personnel/v1/audit-logs" headers = { 'Authorization': f'Bearer {token}', 'US-Customer-Api-Key': UKG_API_KEY, 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-UKGCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 page = 1 start_date = start_time.strftime('%Y-%m-%d') end_date = end_time.strftime('%Y-%m-%d') while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break url = f"{endpoint}?startDate={start_date}&endDate={end_date}&page={page}&per_page={page_size}" try: response = http.request('GET', url, headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429). Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue backoff = 1.0 if response.status != 200: print(f"HTTP Error: {response.status}") response_text = response.data.decode('utf-8') print(f"Response body: {response_text}") return [], None data = json.loads(response.data.decode('utf-8')) # UKG may return results in different formats if isinstance(data, list): page_results = data else: page_results = data.get('data', data.get('results', data.get('auditLogs', []))) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) # Track newest event time for event in page_results: try: event_time = event.get('auditDate') or event.get('dateTime') or event.get('timestamp') if event_time: if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") if len(page_results) < page_size: print(f"Reached last page (size={len(page_results)} < limit={page_size})") break page += 1 except Exception as e: print(f"Error fetching logs: {e}") return [], None print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_time- File kedua: 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
Cloud Scheduler akan 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 ukg-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 ukg-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 (
ukg-collector-hourly). - Klik Force run untuk memicu secara manual.
- Tunggu beberapa detik dan buka Cloud Run > Services > ukg-collector > Logs.
Pastikan fungsi berhasil dieksekusi. Cari:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X events Wrote X records to gs://ukg-logs/ukg/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsPeriksa bucket GCS (
ukg-logs) untuk mengonfirmasi bahwa log telah ditulis.
Jika Anda melihat error di log:
- HTTP 401: Periksa kredensial API di variabel lingkungan
- HTTP 403: Pastikan akun layanan memiliki izin yang diperlukan di UKG Pro
- HTTP 429: Pembatasan kapasitas - fungsi akan otomatis mencoba lagi dengan backoff
- Gagal mendapatkan token akses: Pastikan
SERVICE_HOST,UKG_USERNAME,UKG_PASSWORD, danUKG_API_KEYsudah benar
Mengonfigurasi feed di Google SecOps untuk menyerap log UKG
- 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,
UKG Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih UKG 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. Anda akan menggunakannya pada langkah berikutnya.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
Storage bucket URL: Masukkan URI bucket GCS dengan jalur awalan:
gs://ukg-logs/ukg/- Ganti:
ukg-logs: Nama bucket GCS Anda.ukg: Jalur awalan/folder opsional tempat log disimpan (biarkan kosong untuk root).
- Ganti:
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.
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 (
ukg-logs). - 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.
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
| integrationUserKey, userStatus | entity.user.attribute.labels | Digabungkan sebagai label nilai kunci dengan kunci yang ditetapkan ke nama kolom dan nilai dari kolom |
| userName | entity.user.email_addresses | Digabungkan ke dalam array jika cocok dengan ekspresi reguler email |
| employeeId | entity.user.employee_id | Nilai disalin langsung jika tidak kosong |
| userLastLogonDate | entity.user.last_login_time | Dikonversi ke stempel waktu menggunakan pencocokan tanggal dengan format yyyy-MM-ddTHH:mm:ss.SS atau ISO8601 |
| userLastPasswordChangeDate | entity.user.last_password_change_time | Dikonversi ke stempel waktu menggunakan pencocokan tanggal dengan format yyyy-MM-ddTHH:mm:ss.SSS atau ISO8601 |
| userId | entity.user.product_object_id | Dikonversi ke string |
| fullName | entity.user.user_display_name | Nilai disalin langsung |
| userId | entity.user.userid | Dikonversi ke string |
| has_user | metadata.entity_type | Tetapkan ke "USER" jika has_user == "true", jika tidak, tetapkan ke "UNKNOWN_ENTITYTYPE" |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.