ใช้ Stackdriver Logging และ Stackdriver Trace สำหรับ Cloud Functions

1. บทนำ

ใน Codelab นี้ คุณจะได้เรียนรู้วิธีใช้ประโยชน์จากเครื่องมือการบันทึกและตรวจสอบที่พร้อมให้นักพัฒนาซอฟต์แวร์ทุกคนที่ทำงานกับ Cloud Functions เครื่องมือดังกล่าวมาพร้อมกับ Cloud Function ทั้งหมดที่คุณสามารถใช้ได้ในทุกภาษาที่รองรับ และควรจะช่วยให้คุณเขียนและเรียกใช้โค้ดแบบ Serverless ได้อย่างมีประสิทธิภาพยิ่งขึ้น

คุณจะใช้ Cloud Function ที่ทริกเกอร์ HTTP ได้ แต่ข้อมูลทั้งหมดที่ครอบคลุมจะมีผลกับภาษาอื่นๆ และ Cloud Functions ที่ทริกเกอร์โดยเหตุการณ์อื่นๆ ด้วย

2. การตั้งค่าและข้อกำหนด

การตั้งค่าสภาพแวดล้อมตามเวลาที่สะดวก

1. ลงชื่อเข้าใช้ Cloud Console และสร้างโปรเจ็กต์ใหม่หรือใช้โปรเจ็กต์ที่มีอยู่ซ้ำ (หากยังไม่มีบัญชี Gmail หรือ G Suite คุณต้องสร้างบัญชี)

หมายเหตุ: คุณเข้าถึง Cloud Console ได้ง่ายๆ โดยจดจำ URL ของ Cloud Console ซึ่งก็คือ Console.cloud.google.com

โปรดจดจำรหัสโปรเจ็กต์ ซึ่งเป็นชื่อที่ไม่ซ้ำกันในโปรเจ็กต์ Google Cloud ทั้งหมด (ชื่อด้านบนมีคนใช้แล้ว และจะใช้ไม่ได้ ขออภัย) และจะมีการอ้างอิงใน Codelab ว่า PROJECT_ID ในภายหลัง

หมายเหตุ: หากใช้บัญชี Gmail คุณสามารถปล่อยให้การตั้งค่าตำแหน่งเริ่มต้นเป็นไม่มีองค์กรได้ หากคุณใช้บัญชี G Suite ให้เลือกสถานที่ที่เหมาะกับองค์กร

2. ถัดไป คุณจะต้องเปิดใช้การเรียกเก็บเงินใน Cloud Console เพื่อใช้ทรัพยากร Google Cloud

การใช้งาน Codelab นี้น่าจะไม่มีค่าใช้จ่ายใดๆ หากมี ตรวจสอบว่าคุณได้ทำตามวิธีการใน "การล้างข้อมูล" ซึ่งจะแนะนำคุณเกี่ยวกับวิธีปิดทรัพยากรเพื่อไม่ให้มีการเรียกเก็บเงินนอกเหนือจากบทแนะนำนี้ ผู้ใช้ใหม่ของ Google Cloud จะมีสิทธิ์เข้าร่วมโปรแกรมทดลองใช้ฟรี$300 USD

Cloud Shell

แม้ว่าคุณจะใช้ Cloud Functions รวมถึงความสามารถในการบันทึกและตรวจสอบจากระยะไกลได้จากแล็ปท็อป แต่คุณจะใช้ Cloud Shell ซึ่งเป็นสภาพแวดล้อมแบบบรรทัดคำสั่งที่ทำงานใน Google Cloud

เครื่องเสมือนแบบ Debian นี้เต็มไปด้วยเครื่องมือการพัฒนาทั้งหมดที่คุณต้องการ โดยมีไดเรกทอรีหลักขนาด 5 GB ที่ทำงานอย่างต่อเนื่องใน Google Cloud ซึ่งจะช่วยเพิ่มประสิทธิภาพของเครือข่ายและการตรวจสอบสิทธิ์ได้อย่างมาก ซึ่งหมายความว่าสิ่งที่คุณต้องมีสำหรับ Codelab นี้คือเบราว์เซอร์ (ใช่แล้ว ทั้งหมดนี้ทำงานได้บน Chromebook)

1. หากต้องการเปิดใช้งาน Cloud Shell จาก Cloud Console เพียงคลิกเปิดใช้งาน Cloud Shell (จะใช้เวลาเพียงไม่นานในการจัดสรรและเชื่อมต่อกับสภาพแวดล้อม)

เมื่อเชื่อมต่อกับ Cloud Shell คุณควรเห็นว่าตนเองผ่านการตรวจสอบสิทธิ์แล้วและโปรเจ็กต์ได้รับการตั้งค่าเป็น PROJECT_ID แล้ว

