تمكين سجلات NSO والسمات

المقدمة

يصف هذا المستند مختلف السجلات المتوفرة في NSO وما يتم إستخدامه له وكيفية تمكينها.

المتطلبات الأساسية

المتطلبات

لعرض السجلات وتمكينها وتعيينها، تحتاج إلى مستخدم لديه حق الوصول إلى بيئة المضيف التي تقوم بتشغيل خدمة NSO، بالإضافة إلى الوصول إلى واجهة سطر الأوامر (CLI) الخاصة ب NSO ومنفذ NSO IPC.

المكونات المستخدمة

Cisco Crosswork Network Service Orchestrator (NSO)، الإصدار 6.4.1

تمت كتابة هذا المستند لخيارات التسجيل المتوفرة اعتبارا من NSO 6.4. بينما تنطبق معظم المعلومات الواردة في هذا المستند عبر الإصدارات، يمكن إهمال بعض السجلات أو إضافتها مقارنة بالإصدار الذي تستخدمه. لا يغطي هذا المستند التكوين اللازم لتصدير السجلات خارج نظام NSO.

تفترض الأوامر المقدمة في هذا المستند وجود NSO لتثبيت النظام باستخدام إعداد الدليل الافتراضي. في بيئتك، يمكن أن تختلف أماكن ملفات معينة.

• ncs.conf يستطيع كنت أسست في $NCS_CONFIG_DIR، افتراضيا /etc/ncs/ncs.conf
• يمكن العثور على السجلات في $NCS_LOG_DIR، بشكل افتراضي /var/log/ncs/
• يتم تثبيت NSO بالمبلغ $NCSDIR، بشكل افتراضي /opt/ncs/
• دليل تشغيل NSO هو $NCS_RUN_DIR، بشكل افتراضي /var/opt/ncs/

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

إرشادات السجل العام

تأثير التسجيل

قد يؤدي تمكين السجلات ذات السعة الزائدة إلى زيادة الأحمال ومتطلبات مساحة القرص لخادم NSO. وهذا إعتبار خاص للسجلات عالية النشاط مثل devel.log. لا يشكل تمكين الاتساع لفترات قصيرة من الوقت أثناء أستكشاف المشكلات وحلها مصدر قلق بشكل عام، ولكن تأكد من أخذ الموارد ومساحة القرص بعين الاعتبار عند تمكينها لفترات أطول من الوقت.

إنشاء تقرير فني

To generate a tech report for NSO, run the script at /opt/ncs/current/bin/ncs-collect-tech-report.

خيارات:
--install-dir : يحدد دليل تثبيت ملفات NCS الثابتة، مثل خيار — install-dir في المثبت.

--full : يجمع نسخة إحتياطية من NCS من النظام، مما يسهل على دعم Cisco تكرار أي أخطاء.

--num-debug-dumps : افتراضي 1، يولد لقطة تفريغ تصحيح. بالنسبة للحالات التي تتعقب تسريبات الموارد، مثل تسريبات واصف الذاكرة/الملفات، قم بتعيين هذا على 3.

الخيارات الموصى بها:
/opt/ncs/current/bin/ncs-collect-tech-report --num-debug-dumps 3

يمكن تجميع نسخة إحتياطية وتوفيرها بشكل منفصل للحد من حجم ملف الحزمة لتسهيل عمليات التحميل.

يتم إنشاء التقرير الفني في الدليل الحالي الذي يتم تشغيل البرنامج النصي منه.

ملاحظة: يجمع تقرير فني محتوى دليل سجل NSO. تحقق من أن هذا الدليل لا يحتوي على أية تقارير فنية أو نسخ إحتياطية سابقة قبل إنشاء التقرير الفني الجديد.

إنشاء نسخة إحتياطية

/opt/ncs/current/bin/ncs-backup

يتم إنشاء النسخ الاحتياطية في /var/opt/ncs/backups/.

ملفات السجل التي لم يتم إنشاؤها

عند أرشفة ملف السجل أو حذفه، يحتاج NSO إلى إنشاء ملف جديد. عادة ما يحدث هذا تلقائيا، ولكن في حالة عدم حدوث ذلك، أستخدم الأمر:
/opt/ncs/current/bin/ncs_cmd -c reopen_logs.

