10.06 Logging & Monitoring

---

📌 At a Glance

รายการ	รายละเอียด
Topic	Logging & Monitoring
Difficulty	⭐⭐ Intermediate
Reading Time	10 นาที
Target	Developer, System Integrator
Related APIs	All APIs

---

🎯 Learning Objectives

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

• ออกแบบระบบ Logging สำหรับการเชื่อมต่อกับ SISAHYGO API
• ติดตามและวิเคราะห์ปัญหาจาก Log ได้
• สร้างระบบ Monitoring สำหรับตรวจสอบสถานะการเชื่อมต่อ
• เตรียมระบบให้พร้อมสำหรับการใช้งานในระดับ Production

---

Overview

การเชื่อมต่อกับ API ในระดับ Production ควรมีระบบ Logging และ Monitoring ที่สามารถบันทึกและติดตามการทำงานได้อย่างครบถ้วน

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

SISAHYGO แนะนำให้บันทึกข้อมูลสำคัญของทุก API Request และติดตามตัวชี้วัดหลัก (Key Metrics) เพื่อให้ระบบมีความเสถียรและพร้อมรองรับการใช้งานจริง

---

Figure 10-6 Logging & Monitoring

Figure 10-6 แสดงสถาปัตยกรรมการบันทึกข้อมูลและการติดตามสถานะของระบบ ตั้งแต่การเรียก API การบันทึก Log การวิเคราะห์เหตุการณ์ และการแจ้งเตือนเมื่อพบความผิดปกติ

---

Logging Architecture

Business Application

        │

        ▼

API Request

        │

        ▼

SISAHYGO API

        │

        ▼

API Response

        │

        ▼

Application Log

        │

        ├── File Log

        ├── Database Log

        └── Centralized Logging

        │

        ▼

Dashboard / Monitoring

---

Recommended Log Fields

ควรบันทึกข้อมูลอย่างน้อยดังต่อไปนี้

Field	Description
Timestamp	วันที่และเวลาที่เรียก API
Endpoint	API Endpoint
HTTP Method	GET / POST
HTTP Status	สถานะการตอบกลับ
Response Time	ระยะเวลาการตอบสนอง
client_reference_no	เลขอ้างอิงจากระบบต้นทาง (ถ้ามี)
Order ID	รหัสรายการของ SISAHYGO (ถ้ามี)
Request ID	รหัสอ้างอิงของ Request (ถ้ามี)
Error Code	รหัสข้อผิดพลาด
Error Message	ข้อความสรุปข้อผิดพลาด

---

Example Log Record

2026-07-01 10:15:08

POST /order-checkings

HTTP 201

Response Time : 325 ms

client_reference_no : ERP-20260701-000123

Order ID : 681126

Status : Success

---

Monitoring Metrics

ควรติดตามตัวชี้วัดต่อไปนี้

Metric	Purpose
API Availability	ตรวจสอบว่า API พร้อมใช้งาน
Success Rate	อัตราการเรียก API สำเร็จ
Error Rate	อัตราการเกิดข้อผิดพลาด
Response Time	ระยะเวลาการตอบสนอง
Retry Count	จำนวนครั้งที่ Retry
Failed Requests	จำนวน Request ที่ล้มเหลว
Synchronization Time	เวลาที่ใช้ในการ Synchronize Master Data

---

Monitoring Workflow

API Request

      │

      ▼

Collect Metrics

      │

      ▼

Store Logs

      │

      ▼

Analyze

      │

      ▼

Alert ?

      │

 ├────► No

 │

 ▼

Dashboard

 │

 └────► Yes

          │

          ▼

Notification

          │

          ▼

Investigation

---

Alert Recommendations

ควรตั้ง Alert เมื่อเกิดเหตุการณ์ เช่น

Condition	Recommendation
API Down	แจ้งเตือนทันที
HTTP 500 เพิ่มขึ้นผิดปกติ	แจ้งเตือนผู้ดูแล
Success Rate ต่ำกว่า 95%	ตรวจสอบระบบ
Response Time สูงผิดปกติ	วิเคราะห์ประสิทธิภาพ
Synchronization ล้มเหลว	แจ้งเตือนและ Retry

---

Log Retention

แนะนำระยะเวลาในการเก็บ Log

Log Type	Recommended Retention
API Request Log	90 วัน
Error Log	180 วัน
Audit Log	ตามนโยบายขององค์กร
Synchronization Log	90 วัน

---

Dashboard Recommendations

Dashboard ควรแสดงข้อมูลสำคัญ เช่น

• API Calls ต่อวัน
• Success / Error Rate
• Average Response Time
• จำนวน Retry
• Synchronization Status
• Recent Errors
• API Availability

---

Best Practices

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

---

Common Mistakes

Problem	Recommendation
ไม่บันทึก Response Time	ควรบันทึกทุก Request
บันทึก API Key ลง Log	ไม่ควรบันทึกข้อมูลลับ
ไม่มี Alert	ตั้งการแจ้งเตือนสำหรับเหตุการณ์สำคัญ
ลบ Log เร็วเกินไป	กำหนดระยะเวลาการเก็บข้อมูลที่เหมาะสม
ไม่มี Dashboard	ควรมี Dashboard สำหรับติดตามภาพรวม

---

Related Sections

• 10.05 Retry & Recovery Strategy
• 10.07 Security Best Practices
• Chapter 9 Error Handling & Response Codes

---

Summary

Logging และ Monitoring เป็นองค์ประกอบสำคัญของระบบ Integration ระดับ Production โดยช่วยให้สามารถติดตาม วิเคราะห์ และแก้ไขปัญหาได้อย่างรวดเร็ว การบันทึกข้อมูลสำคัญของทุก API Request การติดตามตัวชี้วัดหลัก การสร้าง Dashboard และการตั้ง Alert สำหรับเหตุการณ์สำคัญ จะช่วยเพิ่มความเสถียร ความน่าเชื่อถือ และความพร้อมของระบบในการรองรับการใช้งานจริง

---

Next Step

➡️ 10.07 Security Best Practices