gcloud auth list

เอาต์พุตจากคำสั่ง

Credentialed accounts:
 - <myaccount>@<mydomain>.com (active)

หมายเหตุ: เครื่องมือบรรทัดคำสั่ง gcloud ติดตั้งมาล่วงหน้าใน Cloud Shell แล้ว และคุณจะได้รับการสนับสนุนสำหรับการเติมแท็บอย่างแน่นอน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวมของเครื่องมือบรรทัดคำสั่ง gcloud

gcloud config list project

เอาต์พุตจากคำสั่ง

[core]
project = <PROJECT_ID>

หากโปรเจ็กต์ไม่ได้ตั้งค่าไว้ด้วยเหตุผลบางประการ ให้ใช้คำสั่งต่อไปนี้

gcloud config set project <PROJECT_ID>

กำลังมองหา PROJECT_ID ของคุณอยู่ใช่ไหม ตรวจสอบรหัสที่คุณใช้ในขั้นตอนการตั้งค่าหรือดูในแดชบอร์ด Cloud Console

Cloud Shell ยังตั้งค่าตัวแปรสภาพแวดล้อมโดยค่าเริ่มต้นด้วย ซึ่งอาจเป็นประโยชน์เมื่อคุณเรียกใช้คำสั่งในอนาคต

echo $GOOGLE_CLOUD_PROJECT

เอาต์พุตจากคำสั่ง

<PROJECT_ID>

2. สุดท้าย ให้ตั้งค่าโซนและการกำหนดค่าโปรเจ็กต์เริ่มต้น

gcloud config set compute/zone us-central1-f

คุณเลือกโซนต่างๆ ได้หลากหลาย ดูข้อมูลเพิ่มเติมได้ที่ภูมิภาคและ โซน

หมายเหตุ: เมื่อคุณเรียกใช้ gcloud ในเครื่องของตัวเอง การตั้งค่าการกำหนดค่าจะยังคงอยู่ในเซสชันต่างๆ แต่ใน Cloud Shell คุณจะต้องตั้งค่านี้สำหรับทุกเซสชันใหม่หรือการเชื่อมต่ออีกครั้ง

3. ทำให้ Cloud Function อย่างง่ายใช้งานได้

เพื่อให้มีการตรวจสอบ ให้สร้างข้อความ "สวัสดีชาวโลก" Cloud Function ในเมนูด้านซ้ายของ Google Cloud Console ให้คลิก Cloud Functions แล้วคลิกสร้างฟังก์ชัน

ป้อน " Hello-monitor" เป็นชื่อ Cloud Function ใหม่

เก็บค่าเริ่มต้นทั้งหมดสำหรับซอร์สโค้ดไว้ (อย่างไรก็ตาม คุณเลือกภาษา/รันไทม์อื่นได้หากต้องการ)

สุดท้ายให้คลิกสร้าง

คุณควรเห็น Cloud Function แสดงอยู่โดยมีเครื่องหมายถูกสีเขียวอยู่ข้างๆ ซึ่งหมายความว่าพร้อมที่จะเรียกใช้แล้ว

4. ทดสอบ Cloud Function และส่งการรับส่งข้อมูลโดยใช้ตัวสร้างโหลด

เมื่อทำให้ Cloud Function ใช้งานได้เรียบร้อยแล้ว ให้ทดสอบจากบรรทัดคำสั่ง

ก่อนอื่นให้ใช้คำสั่งต่อไปนี้โดยใช้ Cloud Shell

$ gcloud functions describe hello-monitor

การดำเนินการนี้ควรแสดงคำอธิบายของ Cloud Function รวมถึง URL สำหรับ httpsTrigger ซึ่งเป็นปลายทาง HTTP(S) ที่จะเรียกใช้ Cloud Function ซึ่งควรมีลักษณะดังนี้ https://<region>-<project-id>.cloudfunctions.net/hello-monitor

ตอนนี้การทริกเกอร์ Cloud Function ควรทำได้ง่ายพอๆ กับการใช้คำสั่ง curl ใน URL ดังกล่าว

$ curl https://<region>-<project-id>.cloudfunctions.net/hello-monitor
Hello World!

ตอนนี้ให้ใช้ Vegeta ซึ่งเป็นเครื่องมือทดสอบการโหลด HTTP ที่ใช้งานง่าย หากต้องการติดตั้ง จาก Cloud Shell ให้พิมพ์คำสั่งต่อไปนี้ :

$ go get -u github.com/tsenart/vegeta

หากต้องการส่งการรับส่งข้อมูลไปยัง Cloud Function (5 คำขอต่อวินาทีเป็นเวลา 2 นาที) ให้ใช้คำสั่งต่อไปนี้

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