ملاحظة: عند تقييد الوصول إلى منفذ IPC، على سبيل المثال، باستخدام إعداد الوصول إلى IPC في ncs.conf، تأكد من تحديد المتغيرات الضرورية كجزء من cron أو anacron حتى يمكن أن يعيد دوران السجل الأسبوعي فتح السجلات بشكل صحيح.

نظرة عامة على السجلات

• السجلات الداخلية ل NSO
  • ncs.log: يقوم سجل NCS بتسجيل العملية الرئيسية ل NSO. وعلى الرغم من أن هذا المحول يحتوي على معلومات عميقة محدودة، إلا أنه يمكن إستخدامه للمشكلات التي تتضمن إيقاف التشغيل وبدء التشغيل وتحميل الحزم والترقيات.
  • audit.log: يقوم سجل التدقيق بتسجيل أي مستخدمين يقومون بالمصادقة على NSO من خلال أي واجهة برمجة تطبيقات. كما أنها تسجل أي نشاط على واجهة سطر الأوامر (CLI) الخاصة بوحدة التخزين المتصلة بالشبكة (NSO) والواجهات الشمالية منخفضة السرعة.
  • التزام سجل التدقيق : يؤدي تمكين هذا الإعداد إلى تحسين التدقيق.log. لا يقوم بإنشاء سجله الخاص. وهو يقوم بتسجيل جميع التغييرات غير الافتراضية في NSO CDB أثناء عمليات الالتزام والمزامنة من.
  • افتراضيات سجل التدقيق : يؤدي تمكين هذا الإعداد إلى تحسين التدقيق.log. لا يقوم بإنشاء سجله الخاص. وهو يقوم بتسجيل كافة التغييرات الافتراضية على NSO CDB أثناء عمليات الالتزام والمزامنة من.
  • devel.log: يقوم سجل البيانات بتسجيل العمليات العامة وتدفقات سير العمل ل NSO. 
  • ncs-java-vm.log: يسجل سجل جافا كل العمليات المتعلقة ب java-vm. وأبرز ما في الأمر هو أي برنامج تشغيل لعناصر الشبكة (ED) وحزم خدمات مكتوبة في Java. كل واجهة سطر الأوامر CLI NED مكتوبة في Java. 
  • ncs-python-vm.log: يقوم سجل python بتسجيل النشاط المتعلق بحزم الخدمة المكتوبة في Python. يتم إنشاء سجل بيثون منفصل لكل حزمة خدمة مكتوبة ببايثون. ما من NEDs مكتوب ببايثون. 
  • upgrade.log: يقوم سجل الترقية بتسجيل التغييرات في طرز NSO أثناء ترقيات NSO، بما في ذلك ترقيات إصدار NSO وترقيات حزمة NSO أثناء إعادة تحميل الحزم. 
  • قالب.log: سجل مخصص لمجموعات NSO التي تستفيد من إمكانيات HA-RAFT. 
  • خرج HA-Raft EPMD: هذا الإخراج ليس سجل NSO تقليدي، حيث يتم إستخدام EPMD في HA-Raft للمساعدة في اكتشاف العقد. توضح هذه التعليمات كيفية الحصول على معلومات تصحيح الأخطاء ل EPMD.
  • تسجيل EPMD: تمت إضافة إدخالات تسجيل إضافية لوظائف HA-Raft.
  • xpath.trace: يقوم تتبع XPath بتسجيل كافة تقييمات XPath التي تقوم بها NSO. يمكن أن يكون هذا مفيدا لمعرفة لماذا تستغرق عملية الحذف وقتا طويلا. 
  • ncserr.log: ال ncserr.log هو ثنائي سجل سجل خطأ ل داخلي عملية من ال ncs مادة حفازة. إلزامي لأي رسائل خطأ 'داخلي' تقريبا وسيناريوهات عطل. 
  • transerr.log: سجل أخطاء المعاملة هو سجل لجمع المعلومات عن الحركات الفاشلة التي تؤدي إلى خطأ في تشغيل CDB أو فشل في حركة وقت التشغيل.
  • التقدم.التتبع: يتم إستخدام تتبع التقدم لتعقب أحداث التقدم المنبعثة من الحركات والإجراءات الموجودة في النظام. ما هي البيانات التي سيتم إرسالها تم تكوينها في /progress/trace.
  • ncs-smart-licensing.log: سجلات العميل الذكي للترخيص داخل NSO.
