יצירת קובצי dump של אבחון ב-AlloyDB Omni

בוחרים גרסת תיעוד:

יצירת קובץ dump לניפוי באגים ב-AlloyDB Omni עם מצב המערכת ויומני ניתוח הביצועים, כדי לפתור בעיות לא צפויות בפריסות. יומני ניפוי הבאגים מספקים מידע קריטי לאבחון המצב של AlloyDB Omni, שעוזר לכם או לצוות Cloud Customer Care לנתח בעיות שקשורות לכשלים או לבעיות בהפעלת שירותים שונים של AlloyDB Omni stack. אוספים את הקבצים האלה באמצעות תפקיד Ansible או כלי נפרד.

לשלוט ביומני האבחון ברמת התזמור של alloydbctl ו-Ansible כדי להתאים את דרגת המלל לפתרון בעיות או להשתיק את הפלט של סקריפטים אוטומטיים. היומנים האלה חיוניים לאבחון בעיות במהלך האתחול, הניהול או התפעול הכללי של האשכול.

איסוף מידע על תוצאות ניפוי הבאגים והעברה שלו לקובץ dump

אתם יכולים לאסוף ולשמור מידע על תוצאות ניפוי הבאגים באמצעות תפקיד Ansible או כלי לשמירת מידע על תוצאות ניפוי הבאגים.

איסוף מידע על תוצאות ניפוי הבאגים באמצעות Ansible

התפקיד google.alloydbomni_orchestrator.dump_debug ב-Ansible הופך את תהליך האיסוף לאוטומטי בכל הצמתים של AlloyDB Omni שמוגדרים במפרט הפריסה. הוא אוסף ומאחד את המידע הבא:

  • סטטוס Systemd: המצב הנוכחי של כל שירותי AlloyDB Omni.
  • יומני Journal: יומני מערכת שמאפשרים סינון לפי זמן.

יצירת קובץ dump של מידע על תוצאות ניפוי הבאגים

  1. יוצרים פלייבוק של Ansible (לדוגמה, dump_debug.yml) בצומת הבקרה. מוסיפים לפלייבוק את הפרטים הבאים:

    - name: Collect AlloyDB Omni Debug Dump
      hosts: all
      become: true
      gather_facts: true
      vars:
        ansible_user: ANSIBLE_USER
        ansible_ssh_private_key_file: PATH_TO_PRIVATE_SSH_KEY
        # Optional: Customize dump behavior
        dump_debug_binary_path: "BINARY_PATH"
        dump_debug_collection_type: "COLLECTION_TYPE"
        dump_debug_local_dest: ""ANSIBLE_DESTINATION""
        dump_debug_tag: ""TAG_NAME""
        dump_debug_journal_spec: "JOURNAL_SPEC"
      roles:
        - role: google.alloydbomni_orchestrator.dump_debug
    

    מחליפים את מה שכתוב בשדות הבאים:

    • ‫ANSIBLE_USER: המשתמש ש-Ansible מתחבר בשמו.
    • ‫PATH_TO_PRIVATE_SSH_KEY: הנתיב לקובץ של מפתח ה-SSH הפרטי.
    • ‫BINARY_PATH: אופציונלי. הנתיב לקבצים הבינאריים בצמתים מרוחקים. ברירת המחדל היא /usr/local/bin.
    • ‫COLLECTION_TYPE: אופציונלי. סוג האוסף (status,‏ logs,‏ config או all). ברירת המחדל היא all.
    • ‫ANSIBLE_DESTINATION: אופציונלי. היעד בצומת הבקרה של Ansible. ברירת המחדל היא /tmp/debug_dump.
    • ‫TAG_NAME: אופציונלי. מזהה בהתאמה אישית. אם התג קיים, המערכת מוסיפה סיומות (לדוגמה, _1). ברירת המחדל היא חותמת הזמן של המערכת.
    • ‫JOURNAL_SPEC: אופציונלי. תומך בדגלים של journalctl (לדוגמה, "--since '1 hour ago'"). ברירת המחדל היא -n 1000.
  2. מריצים את ה-playbook באמצעות הפקודה ansible-playbook, ומציינים את deployment_spec.yaml בתור המלאי.

    # standard execution
    ansible-playbook dump_debug.yml -i PATH_TO_DEPLOYMENT_SPEC

    לחלופין, אפשר להריץ את ה-playbook עם תג בהתאמה אישית ומפרט יומן לבחירתכם.

    ansible-playbook dump_debug.yml -i PATH_TO_DEPLOYMENT_SPEC \
    -e 'dump_debug_tag=TAG_NAME' \
    -e 'dump_debug_journal_spec: "JOURNAL_SPEC"'

    מחליפים את מה שכתוב בשדות הבאים:

    • ‫PATH_TO_DEPLOYMENT_SPEC: הנתיב לקובץ ה-YAML של מפרט הפריסה.
    • ‫TAG_NAME: אופציונלי. מזהה בהתאמה אישית. אם התג קיים, המערכת מוסיפה סיומות (לדוגמה, _1). ברירת המחדל היא חותמת הזמן של המערכת.
    • ‫JOURNAL_SPEC: אופציונלי. תומך בדגלים של journalctl (לדוגמה, "--since '1 hour ago'"). ברירת המחדל היא -n 1000.