5. ไปยังส่วนต่างๆ ในบันทึก

คลิกดูบันทึกจากมุมมองรายละเอียดของ Cloud Function

จากนั้นระบบควรนำคุณไปยังส่วน Stackdriver Logging ของโปรเจ็กต์ ซึ่งจะแสดงเฉพาะบันทึก Cloud Function เท่านั้น

คำขอทั้งหมดที่ส่งไปยัง Cloud Function ควรจะแสดงรหัสสถานะ 200

เมื่อดูบันทึก คุณสามารถดำเนินการดังต่อไปนี้

• กรองตามระดับการบันทึก (ในกรณีของคุณ บันทึกทั้งหมดจะเป็นระดับ debug)
• เลือกกรอบเวลาที่เจาะจง (สัมพัทธ์หรือสัมบูรณ์)
• เปิดใช้การสตรีมบันทึก (โดยเปิด Play ที่ด้านบนของหน้าจอ)
• คัดลอกลิงก์ไปยังรายการบันทึก (สำหรับแชร์กับสมาชิกในทีม)
• แสดงรายการบันทึกในบริบททรัพยากร
• ปักหมุดรายการบันทึก (เป็นสัญลักษณ์ภาพ)
• ส่งออกบันทึกไปยัง BigQuery, Cloud Storage หรือ Pub/Sub (หรือดาวน์โหลดเป็นไฟล์ JSON หรือ CSV)

หมายเหตุ: ในโค้ดของ Cloud Function แล้ว บันทึกไปยังเอาต์พุตมาตรฐานจะปรากฏขึ้นพร้อมระดับการบันทึก __INFO__ ส่วนการบันทึกไปยังข้อผิดพลาดมาตรฐานจะมีระดับการบันทึก __ERROR__ ข้อความระบบภายในมีระดับการบันทึก __DEBUG__

หมายเหตุ: เมื่อใช้ตัวเลือกด้านบนซ้าย คุณจะกรองบันทึกตามฟังก์ชันได้ นอกจากนี้ คุณยังสามารถค้นหาป้ายกำกับหรือค้นหาข้อความแบบเต็มในแถบค้นหาที่ด้านบนของหน้าต่าง ในกรณีของคุณ ป้ายกำกับคือ hello-monitor (ชื่อฟังก์ชัน) และตัวระบุการดำเนินการสำหรับคำขอแต่ละรายการ

นอกจากนี้ คุณยังคัดลอกตัวกรองเพื่อแชร์ได้อีกด้วย (ดูเมนูแบบเลื่อนลงในช่องค้นหา)

หมายเหตุ: นอกเหนือจากเครื่องมือกราฟิกเหล่านั้นแล้ว คุณยังเข้าถึงบันทึกของ Cloud Function โดยใช้ gcloud functions logs read ได้ด้วย รวมถึงเข้าถึงผ่าน API ที่ระบุไว้ที่นี่

6. อัปเดตฟังก์ชัน

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

เครื่องมืออีกอย่างที่มีรายละเอียดมากขึ้นในการสังเกตเวลาในการตอบสนองและการเรียกใช้ RPC คือการติดตาม Stackdriver แต่ก่อนที่จะใช้งานได้ คุณจะต้องทำการเปลี่ยนแปลงบางอย่างกับ Cloud Functions ทำสิ่งต่อไปนี้:

1. เพิ่มแพ็กเกจ node-emoji แบบประหยัดค่าใช้จ่ายเป็นทรัพยากร Dependency
2. อัปเดตรหัสฟังก์ชันเพื่อใช้โมดูลอีโมจิของโหนดและแนะนำเวลาในการตอบสนอง
3. เพิ่มตัวแปรสภาพแวดล้อมเพื่อเปิดใช้ Stackdriver Trace สำหรับ Cloud Functions

จากรายละเอียดฟังก์ชัน ให้คลิกแก้ไขเพื่อแก้ไขฟังก์ชัน

แก้ไขไฟล์ package.json เพื่อเพิ่มทรัพยากร Dependency สำหรับแพ็กเกจ node-emoji

{
  "name": "sample-http",
  "version": "0.0.1",
  "dependencies": {
    "node-emoji": "^1.8.1"
  }
}

แก้ไขฟังก์ชันจริงโดยเปลี่ยนเนื้อหาของ index.js เป็นดังนี้

const emoji = require('node-emoji');

exports.helloWorld = (req, res) => {
  let message = req.query.message || req.body.message || 'Hello World!';

  // add some latency, functions are too quick!
  setTimeout(function() {
     message += emoji.random().emoji;  
     res.status(200).send(message);
  }, (3 * 100));  // 300ms
  
};

