IBM Enterprise Records, النسخة 5.1.+            

توصيف الملف ‏‎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.rmor‎‏ 

ويمكن تحديد أي اسم لأداة التسجيل. على سبيل المثال، يمكنك تسمية أداة التسجيل 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 لأداة التسجيل RM 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=100KB: اللاحقات يمكن أن تكون KB أو MB أو GB. لتدوير ملف السجل هذا بعد أن الوصول الى هذا الحجم. الالحاق يقوم باستخدام القيمة البوولية التي تحدد ما اذا كانت ملفات المخرجات سيتم احلالها (false) أو الحاقها (true). تحديد القيمة الى false (المفترض) للمحافظة على المفات من التزايد أكثر من الحدود، وهذا هو المفضل بالنسبة الى بيئات التشغيل الخاصة بالتطوير والتي يتم فيها التشغيل لمرة واحدة بالصدفة. بتحديد القيمة الى true يتم الحاق المخرجات الى أحد ملفات المخرجات الموجودة عند كل مرة يتم فيها تشغيل JVM. ويمكن الحد من حجم ملف المخرجات من خلال تحديد الكلمة المرشدة MaxFileSize. على سبيل المثال، اذا تم توصيف أحد ملفات المخرجات، ‏‎cjapi_log.txt‎‏، باستخدام MaxFileSize=128KB و MaxBackupIndex=1، فعند تجاوز الملف للحجم 128 كيلوبايت، يتم نقل المحتويات الخاصة به آليا الى ‏‎cjapi_log.txt.1‎‏ وتستمر الكتابة الى ملف ‏‎cjapi_log.txt.file‎‏ خالي.
  • MaxBackupIndex=2: يقوم بالاحتفاظ بالحد الأقصى من 2 (على سبيل المثال) من ملفات النسخة الاحتياطية. ويتم محو الملف(الملفات) القديمة. 0 تعني أنه لن يتم الاحتفاظ بملفات النسخة الاحتياطية.

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

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

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

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

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

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

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

‏‎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 ضبط يسار لاسم أداة التسجيل في نطاق 60 مساحة بحد أدنى
%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]


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

آخر تحديث: August 2011


© .IBM حقوق النشر لشركة 2011.
يتم تشغيل مركز المعلومات هذا من خلال تقنيات Eclipse. ( http://www.eclipse.org )