איסוף מידע על תוצאות ניפוי הבאגים באמצעות הכלי "קובץ dump של ניפוי באגים"

אפשר להשתמש בכלי alloydbomni_dump כדי ליצור קובץ dump. הכלי הזה כלול בחבילת התזמור ב-AlloyDB Omni.

יצירת קובץ dump

מריצים את הסקריפט הבא בצומתי האשכול של AlloyDB Omni שרוצים לנפות בהם באגים.

sudo /usr/local/bin/alloydbomni_dump \
   -k SSH_KEY \
   -u USER \
   -d PATH_TO_DEPLOYMENT_SPEC \
   -o OUTPUT_DIRECTORY \
   [options]

מחליפים את מה שכתוב בשדות הבאים:

  • ‫SSH_KEY: הנתיב למפתח ה-SSH הפרטי של המשתמש.
  • ‫USER: שם המשתמש לגישת SSH לצומתי האשכול.
  • ‫PATH_TO_DEPLOYMENT_SPEC: הנתיב לקובץ ה-YAML של מפרט הפריסה.
  • ‫OUTPUT_DIRECTORY: הספרייה המקומית שבה יישמר קובץ ה-dump שנוצר.

הפקודות הנתמכות

  • ‫-k: הנתיב הנדרש למפתח הפרטי של SSH.
  • ‫-u: שם המשתמש של חשבון השירות הנדרש.
  • ‫-d: הנתיב הנדרש לקובץ ה-YAML של מפרט הפריסה.
  • ‫-o: ספריית הפלט הנדרשת לקובץ ה-tar הסופי.
  • ‫-t: מזהה אופציונלי של תג מותאם אישית.
  • ‫-c: סוג האוסף האופציונלי (status, ‏logs, ‏config, ‏all).
  • ‫-s: מפרט אופציונלי של גודל וזמן היומן (לדוגמה, -s "--since \"30 minutes ago\"").

דוגמה לביצוע

alloydbomni_dump -k /home/user/ssh-key \
  -u sa_12345 -d /tmp/deployment_spec.yaml \
  -o /tmp/debug_dump -s "--since \"2 hours ago\""

קבלת יומני אבחון של Orchestrator

אתם יכולים לקבל את יומני האבחון שנוצרו על ידי כלי התזמור alloydbctl ו-Ansible. כך אפשר להגדיל את דרגת המלל כדי לפתור בעיות או להשתיק את הפלט של סקריפטים אוטומטיים. רישום ביומן חיוני לאבחון בעיות במהלך ההפעלה, הניהול או התפעול הכללי של האשכולות.

איך מקבלים יומני ניפוי באגים של alloydbctl

הכלי alloydbctl תומך בארגומנטים של שורת הפקודה כדי לשלוט ברמת היומן וביעד הפלט. רמת הרישום ביומן קובעת את חומרת ההודעות שיירשמו ביומן, ויעד הרישום ביומן מציין איפה היומנים האלה נכתבים.

