การเรียนรู้การบันทึกใน Rails:ตั้งแต่การดีบักไปจนถึงการแจ้งเตือนเชิงรุก

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

บันทึกของเราอ่านได้ดีขึ้นมากตอนนี้ มีข้อสงสัยเล็กน้อยเกี่ยวกับความหมายของข้อความบันทึกแต่ละข้อความ

บริบทเพิ่มเติมสำหรับข้อความบันทึก

ข้อความบันทึกใหม่ของเราให้ภาพที่ชัดเจนของสิ่งที่เกิดขึ้น เนื่องจากนี่เป็นตัวอย่างง่ายๆ เราจึงมีความเข้าใจที่ดีว่าเหตุใดจึงมีเหตุการณ์บางอย่างเกิดขึ้น ในความเป็นจริง มันมักจะไม่ง่ายขนาดนั้น

การให้ข้อมูลเพิ่มเติมเกี่ยวกับบริบทที่ระบบเขียนแต่ละข้อความสามารถช่วยแก้ไขจุดบกพร่องได้อย่างมาก

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

หมายเหตุ :คุณคงสังเกตเห็นว่าการสร้างข้อความบันทึกด้วยข้อมูลเชิงบริบทอาจเป็นเรื่องยุ่งยากเมื่อคุณใช้ตัวบันทึกเริ่มต้นของ Rails โชคดีที่โปรแกรมบันทึกแบบกำหนดเอง เช่น Ougai หรือMrLogaLoga ช่วยให้การดำเนินการนี้ง่ายขึ้นมาก

การบันทึกแบบมีโครงสร้าง

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

รูปแบบที่ผมใช้คือ JSON แต่คุณอาจต้องการรูปแบบบันทึกอื่นๆ เช่น Logstash ขึ้นอยู่กับเครื่องมือที่คุณใช้ คุณสามารถเปลี่ยนรูปแบบของข้อความบันทึกได้โดยการสร้างตัวจัดรูปแบบบันทึกที่กำหนดเอง

แทนที่จะเขียนตัวจัดรูปแบบแบบกำหนดเองด้วยตัวเอง คุณสามารถใช้หนึ่งในหลาย gem ที่ให้ตัวจัดรูปแบบบันทึกแบบกำหนดเองได้ Irecommend Lograge ซึ่งไม่เพียงแต่นำเสนอการจัดรูปแบบที่พร้อมใช้งานทันที แต่ยังทำความสะอาดการจัดรูปแบบคำขอที่ค่อนข้างละเอียดของ Rails อีกด้วย ดังนั้นจึงอ่านได้ง่ายขึ้นมาก

การบันทึก Rails ด้วย AppSignal

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

โชคดีที่ AppSignal เพิ่งเปิดตัวฟีเจอร์การบันทึกในรุ่นเบต้า! ซึ่งช่วยให้คุณตรวจสอบและวิเคราะห์บันทึก Rails ได้โดยตรงบนเว็บอินเทอร์เฟซของ AppSignal

คุณสามารถเข้าถึงเบต้าการบันทึกของเราได้ผ่านทางแท็บ "การบันทึก" ในเมนูด้านซ้ายมือ:

หากคุณทำตามขั้นตอนในเอกสารการบันทึก Ruby คุณสามารถกำหนดค่า Rails Logger ให้ใช้ 217 คลาสโดยวางโค้ดด้านล่างใน 221 ไฟล์ก่อน 232 :

คุณยังนำเข้าบันทึกที่มีโครงสร้างในรูปแบบ JSON หรือ Lograge ได้ด้วย

เมื่อคุณตั้งค่าทุกอย่างแล้ว คุณจะเห็นบันทึก Rails ของคุณแสดงบน AppSignal!

การบันทึกและการรายงานข้อผิดพลาด

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

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

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

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

สรุป

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

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

เมื่อคุณเชี่ยวชาญการเขียนข้อความบันทึกที่ยอดเยี่ยมแล้ว คุณสามารถพัฒนาสิ่งต่างๆ เพิ่มเติมและจัดรูปแบบข้อความในลักษณะที่ช่วยให้สามารถวิเคราะห์ forlog และกรองได้ง่าย

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

ขอให้มีความสุขกับการบันทึก!

ปล. หากคุณต้องการอ่านโพสต์ Ruby Magic ทันทีที่เผยแพร่ สมัครรับจดหมายข่าว Ruby Magic ของเราและไม่พลาดแม้แต่โพสต์เดียว!

ฮันส์-ยอร์ก ชเนดลิทซ์

Hans ผู้เขียนรับเชิญของเราเป็นวิศวกรของ Rails จากเวียนนา ประเทศออสเตรีย เขาใช้เวลาส่วนใหญ่ในการเขียนโค้ดหรืออ่านหนังสือเกี่ยวกับการเขียนโค้ด และบางครั้งก็เขียนเกี่ยวกับเรื่องนี้ในบล็อกของเขาด้วยซ้ำ! เมื่อเขาไม่ได้นั่งอยู่หน้าจอ คุณอาจพบเขากำลังปีนเขาอยู่ข้างนอก

บทความทั้งหมดโดย Hans-Jörg Schnedlitz