IBM Enterprise Records، النسخة 5.1.2    

توصيف الملف ‏‎log4j.properties‎‏

يتضمن تطبيق IBM® Enterprise Records ملف نموذج log4j.properties الذي يمكن توصيفه.

الملف log4j.properties يوجد في الحافظة ier_install_path\ RecordsManagerSweep، ويمكنك توصيف تصرف التسجيل من خلال تحديد القيم في الملف للخصائص التالية:

يتم تخصيص مستوى لكل من أدوات التسجيل في ملف log4j.properties. اذا لم تقم بتخصيص مستوى لأداة التسجيل، فسيقوم log4j آليا بتخصيص المستوى لأداة التسجيل الرئيسية وذلك لأدوات التسجيل الغير مخصصة. وبصفة مفترضة، يتم تخصيص المستوى WARN لأداة التسجيل.

يمكنك توصيف ملف log4j.properties باستخدام محددات مختلفة لأدوات التسجيل، وأدوات الالحاق، والشكل العام. ويجب أن يكون الملف log4j.properties متاح للتطبيق أثناء التشغيل من مسار الفئة. ويمكنك التعقيب على الادخالات في ملف النموذج من خلال بدء العبارة بالرمز (#). الادخالات التي يتم تعليمها بالرمز (#) يتم تخطيها أثناء التشغيل.

لفتح الملف log4j.properties، اذهب الى الحافظةier_install_path\RecordsManagerSweep، ثم قم بفتح الملف باستخدام برنامج تحرير النصوص.

قم بتحديد أداة التسجيل ومستوى التسجيل

ويجب أن تقوم أولا بتحديد أداة التسجيل. ويمكن أن يكون لديك عدد من أدوات التسجيل لتصنيف نوع التسجيل المطلوب للتطبيق. لاتاحة التسجيل لكل الفئات من ‏‎com.filenet.rm‎‏ ومجموعات البرامج الفرعية الخاصة بها، قم بتحديد أداة التسجيل كما هو موضح في العبارة التالية:

log4j.logger.com.filenet.rm 

أو يمكنك تحديد أي اسم لأداة التسجيل. على سبيل المثال، يمكنك تسمية أداة التسجيل APILOG الخاصة بك كما هو موضح في العبارة التالية:

‏‎log4j.logger.com.filenet.rm=warn, APILOG‎‏

يجب أن تقوم بتحديد مستوى التسجيل لبدء مستوى التفاصيل للرسائل التي يتم تسجيلها من خلال log4j أثناء التشغيل. ويدعم log4j خمس مستويات من التسجيل كما هو موضح في الجدول التالي:

جدول 1. مستوى الرسائل التي يتم تسجيلها بواسطة log4j أثناء التشغيل
المستوى الوصف
DEBUG يحدد أحداث اعلامية غنية والتي يمكن الاستفادة منها بأقصى درجة في تصحيح الأخطاء الخاصة بالتطبيق.
INFO تحدد الرسائل الاعلامية التي تقوم باظهار التطور في التطبيق على مستوى رديء.
WARN يحدد المواقف الخطرة المحتملة.
ERROR يحدد أحداث الخطأ التي قد تسمح للتطبيق بالاستمرار في التشغيل.
FATAL يحدد أحداث الخطأ الجسيم التي قد تتسبب في توقف التطبيق عن العمل.

أنظر مطبوعات log4j الفنية على موقع Apache على الانترنت للتعرف على المزيد من المعلومات عن مستويات التسجيل الخاصة والمهيأة. ويصفة مفترضة، يتم بدء التطبيق في المستوى WARN. يمكن تعديل هذا المستوى الى DEBUG أو INFO أو ERROR أو WARN أو FATAL أثناء التشغيل. ويمكن أيضا تضمين العديد من عبارات أداة التسجيل، كل لنفس أداة التسجيل ولكن بمستويات مختلفة (مثل DEBUG لأحدها، و WARN لآخر). ويمكنك تعليق أحد أجزاء ملف النموذج من خلال اسباق العبارة بالرمز (#). قم قم بالتبديل، كما يلزم، بين مستويات DEBUG و WARN. الادخالات التي يتم تعليمها بالرمز (#) يتم تخطيها أثناء التشغيل. وأي أداة التسجيل تفتقد لأحد المستويات ستقوم بتوارث المستوى الخاص بأداة التسجيل الرئيسية. وبصفة مفترضة، يتم تخصيص المستوى WARN لأداة تسجيل API في IBM Enterprise Records.

تحديد أدوات الالحاق

يتم ارفاق أداة التسجيل مع واحد أو أكثر من أدوات الالحاق لاتاحة كتابة الرسائل التي يتم تسجيلها في وسط المخرجات. ويمكن أن تقوم بتحديد أنواع مختلفة من أدوات الالحاق بالملف ‏‎log4j.properties‎‏الذي يقوم بارسال معلومات السجل الى مكان المخرجات المحدد. الجدول التالي يقدم كشف بكل أدوات الالحاق التي يتم استخدامها في الملف ‏‎log4j.properties‎‏ مع وصف وصف مختصر والاختيارات المتعلقة.

جدول 2. أدوات الالحاق، والوصف، ومقاطع الكود
أداة الالحاق الوصف ومقاطع الكود
NTEventLogAppender

للالحاق الى Microsoft Windows NT Event Log. ويمكن تركيب أداة الالحاق هذه واستخدامها في نظام Windows فقط.

‏‎log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender‎‏
ConsoleAppender

لالحاق رسائل السجل بالملف ‏‎System.out‎‏ (وهو المفترض) أو ‏‎System.err‎‏ باستخدام الشكل العام الذي يتم تحديده من خلال المستخدم.

 ‏‎log4j.appender.APILOG=org.apache.log4j.ConsoleAppender‎‏

الاختيارات:

  • Threshold=WARN: لا تقوم أداة الالحاق هذه بتسجيل أي رسائل بأولوية أقل من ما هو محدد هنا حتى اذا تم تحديد الأولوية بمستوى أقل. وهذه المحددات تفيد في تقليل عدد الرسائل، على سبيل المثال، في سجل الملف بينما يتم عرض كل الرسائل على شاشة التحكم الرئيسية.
  • ImmediateFlush=true: المحددات المفترضة هي true، وتعني أنه لن يتم تسجل رسائل سجل الأخطاء في التخزين الوسيط أبدا. واذا تم تحديد ImmdiateFlush بالقيمة false، فلن يتم كتابة أحداث السجل القليلة الأخيرة في وسط التخزين الثابت عند حدوث مشكلة في التطبيق.
FileAppender

لالحقا رسائل السجل الى أحد الملفات.

 log4j.appender.APILOG=org.apache.log4j.FileAppender

الاختيارات:

  • Threshold=WARN: لا تقوم أداة الالحاق هذه بتسجيل أي رسائل بأولوية أقل من ما هو محدد هنا حتى اذا تم تحديد الأولوية بمستوى أقل. تكون هذه المحددات مفيدة لتقليل عدد الرسائل، على سبيل المثال، في سجل الملف أثناء عرض كل الرسائل في شاشة التحكم الرئيسية.
  • ImmediateFlush=true: المحددات المفترضة هي true، وتعني أنه لن يتم تسجل رسائل سجل الأخطاء في التخزين الوسيط أبدا. واذا تم تحديد ImmdiateFlush بالقيمة false، فلن يتم كتابة أحداث السجل القليلة الأخيرة في وسط التخزين الثابت عند حدوث مشكلة في التطبيق.
  • File=mylog.txt: اسم الملف الذي سيتم التسجيل فيه. يمكن استخدام ${some_property_key} (على سبيل المثال، خاصية النظام ‏‎java.home‎‏ أو ‏‎user.home‎‏) لتحديد المسار.
  • Append=false: بصفة مفترضة يتم تحديدها بالقيمة true، والتي تعني الالحاق في نهاية الملف. القيمة False تقوم باحلال الملف في بداية كل من برامج التشغيل.
RollingFileAppender

لتمديد FileAppender لعمل نسخة احتياطية من ملفات السجل عند وصولها الى مستوى معين.

 ‏‎log4j.appender.APILOG=org.apache.log4j.RollingFileAppender‎‏

الاختيارات:

  • Threshold=INFO: لا تقوم أداة الالحاق هذه بتسجيل أي رسائل بأولوية أقل من ما هو محدد هنا حتى اذا تم تحديد الأولوية بمستوى أقل. تكون هذه المحددات مفيدة لتقليل عدد الرسائل، على سبيل المثال، في سجل الملف أثناء عرض كل الرسائل في شاشة التحكم الرئيسية.
  • ImmediateFlush=true: المحددات المفترضة هي true، وتعني أنه لن يتم تسجل رسائل سجل الأخطاء في التخزين الوسيط أبدا. واذا تم تحديد ImmdiateFlush بالقيمة false، فلن يتم كتابة أحداث السجل القليلة الأخيرة في وسط التخزين الثابت عند حدوث مشكلة في التطبيق.
  • File=mylog.txt: اسم الملف الذي سيتم التسجيل فيه. يمكن استخدام ${some_property_key} (على سبيل المثال، خاصية النظام ‏‎java.home‎‏ أو ‏‎user.home‎‏) لتحديد المسار في المقدمة.
  • Append=false: بصفة مفترضة يتم تحديدها بالقيمة true، والتي تعني الالحاق في نهاية الملف. القيمة false تقوم باحلال الملف في بداية كل من برامج التشغيل.
  • MaxFileSize=100 KB: اللاحقات يمكن أن تكون KB أو MB أو GB. لتدوير ملف السجل هذا بعد أن الوصول الى هذا الحجم. عملية الالحاق تأخذ قيمة بوولية تحدد ما اذا كانت ملفات المخرجات سيتم اعادة الكتابة عليها (false) أو الحاقها (true). بتحديد القيمة الى false (المفترض) يتم المحافظة على الملفات من أن تزيد عن الحدود. ويمكن استخدام هذه المحددات في بيئة التطوير حيث تريد اجراء عمليات تشغيل عرضية. بتحديد القيمة الى true يتم الحاق المخرجات الى أحد ملفات المخرجات الموجودة عند كل مرة يتم فيها تشغيل JVM. ويمكنك الحد من حجم ملف المخرجات من خلال تحديد MaxFileSize. على سبيل المثال، اذا قمت بتوصيف ملف مخرجات، cjapi_log.txt، مع MaxFileSize=128 KB و MaxBackupIndex=1، عند تجاوز الملف 128 كيلوبايت، سيتم نقل المحتويات الخاصة به آليا الى cjapi_log.txt.1. الاستمرار في الكتابة الى ملف خالي cjapi_log.txt.
  • MaxBackupIndex=2: يقوم بالاحتفاظ بالحد الأقصى من 2 (على سبيل المثال) من ملفات النسخة الاحتياطية. وسيتم محو الملفات القديمة. 0 تعني أنه لن يتم الاحتفاظ بملفات النسخة الاحتياطية.

تحديد الشكل العام

يمكنك تحديد أشكال عامة مختلفة في الملف log4j.properties الذي يحدد نسق رسالة السجل. يمكنك تحديد أن رسائل السجل تتضمن التاريخ والوقت واسم وحدة البرامج واسم سلسلة العمليات ومعلومات أخرى. يتم استخدام محددات التوصيف هذه عند التشغيل أثناء تسجيل الرسالة.

الجدول التالي يقدم كشف بكل الأشكال العامة التي يتم استخدامها في IBM Enterprise Records الملف ‏‎log4j.properties‎‏ مع وصف وصف مختصر والاختيارات المتعلقة.

جدول 3. الأشكال العامة والوصف
الشكل العام الوصف ومقطع الكود
SimpleLayout

لطباعة المستوى، ثم شرطة (-) متبوع بنص رسالة السجل.

‏‎org.apache.log4j.SimpleLayout‎‏
PatternLayout

النسق تقوم بتسجيل الأحداث طبقا لنموذج التحويل المحدد. تتكون نماذج التحويل من نص حرفي ومحددات التحويل. النص الحرفي يمثل المخرجات كما هي. محددات التحويل تتكون من الحرف % متبوع بأحد أدوات التعديل للنسق الاختياري وحرف التحويل الالزامي. على سبيل المثال، %-5p [%t]: %m%n هو نموذج التحويل المكون من محدد تحويل الأولوية متبوع بنص أبجدي " [". ويتم اتباع مجموعة الحروف هذه بمحدد تحويل سلسلة العمليات، متبوع بنص أبجدي "]: ". ويتم اتباع مجموعة الحروف هذه بمحدد تحويل الرسالة وسطر فاصل يتوقف على النظام.

‏‎org.apache.log4j.PatternLayout‎‏

الاختيارات:

  • ConversionPattern=%-5p, [%t]:%m%n: كيفية تنسيق كل من رسائل السجل (ما هي المعلومات التي سيتم تضمينها).
HTMLLayout

لتنسيق المخرجات كجدول HTML.

‏‎org.apache.log4j.HTMLLayout‎‏

الاختيارات:

  • LocationInfo=true: اسم ملف المخردات Javaâ ورقم السطر. القيمة المفترضة هي false.
  • Title=My app title: يحدد شارة <title> من HTML. المحددات المفترضة هي is Log4J Log Messages.
 

لتنسيق المخرجات في صورة HTML.

‏‎org.apache.log4j.xml.XMLLayout‎‏

الاختيارات:

  • LocationInfo=true: اسم ملف المخردات Java ورقم السطر. القيمة المفترضة هي false.

الملف ‏‎ log4j.properties‎‏ الذي يتم تحديده من خلال IBM Enterprise Records يقوم باستخدام PatternLayout لنسق رسالة السجل. الجدول التالي يحدد كشف بنماذج التحويل التي يمكن نشرها في ملف التوصيف مع الوصف المختصر الخاص بها.

جدول 4. نماذج التحويل والوصف
النموذج الوصف
%t اسم سلسلة العمليات التي تشكل طلب السجل
%c اسم أداة التسجيل الخاصة بطلب السجل
%-60c يتم محاذاة أسم أداة التسجيل جهة اليسار بحد أدنى 69 مسافة
%r عدد الملي ثانية المنقضية منذ بدء التطبيق
%p مستوى عبارة السجل
%m ‏الرسالة‏
%Time الوقت الذي سيتم به التسجيل
%d تاريخ تسجيل الحدث
%n سطر جديد

عبارة الكود التالية توضح كيفية اتاحة PatternLayout وتحديد نموذج تحويل بسيط:

‏‎log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout‎‏
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n

على سبيل المثال:

WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 102042, [setLoggerMessage]
WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 102342, [setLoggerMessage]


التعليق التقييمي

آخر تحديث: نوفمبر، 2013
configure_rm_logging‏‎.htm‎‏

© .IBM حقوق النشر لشركة 2013