ซึ่งเป็นการเพิ่มอีโมจิแบบสุ่มลงในข้อความที่ Cloud Function แสดงผลหลังจากหยุดชั่วคราวเป็นเวลา 300 มิลลิวินาที

สุดท้าย ให้เพิ่มตัวแปรสภาพแวดล้อม Cloud Function ที่ชื่อ GOOGLE_CLOUD_TRACE_ENABLED และตั้งค่าเป็น true ดังนี้

คลิกบันทึก

กลับไปที่ Cloud Shell และเรียกคืนคำสั่งเพื่อสร้างโหลดบางส่วนบน Cloud Function ที่ทำให้ใช้งานได้ใหม่

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

ตอนนี้คุณพร้อมที่จะสังเกตรายการการติดตามที่สร้างขึ้นโดยไม่มีข้อกำหนดการตั้งค่าอื่นๆ และไม่มีไลบรารีการติดตามที่เฉพาะเจาะจงในโค้ดแล้ว

7. ติดตาม Cloud Function ที่อัปเดตแล้ว

ไปที่รายการการติดตาม (ในส่วน Stackdriver Trace) โดยใช้เมนูด้านซ้าย

คุณควรจะเห็นสิ่งที่คล้ายกับภาพหน้าจอต่อไปนี้

ซึ่งน่าจะแสดงให้เห็นอย่างชัดเจนว่าเวลาในการตอบสนองที่ใช้ใน Cloud Function นั้นวัดที่ 300 มิลลิวินาที

แต่ละจุดบนกราฟเป็นคำขอที่คุณสามารถดูรายละเอียดต่างๆ เช่น การประทับเวลา, เมธอด HTTP และสถานะ, ป้ายกำกับ, ลิงก์ไปยังรายการบันทึกที่เกี่ยวข้อง และการเรียกใช้ RPC ที่ตามมาซึ่ง Cloud Function สร้างขึ้น

หากต้องการซูมเข้า เพียงแค่คลิกและลากบนกราฟ

หากต้องการซูมออก ให้คลิกยกเลิกการซูมที่ด้านบนของหน้า

เนื่องจากคุณทำให้ Cloud Function เดียวใช้งานได้ กราฟจึงแสดงเฉพาะคำขอ GET ใน URI hello-monitor แต่คุณจะกรองการติดตามได้ด้วยเมธอด HTTP (GET, POST, DELETE) ตามสถานะ HTTP (2XX, 3XX) หรือใช้ตัวกรองคำขอก็ได้

ไปที่ภาพรวมในเมนูด้านซ้ายมือ

คุณจะดูการติดตามล่าสุดและข้อมูลเชิงลึกอื่นๆ ได้จากหน้าภาพรวมนี้

นอกจากนี้คุณยังสามารถสร้างรายงานที่กำหนดเองโดยใช้ตัวกรองคำขอ URI, เมธอด HTTP, สถานะ HTTP และช่วงเวลาร่วมกันได้อีกด้วย ยิ่งไปกว่านั้น ยังช่วยให้คุณเปรียบเทียบค่าที่สร้างขึ้นกับเกณฑ์พื้นฐานตามเวลาได้อีกด้วย

หากตั้งค่าช่วงเวลาที่ถูกต้องโดยมีจุดข้อมูลเพียงพอ คุณสามารถสร้างรายงานที่แสดงการเปลี่ยนแปลงเวลาในการตอบสนองที่สำคัญระหว่าง Cloud Function เริ่มต้นและฟังก์ชันใหม่ได้

รายงานที่กำหนดเองดังกล่าวสามารถใช้ค้นหาเวลาที่เกิดปัญหาด้านประสิทธิภาพและติดตามตัวบ่งชี้ระดับบริการ (SLI) เช่น เวลาในการตอบสนองคำขอของผู้ใช้ปลายทาง

8. ได้เวลาล้างข้อมูลทรัพยากรแล้ว

Codelab จบลงเพียงเท่านี้

แม้ว่า Cloud Functions และเครื่องมือ Stackdriver จะเป็นแพลตฟอร์มแบบ Serverless ซึ่งไม่มีค่าใช้จ่ายเมื่อไม่ได้ใช้งาน โปรดเป็นพลเมืองระบบคลาวด์ที่ดีและลบ Cloud Function เพียงเลือก hello-monitor ในส่วนภาพรวมในส่วนฟังก์ชันระบบคลาวด์ แล้วคลิกลบ

9. ขั้นตอนถัดไปคือ

นี่คือข้อมูลเพิ่มเติมบางส่วน

• เมตริกตามบันทึกของ Stackdriver Monitoring
• Stackdriver Error Reporting

/