เปิดใช้การบันทึก

ไลบรารีนี้มีการบันทึกที่หลากหลายสำหรับการโต้ตอบกับ Google Ads API คุณสามารถบันทึกสิ่งต่อไปนี้ได้

• ข้อมูลโดยละเอียด: คำขอแบบเต็มที่ส่งไปยัง API และการตอบกลับที่ได้รับ
• สรุปสั้นๆ: ภาพรวมระดับสูงของการโต้ตอบ API

คุณควบคุมการตั้งค่าการบันทึกเหล่านี้ได้ 2 วิธี ดังนี้

• การกำหนดค่าไลบรารีของไคลเอ็นต์: ใช้ตัวเลือกการกำหนดค่าเฉพาะของไลบรารีในไฟล์ google-ads.yaml หรือตัวแปรสภาพแวดล้อม
• เขียนโปรแกรมด้วย Python: ใช้เฟรมเวิร์ก logging ในตัวของ Python เพื่อควบคุมโดยตรง

กำหนดค่าผ่าน google-ads.yaml

ระบบจะกำหนดค่าการบันทึกโดยอัตโนมัติเมื่อมีการเริ่มต้นอินสแตนซ์ GoogleAdsClient (เช่น เมื่อคุณเรียกใช้ load_from_storage) เมื่อเริ่มต้น ไลบรารีจะดำเนินการดังนี้

• อ่านการตั้งค่าการบันทึกที่ระบุจากการกำหนดค่า
• ส่งการตั้งค่าเหล่านั้นไปยัง logging.config.dictConfig ในตัวของ Python เพื่อเปิดใช้งาน

ตัวอย่างเช่น คุณสามารถเพิ่มส่วน logging ลงในไฟล์ google-ads.yaml ได้ดังนี้

logging:
  version: 1
  disable_existing_loggers: false
  formatters:
    default_fmt:
      format: '[%(asctime)s - %(levelname)s] %(message).5000s'
      datefmt: '%Y-%m-%d %H:%M:%S'
  handlers:
    default_handler:
      class: logging.StreamHandler
      formatter: default_fmt
  loggers:
    '':
      handlers: [default_handler]
      level: INFO

กำหนดค่าแบบเป็นโปรแกรม

เมื่อใช้ไลบรารีเป็นแพ็กเกจที่ติดตั้งโดยไม่มีส่วน logging ในไฟล์การกำหนดค่า คุณสามารถผสานรวมการบันทึกเข้ากับการตั้งค่าการบันทึกของแอปพลิเคชันแบบเป็นโปรแกรมได้ แนบเครื่องมือจัดการการบันทึกกับอินสแตนซ์ตัวบันทึกของไลบรารี (google.ads.googleads.client) โดยใช้ addHandler และตั้งค่าระดับบันทึกเป้าหมาย ดังนี้

import logging
import sys

# Retrieve the library's logger instance.
logger = logging.getLogger("google.ads.googleads.client")

# Direct logs to standard output (stdout).
logger.addHandler(logging.StreamHandler(sys.stdout))

# Set the log level to DEBUG to view detailed messages.
logger.setLevel(logging.DEBUG)

หากต้องการส่งบันทึกไปยังข้อผิดพลาดมาตรฐาน (stderr) ซึ่งมักใช้สำหรับข้อความแสดงข้อผิดพลาดและคำเตือน ให้ส่ง sys.stderr ไปยัง logging.StreamHandler ดังนี้

import logging
import sys

logger = logging.getLogger("google.ads.googleads.client")
logger.addHandler(logging.StreamHandler(sys.stderr))
logger.setLevel(logging.WARNING)

ระดับการบันทึก

ไคลเอ็นต์จะสร้างบันทึกที่ระดับความรุนแรงหลายระดับ และคุณสามารถกำหนดค่าเครื่องมือบันทึกเพื่อดูข้อมูลต่อไปนี้บางส่วนหรือทั้งหมดได้

เนื่องจากเฟรมเวิร์กการบันทึกของ Python จะละเว้นข้อความในบันทึกที่มีความรุนแรงน้อยกว่าระดับที่กำหนดค่าไว้ การตั้งค่าระดับเป็น WARNING จะแสดงเฉพาะข้อความสั้นๆ สำหรับคำขอที่ไม่สำเร็จ ส่วนการตั้งค่าระดับเป็น DEBUG จะแสดงบันทึกทุกประเภทในตาราง

บันทึกลงในไฟล์

คุณสามารถเขียนบันทึกลงในไฟล์โดยใช้โปรแกรมใน Python หรือโดยการเปลี่ยนเส้นทางเอาต์พุตจากบรรทัดคำสั่ง

บันทึกลงในไฟล์ใน Python

หากต้องการเขียนบันทึกลงในไฟล์โดยตรงจาก Python ให้แนบ logging.FileHandler กับโปรแกรมบันทึกของไคลเอ็นต์ ดังนี้

import logging

logger = logging.getLogger("google.ads.googleads.client")
file_handler = logging.FileHandler("google_ads.log")
logger.addHandler(file_handler)
logger.setLevel(logging.INFO)

เปลี่ยนเส้นทางเอาต์พุตโดยใช้ Shell

เมื่อเรียกใช้สคริปต์ตัวอย่าง เช่น get_campaigns.py จากบรรทัดคำสั่ง คุณสามารถเปลี่ยนเส้นทางเอาต์พุตบันทึกคอนโซลไปยังไฟล์โดยใช้เชลล์ของระบบปฏิบัติการได้

วิธีบันทึกเอาต์พุตมาตรฐานลงในไฟล์ (เขียนทับไฟล์ที่มีอยู่)

python get_campaigns.py -c $CUSTOMER_ID > campaign_logs.txt

วิธีต่อท้ายเอาต์พุตมาตรฐานในไฟล์ที่มีอยู่

python get_campaigns.py -c $CUSTOMER_ID >> campaign_logs.txt

หากต้องการบันทึกทั้งเอาต์พุตมาตรฐานและข้อผิดพลาดมาตรฐาน (สำหรับข้อผิดพลาดและคำเตือน) ลงในไฟล์เดียวกัน ให้ทำดังนี้

python get_campaigns.py -c $CUSTOMER_ID > all_logs.txt 2>&1

หรือใน Bash 4+ ให้ทำดังนี้

python get_campaigns.py -c $CUSTOMER_ID &> all_logs.txt

ตัวสกัดกั้น gRPC ที่กำหนดเอง

ไลบรารีของไคลเอ็นต์ Python ใช้ interceptors ของ gRPC เพื่อเข้าถึงและบันทึกรายละเอียดคำขอและการตอบกลับ คุณตั้งค่าการบันทึกที่กำหนดเองได้โดยสร้างตัวสกัดกั้น gRPC ด้วยตรรกะที่กำหนดเอง ดูรายละเอียดเพิ่มเติมและตัวอย่างของตัวสกัดกั้นการบันทึกที่กำหนดเองได้ในคู่มือการบันทึก