איסוף יומנים של Apache Tomcat
גרסת המנתח: 3.0
במאמר הזה מוסבר איך להטמיע יומני Apache Tomcat ב-Google Security Operations באמצעות סוכן Bindplane.
Apache Tomcat הוא שרת של אפליקציות אינטרנט שיוצר יומני גישה בפורמט JSON לבקשות HTTP, לאירועי אימות ולפעילות בשרת. המנתח מחלץ שדות מיומנים בפורמט JSON ובפורמט syslog וממפה אותם למודל הנתונים המאוחד (UDM).
לפני שמתחילים
חשוב לוודא שיש לכם את הדברים הבאים:
- מכונה של Google SecOps
- Windows Server 2016 ואילך, או מארח Linux עם
systemd - סוכן Bindplane שמותקן בשרת Tomcat (כדי לקרוא קובצי יומן מקומיים)
- אם אתם משתמשים בשרת proxy, ודאו שהיציאות של חומת האש פתוחות בהתאם לדרישות של סוכן Bindplane.
- הרשאת אדמין לשרת Tomcat
קבלת פרטי כניסה ל-Google SecOps בשביל סוכן Bindplane
כדי לאמת את סוכן Bindplane ב-Google SecOps, בוחרים באחת מהשיטות הבאות:
- פריסות חדשות: משתמשים ב-Chronicle API (אפשרות 1).
- פריסות קודמות: ממשיכים להשתמש בקובץ האימות להטמעת נתונים (אפשרות 2) עד שה-Ingestion API יופסק ב-20 ביולי 2027.
אפשרות 1: יצירת חשבון שירות ל-Chronicle API (מומלץ)
- נכנסים למסוףGoogle Cloud ובוחרים את הפרויקט ב- Google Cloud שמקושר למכונה של Google SecOps.
- נכנסים לדף IAM & Admin > Service Accounts.
- לוחצים על Create service account.
- מזינים את פרטי ההגדרה הבאים:
- Service account name: מזינים שם לחשבון (לדוגמה,
bindplane-ingest). - Service account description: מזינים תיאור (לדוגמה,
Bindplane agent log ingestion).
- Service account name: מזינים שם לחשבון (לדוגמה,
- לוחצים על Create and continue.
- בקטע Grant this service account access to project, לוחצים על Select a role ובוחרים באפשרות Chronicle Editor.
- לוחצים על המשך ואז על סיום.
- לוחצים על חשבון השירות שיצרתם ועוברים לכרטיסייה Keys.
- לוחצים על Add key > Create new key.
- בוחרים באפשרות JSON ולוחצים על Create. קובץ המפתח יורד למחשב.
- שומרים את קובץ המפתח בתור
ingestion-auth.jsonבספריית Bindplane collector (/opt/observiq-otel-collector/ingestion-auth.jsonב-Linux אוC:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.jsonב-Windows), או מעדכנים אתcreds_file_pathב-config.yamlכך שיתאים לנתיב שבו שמרתם אותו. - עוברים אל IAM & Admin > Settings ומעתיקים את הערך של Project number. תצטרכו אותו כדי להגדיר את הייצוא.
אפשרות 2: הורדה של קובץ האימות להטמעת נתונים (גרסה קודמת)
- נכנסים למסוף Google SecOps.
- עוברים אל הגדרות > ניהול נתונים > סוכני איסוף. אם אתם משתמשים בפלטפורמת SIEM בלבד, עוברים אל הגדרות > סוכני איסוף.
- מורידים את קובץ האימות להטמעת נתונים.
- שומרים את הקובץ בצורה מאובטחת במערכת שבה יותקן הסוכן של Bindplane.
איך מקבלים את מספר הלקוח ב-Google SecOps
- נכנסים למסוף Google SecOps.
- עוברים אל הגדרות > ניהול > פרופיל. אם אתם משתמשים בפלטפורמה של SIEM בלבד, עוברים אל הגדרות > פרופיל.
מעתיקים את מספר הלקוח מהקטע פרטי הארגון ושומרים אותו.
התקנת הסוכן של Bindplane בשרת Tomcat כדי לאסוף קובצי יומן
מתקינים את סוכן Bindplane בשרת Tomcat עצמו, כי הוא צריך לקרוא קובצי יומן מקומיים.
התקנת חלונות
- פותחים את שורת הפקודה או את PowerShell כאדמין.
מריצים את הפקודה הבאה:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietמחכים שההתקנה תסתיים.
כדי לוודא שההתקנה בוצעה, מריצים את הפקודה:
sc query observiq-otel-collectorהשירות אמור להופיע כ-RUNNING.
התקנה ב-Linux
- פותחים טרמינל עם הרשאות root או sudo.
מריצים את הפקודה הבאה:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shמחכים שההתקנה תסתיים.
כדי לוודא שההתקנה בוצעה, מריצים את הפקודה:
sudo systemctl status observiq-otel-collectorהשירות אמור להופיע כפעיל (פועל).
מקורות מידע נוספים בנושא התקנה
לאפשרויות התקנה נוספות ולפתרון בעיות, עיינו במדריך להתקנת סוכן Bindplane.
הגדרת סוכן Bindplane כדי להטמיע יומני Tomcat ולשלוח אותם ל-Google SecOps
מאתרים את קובץ התצורה
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
עריכת קובץ התצורה
מחליפים את כל התוכן של
config.yamlבהגדרות הבאות:receivers: filelog/tomcat: include: - /path/to/tomcat/logs/access-log.*.json start_at: beginning exporters: chronicle/tomcat: 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: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: chronicle.googleapis.com log_type: TOMCAT raw_log_field: body service: pipelines: logs/tomcat_to_chronicle: receivers: - filelog/tomcat exporters: - chronicle/tomcat
פרמטרים להגדרה
מחליפים את ה-placeholders הבאים:
הגדרת המקלט:
include: הנתיב לקובצי יומן הגישה של Tomcat JSON. משנים את הערכים בהתאם לספריית היומנים ולתבנית הקבצים של Tomcat.-
start_at: מגדירים את הערךbeginningכדי לקרוא יומנים קיימים, או את הערךendכדי לקרוא רק רשומות חדשות.
הגדרת הייצוא:
-
creds_file_path: הנתיב המלא לקובץ המפתח של חשבון השירות בפורמט JSON (אפשרות 1):- Linux:
/opt/observiq-otel-collector/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
-
customer_id: מספר הלקוח שהועתק ממסוף Google SecOps -
location: מחליפים את<LOCATION>באזור של המכונה של Google SecOps (לדוגמה,us,europeאוasia-southeast1). המייצא מוסיף את הערך הזה בתחילתchronicle.googleapis.com. לרשימה המלאה, ראו נקודות קצה אזוריות. -
project: מחליפים את<PROJECT_NUMBER>במספר הפרויקט שמופיע בקטע IAM & Admin > Settings. -
endpoint: משאירים את הערךchronicle.googleapis.com.
-
מייצא API להטמעה מדור קודם
אם אתם משתמשים בקובץ האימות להטמעת נתונים מאפשרות 2, החליפו את הבלוק
exportersבקוד הבא. מגדירים אתcreds_file_pathלנתיב של קובץ האימות להטמעת נתונים. אם המכונה נמצאת מחוץ לארה"ב, מחליפים אתmalachiteingestion-pa.googleapis.comבנקודת הקצה האזורית (לדוגמה,europe-malachiteingestion-pa.googleapis.com).exporters: chronicle/tomcat: compression: gzip creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: TOMCAT raw_log_field: body
שמירת קובץ התצורה
- אחרי שמסיימים לערוך, שומרים את הקובץ:
- Linux: לוחצים על
Ctrl+O, אחר כך עלEnterואז עלCtrl+X - Windows: לוחצים על קובץ > שמירה
- Linux: לוחצים על
מפעילים מחדש את הסוכן של Bindplane כדי להחיל את השינויים.
כדי להפעיל מחדש את הסוכן של Bindplane ב-Linux, מריצים את הפקודה הבאה:
sudo systemctl restart observiq-otel-collectorמוודאים שהשירות פועל:
sudo systemctl status observiq-otel-collectorבודקים אם יש שגיאות ביומנים:
sudo journalctl -u observiq-otel-collector -f
כדי להפעיל מחדש את הסוכן של Bindplane ב-Windows, בוחרים באחת מהאפשרויות הבאות:
שורת הפקודה או PowerShell כאדמין:
net stop observiq-otel-collector && net start observiq-otel-collectorמסוף השירותים:
- לוחצים על
Win+R, מקלידיםservices.mscולוחצים על Enter. - מאתרים את observIQ OpenTelemetry Collector.
- לוחצים לחיצה ימנית ובוחרים באפשרות הפעלה מחדש.
מוודאים שהשירות פועל:
sc query observiq-otel-collectorבודקים אם יש שגיאות ביומנים:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- לוחצים על
הגדרת יומני גישה בפורמט JSON ב-Tomcat
- פותחים את קובץ התצורה של Tomcat בנתיב
$CATALINA_BASE/conf/server.xml. מאתרים את התג
<Host>ומוסיפים בתוכו את הקוד הבא:<Valve className="org.apache.catalina.valves.JsonAccessLogValve" directory="logs" prefix="access-log" suffix=".json" rotatable="true" maxDays="7"/>מפעילים מחדש את Tomcat כדי להחיל את השינויים:
cd /path/to/tomcat bin/catalina.sh stop bin/catalina.sh startקובץ יומן חדש בפורמט JSON יופיע מדי יום (לדוגמה,
logs/access-log.2025-07-02.json).
טבלת מיפוי UDM
| שדה ביומן | מיפוי UDM | Logic (פונקציה לוגית) |
|---|---|---|
@timestamp |
metadata.event_timestamp |
הערך של @timestamp מהיומן הגולמי ממופה ישירות לשדה הזה ב-UDM. הוא מייצג את השעה שבה האירוע התרחש. |
agent.ephemeral_id |
additional.fields[ephemeral_id].value.string_value |
המזהה הזמני מהסוכן מתווסף כצמד מפתח/ערך בשדות additional. |
agent.hostname |
observer.hostname |
שם המארח של הסוכן משמש כשם המארח של הצופה. |
agent.id |
observer.asset_id |
מזהה הסוכן משולב עם סוג הסוכן כדי ליצור את מזהה הנכס של הצופה (למשל, filebeat: <agent_id>). |
agent.type |
observer.application |
סוג הנציג משמש כאפליקציית התצפיתן. |
agent.version |
observer.platform_version |
גרסת הסוכן משמשת כגרסת הפלטפורמה של הצופה. |
host.hostname |
principal.hostname |
שם המארח של המארח משמש כשם המארח הראשי. |
host.id |
principal.asset.asset_id |
מזהה המארח מתחיל ב-Host Id: כדי ליצור את מזהה הנכס הראשי. |
host.ip |
principal.ip, observer.ip |
כתובת ה-IP של המארח משמשת גם ככתובת ה-IP של המשתתף הראשי וגם ככתובת ה-IP של הצופה. אם יש כמה כתובות IP, הן ממוזגות למערך. |
host.mac |
principal.mac |
כתובת ה-MAC של המארח משמשת ככתובת ה-MAC הראשית. אם יש כמה כתובות MAC, הן ממוזגות למערך. |
host.os.family |
principal.platform |
אם משפחת מערכת ההפעלה של המארח היא rhel או redhat, הפלטפורמה הראשית מוגדרת כ-LINUX. |
host.os.kernel |
principal.platform_patch_level |
גרסת הליבה של מערכת ההפעלה המארחת משמשת כרמת התיקון העיקרית של הפלטפורמה. |
host.os.name |
additional.fields[os_name].value.string_value |
שם מערכת ההפעלה המארחת מתווסף כצמד מפתח/ערך בשדות additional. |
host.os.version |
principal.platform_version |
גרסת מערכת ההפעלה המארחת משמשת כגרסת הפלטפורמה הראשית. |
log.file.path |
principal.process.file.full_path |
הנתיב של היומן משמש כנתיב המלא של קובץ התהליך הראשי. |
log_level |
security_result.severity, security_result.severity_details, security_result.action |
רמת היומן משמשת לקביעת החומרה של תוצאת האבטחה, פרטי החומרה והפעולה. הערכים DEBUG, INFO ו-AUDIT ממופים לרמת החומרה INFORMATIONAL ולפעולה ALLOW. ERROR ממופה לחומרה ERROR ולפעולה BLOCK. WARNING ו-WARN ממופים לחומרה MEDIUM ולפעולה BLOCK. הערך הגולמי של log_level ממופה גם ל-severity_details. |
logstash.irm_environment |
additional.fields[irm_environment].value.string_value |
הסביבה של Iron Mountain מ-Logstash מתווספת כצמד מפתח/ערך בשדות של additional. |
logstash.irm_region |
additional.fields[irm_region].value.string_value |
האזור של Iron Mountain מ-Logstash נוסף כצמד מפתח/ערך בשדות additional. |
logstash.irm_site |
additional.fields[irm_site].value.string_value |
האתר של Iron Mountain מ-Logstash נוסף כצמד מפתח/ערך בשדות של additional. |
logstash.process.host |
intermediary.hostname |
המארח לעיבוד של Logstash משמש כשם המארח המתווך. |
logstash.process.timestamp |
metadata.collected_timestamp |
חותמת הזמן של העיבוד ב-Logstash משמשת כחותמת הזמן של האיסוף. |
logstash.xyz_environment |
additional.fields[xyz_environment].value.string_value |
הסביבה xyz מ-Logstash מתווספת כצמד מפתח/ערך בשדות additional. |
logstash.xyz_region |
additional.fields[xyz_region].value.string_value |
האזור xyz מ-Logstash נוסף כצמד מפתח/ערך בשדות additional. |
logstash.xyz_site |
additional.fields[xyz_site].value.string_value |
האתר xyz מ-Logstash נוסף כצמד מפתח/ערך בשדות של additional. |
message |
metadata.description |
שדה ההודעה מנותח כ-JSON והשדה event_message שלו משמש כתיאור המטא-נתונים. האפליקציה המתווכת מקודדת באופן קשיח ל-logstash. סוג האירוע של המטא-נתונים מקודד באופן קשיח ל-USER_UNCATEGORIZED. סוג היומן של המטא-נתונים מוגדר כ-TOMCAT לפי batch.type או batch.log_type של היומן הגולמי. שם המוצר במטא-נתונים מקודד באופן קשיח ל-Tomcat. שם הספק של המטא-נתונים מקודד באופן קשיח ל-Tomcat. |
user |
principal.user.userid |
השדה "משתמש" מהיומן הגולמי משמש כמזהה המשתמש הראשי. |
product_event |
metadata.product_event_type |
מופה מיומן השינויים |
summary |
security_result.summary |
מופה מיומן השינויים |
query |
additional.fields |
מופה מיומן השינויים |
יומן שינויים
הצגת יומן השינויים של המנתח הזה
הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.