التسجيل Logging

Logging

مفهوم ~18 دقيقة

التسجيل Logging — Logging

في سكربت تشغيل، الرسائل ليست ترفاً. هي ما سيقرأه شخص ما عند فشل خطوة في منتصف الليل. دالة logging صغيرة تجعل الرسائل موحدة: وقت، مستوى، ونص. لا تجعل كل سطر يطبع بأسلوب مختلف.

استخدم مستويات بسيطة: INFO, WARN, ERROR. اطبع الأخطاء إلى stderr. ولا تطبع أسراراً. إذا كان السكربت يتعامل مع token أو password، لا تضعها في log حتى أثناء التصحيح.

مثال عملي

script.sh

#!/usr/bin/env bash
set -euo pipefail

log() {
	local level="$1"
	shift
	local now
	now="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
	printf '%s [%s] %s\n' "$now" "$level" "$*"
}

log INFO "starting backup plan"
log WARN "dry-run mode is enabled"

Output:

في الإنتاج، قد تريد إرسال logs إلى ملف أو systemd journal. النمط نفسه يبقى مفيداً: دالة واحدة تتحكم بالشكل.

رسالة جيدة

رسالة مثل failed غير كافية. قل ماذا فشل وأين: ERROR backup source not found: /var/www/site. التفاصيل توفر وقتاً.

تحدي — Challenge

#!/usr/bin/env bash
set -euo pipefail

level="INFO"
message="ready"

# اطبع [INFO] ready — Print [INFO] ready