• Northbound: الوصول إلى وحدة التخزين المتصلة بالشبكة من العناصر المتجهة شمالا
  • audit.log: يتم تنفيذ أوامر سجل التدقيق على واجهة سطر الأوامر (CLI) الخاصة ب NSO.
  • localhost:8080.access/localhost:8888.access : هذا هو سجل الوصول لخادم الويب المضمن ويجمع نشاط HTTP. يلتزم هذا الملف بتنسيق السجل الشائع، كما هو معرف بواسطة Apache
  • حركة المرور.trace: يجمع هذا السجل حركة مرور HTTP عالية السرعة. استخدمه لتصحيح أخطاء Restconf و json-rpc API. 
  • netconf.log: سجل ل NetConf API 
  • netconf-trace.log: سجل للحصول على واجهة برمجة تطبيقات NetConf عالية السرعة
  • json-rpc.log: سجل ل json-rpc.log API
• ساوثد: تسجيل الاتصال الانتقال من NSO إلى الشبكة.
  • تتبع DDoS للجهاز: يولد كل جهاز آثاره الخاصة. تم تسمية عمليات تعقب الأجهزة باسم NED-<ned-id>-<devicename>.trace أو netconf-<devicename>.trace
  • audit-network.log: أوامر تكوين السجلات التي يتم إرسالها بواسطة NSO إلى الأجهزة المرتبطة بالجنوب.
• سجلات النظام
  • سجلات لينوكس: يتم العثور عليها بشكل نموذجي في /var/log/ وتتضمن سجلات مثل الرسائل أو syslog. وتختلف هذه العناصر باختلاف المضيف.
  • ncs_crash.dump: تم إنشاء عملية تفريغ نظام NSO عند انتهاء NSO بسبب مشاكل في الذاكرة.
  • تفريغ اللب: عند إنهاء NSO لأسباب غير متعلقة بالذاكرة، يمكن أن يقوم Linux بإنشاء تفريغ أساسي يسمى Core.<PID>

يلزم الوفاء بشروط معينة لنظام التشغيل Linux لإنشاء تفريغ للمراكز. تكوين الحد الأقصى هو الإعداد الأكثر شيوعا الذي يمنع التفريغ. راجع صفحة دليل لينوكس للحصول على قائمة كاملة بالمتطلبات

ملاحظة: لا يتم تجميع سجلات النظام بواسطة التقرير الفني ل NCS، ولكن يمكن أن تكون مفيدة للأداء والمشكلات المتعلقة بالتعطل.

تمكين السجلات وإعداد الإطالة

ملاحظة: يتم تطبيق تغيير إعدادات التكوين في ملف ncs.conf من خلال تنفيذ الأمرncs --reload. ncs --reload, it يعيد تحميل القيم من ملف ncs.conf ويحدث النظام الجاري، وكذلك يغلق ويعيد فتح كل ملفات السجل بحيث يتم تطبيق أي تغييرات في التسجيل. لا يؤدي هذا إلى مقاطعة الخدمات.

إرشادات عامة

• عندما لا يكون تكوين محدد موجودا في ملف ncs.conf، يتبنى NSO السلوك الافتراضي كما هو محدد في /opt/ncs/current/src/ncs/ncs_config/tailf-ncs-config.yang الملف.
• عندما يتم تحديد سجل على أنه ممكن بشكل افتراضي، فهذا يعني أن السجل ممكن حتى إذا كان التكوين المطلوب تمكينه مفقودا.
• يتم تعطيل بعض السجلات بشكل افتراضي، ولكن خلال التثبيت الأول ل NSO، تحتوي NCS.conf على إرشادات محددة لتمكين السجل.
• عندما لا يكون تشكيل خاص موجود في ال ncs.conf مبرد، أنت يستطيع أضفت التشكيل كما هو موضح تحت ال، logs container، يعني بين   وفي   ال ncs.conf مبرد. 

داخلي

ncs.log

مكنت هذا سجل افتراضيا. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وقم بتغيير محتوى <ncs-log>.

  true
  
    ${NCS_LOG_DIR}/ncs.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

audit.log

مكنت هذا سجل افتراضيا. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

عمليات الالتزام بسجل المراجعة وعمليات الالتزام بسجل التدقيق الافتراضية