alloydbctl [command] ... [{-l|--log_level} <LEVEL>] [{-f|--log_file} <FILE>]

רמות יומן (-l / --log_level)

אפשר להשתמש ברמות היומן הבאות. רמות היומן לא תלויות רישיות (לדוגמה, המערכת מתייחסת ל-DEBUG ול-debug באותו אופן).

  • ‫NOTSET (ברירת מחדל): לא מתבצע רישום ביומן.
  • ‫DEBUG: רישום מידע מפורט ביומן, בדרך כלל רלוונטי רק לאבחון בעיות. מתעד בקשות ותגובות של RPC.
  • INFO: אישור שהכול פועל כמו שצריך.
  • ‫WARNING: אינדיקציה לכך שמשהו לא צפוי קרה (לדוגמה, "מעט מקום בכונן"), אבל התוכנה עדיין פועלת.
  • ERROR: בגלל בעיה חמורה יותר, התוכנה לא יכולה לבצע פונקציה מסוימת.
  • ‫CRITICAL: שגיאה חמורה, שמציינת שיכול להיות שהתוכנית עצמה לא יכולה להמשיך לפעול.

יעד היומן (-f / --log_file)

אפשר לבחור את יעדי היומנים הבאים:

  • נתיב הקובץ: אם צוין (לדוגמה, -f /tmp/alloydbctl.log), היומנים נכתבים בקובץ שצוין.
  • פלט סטנדרטי (stdout): אם לא מצוין ערך, היומנים מודפסים במסוף (stdout).

דוגמה

בדוגמה הבאה משתמשים ב-alloydbctl כדי להחיל מפרטים של פריסה ומשאבים, תוך הפעלת רישום ביומן ברמת DEBUG. היומנים, כולל מידע מפורט ובקשות/תגובות של RPC, נכתבים בקובץ /tmp/alloydbctl_debug.log במקום בפלט הסטנדרטי (stdout).

alloydbctl apply -d deployment_spec.yaml -r resource_spec.yaml -l DEBUG -f /tmp/alloydbctl_debug.log

איך מקבלים יומני ניפוי באגים של Ansible

התזמור של Ansible יוצר יומנים ממשימות וממודולים של Ansible. אפשר להעביר ארגומנטים רגילים של שורת הפקודה של Ansible כדי לשנות את אופן הרישום ביומן של משימות ומודולים. מידע מפורט יותר זמין במאמרי העזרה בנושא ansible-playbook.

רמת הרישום ביומן של מודולים של Ansible

כברירת מחדל, היומנים נשלחים למסוף שבו פועל ה-Playbook.

כדי להגדיר את ההגדרה log_level, מריצים את הפקודה הבאה:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -e log_level=DEBUG

אפשר גם להשתמש בדגלי דרגת המלל הרגילים הבאים של Ansible כדי לשלוט בדרגת המלל של הפלט:

  • ‫-v: דרגת מלל בסיסית (יומנים ברמת INFO).
  • ‫-vv ומעלה: דרגת מלל גבוהה יותר (יומנים ברמת DEBUG).

לדוגמה:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -vv

נתיב היומן של מודולים של Ansible

כברירת מחדל, היומנים לא מתועדים וצריך להגדיר את רמת היומן כדי לתעד יומנים בקובץ היומן.

כדי לשמור את הפלט של Ansible בקובץ יומן, מריצים את הפקודה הבאה כדי להגדיר את log_path:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -e log_file=/tmp/ansible-module.log

איפוס מכונות systemd שנכשלו

אם ב-debug dump מוצגים מופעי שירות ישנים שנכשלו, אפשר למחוק אותם באמצעות הפקודה הבאה בצומת האשכול הרלוונטי:

sudo systemctl reset-failed

כדי לאפס שירות systemd ספציפי, מציינים את שם המכונה של השירות:

sudo systemctl reset-failed INSTANCE_NAME

מחליפים את INSTANCE_NAME בשם של המכונה של שירות systemd, לדוגמה alloydbomni18@abc.service.