لم يتم تمكين هذا السجل بشكل افتراضي. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وأضف المحتوى بعد <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

true
true

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

devel.log

يتم تمكين هذا السجل بشكل افتراضي في INFO. لتمكين وتغيير الإتجاه لهذا السجل، افتح /etc/ncs/ncs.conf وقم بتغيير محتوى <Developer-log>.

  true
  
    ${NCS_LOG_DIR}/devel.log
    true 
   

trace

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

ncs-java-vm.log

يتم تمكين هذا السجل بشكل افتراضي في INFO. من الممكن ضبط الإتجاه للعناصر الفردية المدارة بواسطة Java-vm. يتم تغيير الإتجاه من واجهة سطر الأوامر (CLI) الخاصة بوحدة التحكم في الشبكة (NSO) التي يمكن الوصول إليها من خلال بروتوكول SSH أو NCS_CLI -C -noaaa

لزيادة الإتجاه عبر كافة عناصر Java تحت com.tailf:

التكوين
Java-vm Java-logging logging com.tailf level-trace
عدم الربط الشبكي

لزيادة الإتجاه لحزمة محددة من محلول NED:

التكوين

مسجل Java-vm Java-logging com.tailf.packages.ned.<NED-name> level-trace

عدم الربط الشبكي

لزيادة تردد عميل SSHJ المستخدم في حزم Java NED:

التكوين

Java-vm Java-logging Logger net.schmizz.sshj level-error

عدم الربط الشبكي

ملاحظة: توصي Cisco بتعيين التسجيل لعميل SSHJ إلى مستوى الخطأ. هو معأق افتراضيا.

لعكس تسجيل عنصر جافا محدد:

التكوين

لا يوجد مسجل Java-vm Java-logging com.tailf

عدم الربط الشبكي

لعرض إعدادات تسجيل الدخول الحالية الخاصة ب Java-VM:

show running-config java-vm java-logging

ncs-python-vm.log

يتم تمكين هذا السجل بشكل افتراضي في INFO. يتم تغيير الإتجاه من واجهة سطر الأوامر (CLI) الخاصة بواجهة مستخدم واجهة سطر الأوامر (NSO) التي يمكن الوصول إليها من خلال بروتوكول SSH أو NCS_CLI -C -noaaa.

لتعيين الإتجاه لسجلات كافة الأجهزة الافتراضية الخاصة ب Python.

التكوين
تصحيح أخطاء مستوى تسجيل بايثون-vm
عدم الربط الشبكي

للعودة:
التكوين
لا يوجد تصحيح مستوى تسجيل Python-VM
عدم الربط الشبكي

لعرض إعدادات تسجيل الدخول الحالية ل Python-VM:
show running-config python-vm logging

upgrade.log

مكنت هذا سجل افتراضيا. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وقم بتغيير محتوى <upgrade-log>.

  true
  
    ${NCS_LOG_DIR}/upgrade.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

طوف.لوغ

يتم تمكين هذا السجل بشكل افتراضي في INFO. لتمكين هذا السجل وتعيينه، افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <raft-log>.

  true
  
    ${NCS_LOG_DIR}/raft.log
    true 
   
  trace

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

خرج HA-Raft EPMD

هذا الإخراج غير ممكن بشكل افتراضي ولا يكتب إلى ملف سجل. بدلا من ذلك يكتب إلى محطة طرفية.

1. إيقاف كافة مثيلات NSO
   systemctl stop ncs.service
2. فتح محطة طرفية جديدة وإيقاف EPMD وبدء EPMD في وضع تصحيح الأخطاء
   epmd -kill epmd -d
   
3. بدء NSO
   systemctl start ncs.service
4. إنتاج الإصدار. تعرض المحطة الطرفية بيانات تصحيح أخطاء EPMD.

xpath.trace

لم يتم تمكين هذا السجل بشكل افتراضي. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <xpath-trace-log>.

  true
  ${NCS_LOG_DIR}/xpath.trace

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

ncserr.log

يقوم هذا السجل بتسجيل كمية محدودة من المعلومات. يحتفظ NSO ب 5 ملفات أخطاء، يبلغ الحد الأقصى لحجم كل منها 1 ميجابايت بشكل افتراضي. في الحالة النادرة التي تحدث فيها مشكلة تنشئ أكثر من 5 ميجابايت في بيانات السجل، يلزمك زيادة الحد الأقصى للحجم. مكنت هذا سجل افتراضيا. لتغيير الحد الأقصى لحجم هذا السجل إلى 10 ميجابايت لكل ملف، افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <error-log>.

  true
  ${NCS_LOG_DIR}/ncserr.log
  S10M

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

transerr.log

لا يمكن هذا سجل افتراضيا، غير أن يمكن في ncs.conf على أول تثبيت. لتمكين هذا السجل افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <transaction-error-log>.

  true
  ${NCS_LOG_DIR}/transerr.log

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

تقدم.تتبع

لا يمكن هذا سجل افتراضيا، غير أن يمكن في ncs.conf على أول تثبيت. لتمكين هذا السجل افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <progress-trace>.

  true
  ${NCS_LOG_DIR}

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

ncs-smart-licensing.log

لم يتم تمكين هذا السجل بشكل افتراضي. يتم تمكين السجل من واجهة سطر الأوامر (CLI) عبر واجهة سطر الأوامر (NSO) التي يمكن الوصول إليها من خلال SSH أو NCS_CLI -C -noaaa. لتمكين هذا السجل:

التكوين

تم تمكين Smart-License Smart-License Stdout-capture

عدم الربط الشبكي

لإرجاع تغيير التسجيل:

التكوين

لم يتم تمكين ميزة Smart-License Smart-Agent Stdout-capture

عدم الربط الشبكي

نورثبند

localhost:xxxx.access

مكنت هذا سجل افتراضيا. يختلف اسم هذا السجل بناء على منفذ HTTP. بشكل افتراضي 8080 و 8888. لتمكين هذا السجل افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <webui-access-log>.

  true
  ${NCS_LOG_DIR}

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

حركة المرور.التتبع

لم يتم تمكين هذا السجل بشكل افتراضي. يتم إنشاء سجلات حركة المرور.trace في دليل مثل /var/log/ncs/trace_20240628_010010/. لتمكين هذا السجل افتح /etc/ncs/ncs.conf ثم قم بتغيير محتوى <webui-access-log>.

  true
  ${NCS_LOG_DIR}
  true

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

netconf.log

مكنت هذا سجل افتراضيا. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وأضف المحتوى بعد <netconf-log>.

  true
  
    ${NCS_LOG_DIR}/netconf.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload

خيار إضافي: إدراج true بعد  أن يقوم NSO بتسجيل حالة الرد على rpc "ok" أو "error".

netconf-trace.log

لم يتم تمكين هذا السجل بشكل افتراضي. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وقم بتغيير محتوى <netconf-trace-log>.

  true
  ${NCS_LOG_DIR}/netconf-trace.log

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

json-rpc.log

لم يتم تمكين هذا السجل بشكل افتراضي. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وأضف المحتوى بعد <jsonrpc-log>.

  true
  
    ${NCS_LOG_DIR}/json-rpc.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.

ساوثد

تتبع DD للجهاز

لم يتم تمكين هذا السجل بشكل افتراضي. يتم تمكين السجل من واجهة سطر الأوامر (CLI) عبر واجهة سطر الأوامر (NSO) التي يمكن الوصول إليها من خلال SSH أو NCS_CLI -C -noaaa.

لتمكين تتبع لجهاز:

التكوين
أداة <deviceName> تتبع الخام
تصحيح أخطاء مستوى مسجل الأجهزة <DeviceName> Ned-Settings <ned-id>
عدم الربط الشبكي

لعرض جميع إعدادات السجل المطبقة على جهاز ما، أستخدم الإعدادات النشطة لجهاز العرض <deviceName>.

لمسح محتوى ملف تتبع أجهزة، أستخدم أداة <deviceName> clear-trace.

لتعطيل تتبع الجهاز:

التكوين

لا يوجد جهاز تتبع <deviceName>

عدم الربط الشبكي

audit-network.log

لم يتم تمكين هذا السجل بشكل افتراضي. لتمكين هذا السجل، افتح /etc/ncs/ncs.conf وأضف المحتوى بعد <audit-network-log>.

  true
  
    ${NCS_LOG_DIR}/audit-network.log
    true 
   

بعد تحرير ncs.conf، قم بتنفيذ NCS —reload.