NSO-logboeken en -woordenlijsten inschakelen

Inleiding

Dit document beschrijft de verschillende logs die beschikbaar zijn in NSO, waarvoor ze worden gebruikt en hoe ze kunnen worden ingeschakeld.

Voorwaarden

Vereisten

Om logs te bekijken, in te schakelen en in te stellen, hebt u een gebruiker nodig met toegang tot de hostomgeving waarop de NSO-service wordt uitgevoerd, evenals toegang tot de NSO CLI- en NSO IPC-poort.

Gebruikte componenten

Cisco Crosswork Network Service Orchestrator (NSO) versie 6.4.1

Dit document is geschreven voor de logboekopties die beschikbaar zijn vanaf NSO 6.4. Hoewel de meeste informatie in dit document van toepassing is op verschillende versies, kunnen sommige logs zijn verouderd of toegevoegd in vergelijking met de versie die u gebruikt. Dit document heeft geen betrekking op de configuratie voor het exporteren van logs buiten het NSO-systeem.

Opdrachten die in dit document worden gegeven, gaan uit van een NSO voor systeeminstallatie met behulp van de standaarddirectory-instelling. In uw omgeving kunnen de locaties van bepaalde bestanden verschillen.

• ncs.conf is standaard te vinden in $NCS_CONFIG_DIR, /etc/ncs/ncs.conf
• Logs zijn te vinden in $NCS_LOG_DIR, standaard /var/log/ncs/
• NSO is standaard geïnstalleerd in $NCSDIR /opt/ncs/
• De actieve directory van NSO is $NCS_RUN_DIR, standaard /var/opt/ncs/

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Algemene richtlijnen voor logbestanden

impact van de registratie

Het inschakelen van logs met een hogere breedtegraad kan leiden tot hogere belasting- en schijfruimtevereisten voor de NSO-server. Dit is vooral een overweging voor zeer actieve logs zoals devel.log. Het inschakelen van de breedsprakigheid voor korte perioden tijdens het oplossen van problemen is over het algemeen geen probleem, maar wanneer u ze voor langere perioden inschakelt, moet u rekening houden met bronnen en schijfruimte.

Het genereren van een Tech Report

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

Opties:
--install-dir : Hiermee geeft u de directory op voor de installatie van statische NCS-bestanden, zoals de optie --install-dir voor het installatieprogramma.

--full : Verzamelt een NCS-back-up van het systeem, waardoor het voor Cisco-ondersteuning gemakkelijker wordt om eventuele fouten te reproduceren.

--num-debug-dumps Standaard: 1, genereert een debug-dump momentopname. Voor gevallen waarin resource-lekken worden gevolgd, zoals lekken in geheugen/bestandsdescriptor, stelt u dit in op 3.

Aanbevolen opties:
/opt/ncs/current/bin/ncs-collect-tech-report --num-debug-dumps 3

Een back-up kan afzonderlijk worden verzameld en geleverd om de bestandsgrootte van de bundel te beperken voor eenvoudigere uploads.

Het technische rapport wordt gegenereerd in de huidige directory van waaruit het script wordt uitgevoerd.

Opmerking: Een technisch rapport verzamelt de inhoud van de NSO-logdirectory. Controleer of deze directory geen eerdere technische rapporten of back-ups bevat voordat u uw nieuwe technische rapport genereert.

Een back-up genereren

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

Back-ups worden gegenereerd in /var/opt/ncs/backups/.

Logbestanden worden niet gegenereerd

Wanneer een logbestand wordt gearchiveerd of verwijderd, moet NSO een nieuw bestand maken. Meestal gebeurt dit automatisch, maar in het geval dat dit niet het geval is, gebruik dan de opdracht:
/opt/ncs/current/bin/ncs_cmd -c reopen_logs.

Opmerking: Wanneer u de toegang tot de IPC-poort beperkt, bijvoorbeeld met behulp van de ipc-access-instelling in ncs.conf, moet u de benodigde variabelen definiëren als onderdeel van cron of anacron, zodat de wekelijkse logboekrotatie de logs op de juiste manier opnieuw kan openen.

Overzicht van logs

• Interne logs van de NSO
  • ncs.log: Het ncs-logboek registreert het hoofdproces van NSO. Het heeft beperkte diepgaande informatie, maar kan worden gebruikt voor problemen met afsluiten, opstarten, het laden van pakketten en upgrades.
  • audit.log: Het audit-logboek registreert alle gebruikers die zich via een API authenticeren op NSO. Het registreert ook elke activiteit op de NSO CLI en noordelijke interfaces met lage breedtegraad.
  • audit-log-commit: Als u deze instelling inschakelt, wordt het audit.log verbeterd. Het maakt geen eigen logboek. Het registreert alle niet-standaardwijzigingen in NSO CDB tijdens commit- en synchronisatiebewerkingen.
  • audit-log-commit-defaults: Als u deze instelling inschakelt, wordt het audit.log verbeterd. Het maakt geen eigen logboek. Het registreert alle standaardwijzigingen in NSO CDB tijdens commit- en synchronisatiebewerkingen.
  • devel.log: Het ontwikkellogboek registreert de algemene bewerkingen en workflows van NSO. 
  • ncs-java-vm.log: Het java-logboek registreert alle Java-vm-gerelateerde bewerkingen. Met name alle Network Element Driver (NED) en servicepakketten geschreven in Java. Alle CLI's zijn geschreven in Java. 
  • ncs-python-vm.log: De python logt de activiteit met betrekking tot servicepakketten geschreven in Python. Er wordt een apart pythonlog gegenereerd voor elk servicepakket dat in python is geschreven. Er zijn geen NED's geschreven in Python. 
  • upgrade.log: Het upgradelogboek registreert de wijzigingen in de NSO-modellen tijdens NSO-upgrades, inclusief upgrades van de NSO-versie en upgrades van het NSO-pakket tijdens het opnieuw laden van pakketten. 
  • raft.log: Een log specifiek voor NSO-clusters die gebruikmaken van de HA-Raft-mogelijkheden. 
  • HA-raft EPMD-uitvoer: Deze uitvoer is geen traditioneel NSO-log, EPMD wordt gebruikt in HA-raft om de ontdekking van knooppunten te helpen. In deze instructies wordt uitgelegd hoe u foutopsporingsinformatie voor EPMD kunt krijgen.
  • epmd-logboekregistratie: extra logboekvermeldingen toegevoegd voor HA-Raft-functionaliteit.
  • xpath.trace: De xpath-trace registreert alle xpath-evaluaties die de NSO uitvoert. Dit kan handig zijn om erachter te komen waarom een verwijderbewerking lang duurt. 
  • ncserr.log: De ncserr.log zijn binaire logs die fouten registreren voor interne processen van de NCS-daemon. Verplicht voor bijna alle 'interne foutmeldingen' en crashscenario's. 
  • transer.log: Het transactiefoutlogboek is een logboek voor het verzamelen van informatie over mislukte transacties die leiden tot een opstartfout van de CDB of een mislukte runtime-transactie.
  • progress.trace: De progress trace wordt gebruikt voor het traceren van gebeurtenissen die voortkomen uit transacties en acties in het systeem. Welke gegevens moeten worden verzonden, wordt geconfigureerd in /progress/trace.
  • ncs-smart-licensing.log: logbestanden voor de licentie smart-agent binnen NSO.
• Noordwaarts: Aankomst bij NSO vanuit noordelijke elementen
  • audit.log: de opdrachten voor het auditlogboek die worden uitgevoerd op de NSO-CLI.
  • localhost:8080.access/localhost:8888.access: Dit is een toegangslogboek voor de ingesloten webserver en verzamelt HTTP-activiteiten. Dit bestand voldoet aan de Common Log Format, zoals gedefinieerd door Apache
  • traffic.trace: Dit logboek verzamelt HTTP-verkeer met zeer hoge breedtegraad. Gebruik het om te debuggen Restconf en json-rpc API. 
  • netconf.log: log voor netconf API 
  • netconf-trace.log: log voor netconf-API met hoge snelheid
  • json-rpc.log: log voor json-rpc.log API
• Southbound: Logging communicatie van NSO naar het netwerk.
  • Apparaat NED-sporen: Elk apparaat genereert zijn eigen spoor. Apparaatsporen krijgen de naam ned-<ned-id>-<devicename>.trace of netconf-<devicename>.trace
  • audit-network.log: registreert configuratieopdrachten die door de NSO naar de zuidgebonden apparaten worden verzonden.
• Systeemlogboeken
  • Linux-logs: meestal te vinden op /var/log/ en bevatten logs zoals berichten of syslog. Deze variëren afhankelijk van de gastheer.
  • ncs_crash.dump: Een NSO-systeemdump die wordt gegenereerd wanneer NSO wordt beëindigd vanwege geheugenproblemen.
  • Core dump: Wanneer NSO om niet-geheugenredenen wordt beëindigd, kan Linux een core dump genereren met de naam core.<PID>

Er moet aan bepaalde voorwaarden worden voldaan om Linux een kerndump te laten genereren. De onbeperkte configuratie is de meest voorkomende instelling die een dump voorkomt. Zie Linux Manual Page voor een volledige lijst met vereisten

Opmerking: systeemlogboeken worden niet verzameld door het technische rapport van de NCS, maar kunnen nuttig zijn voor problemen met prestaties en crash.

Logs inschakelen en breedheid instellen

Opmerking: als u de configuratie-instellingen in het bestand ncs.conf wijzigt, voert u de ncs --reload opdracht uit. Hiermee worden de waarden uit het bestand ncs.conf opnieuw geladen en wordt het actieve systeem bijgewerkt. Ook worden alle logbestanden gesloten en opnieuw geopend, zodat eventuele logboekwijzigingen worden toegepast. ncs --reload, it . Dit onderbreekt de dienstverlening niet.

Algemene richtsnoeren

• Wanneer specifieke configuratie niet aanwezig is in het bestand ncs.conf, neemt NSO het standaardgedrag over zoals gespecificeerd in het /opt/ncs/current/src/ncs/ncs_config/tailf-ncs-config.yang bestand.
• Wanneer een logboek standaard is ingeschakeld, betekent dit dat het logboek is ingeschakeld, zelfs als de configuratie om het in te schakelen ontbreekt.
• Sommige logs zijn standaard uitgeschakeld, maar tijdens de eerste installatie van NSO heeft ncs.conf specifieke instructies om het log in te schakelen.
• Wanneer er geen specifieke configuratie aanwezig is in het bestand ncs.conf, kunt u de configuratie toevoegen zoals wordt weergegeven onder de logs containernaam, betekenis tussen   en   in het bestand ncs.conf. 

intern

ncs.log

Dit log is standaard ingeschakeld. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <ncs-log>.

  true
  
    ${NCS_LOG_DIR}/ncs.log
    true 
   

Na het bewerken van ncs.conf voert u ncs --reload uit.

audit.log

Dit log is standaard ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

Na het bewerken van ncs.conf voert u ncs --reload uit.

Standaard audit-log-commit en audit-log-commit

Dit log is standaard niet ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en voegt u de inhoud toe na <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

true
true

Na het bewerken van ncs.conf voert u ncs --reload uit.

devel.log

Dit log is standaard ingeschakeld bij de breedtegraad van INFO. Als u de breedtegraad voor dit log wilt inschakelen en wijzigen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <developer-log>.

  true
  
    ${NCS_LOG_DIR}/devel.log
    true 
   

trace

Na het bewerken van ncs.conf voert u ncs --reload uit.

ncs-java-vm.log

Dit log is standaard ingeschakeld bij de breedtegraad van INFO. Het is mogelijk om woordenschat in te stellen voor individuele elementen die worden beheerd door java-vm. De woordenschat wordt gewijzigd vanuit de NSO CLI die toegankelijk is via SSH of ncs_cli -C -noaaa

Om de woordenschat over alle Java-elementen onder com.tailf te vergroten:

config
Java-VM Java-logger com.tailf level-trace
commit-geen-netwerk

Om de breedsprakigheid voor een specifiek NED-pakket te vergroten:

config

java-vm java-logger com.tailf.packages.ned.<NED-name> level-trace

commit-geen-netwerk

Om de woordenschat te verhogen voor de SSHJ-client die wordt gebruikt in Java NED-pakketten:

config

Java-VM Java-Logging Logger.net.schmizz.sshj niveau-fout

commit-geen-netwerk

Opmerking: Cisco raadt aan logboekregistratie voor de SSHJ-client in te stellen op foutniveau. Het is standaard uitgeschakeld.

U kunt de logboekregistratie voor een specifiek Java-element als volgt herstellen:

config

Geen Java-VM Java-logger com.tailf

commit-geen-netwerk

U kunt de huidige instellingen voor de registratie van java-vm als volgt bekijken:

Running-config Java-VM Java-Logging weergeven

NCS-Python-VM.log

Dit log is standaard ingeschakeld bij de breedtegraad van INFO. De woordenschat wordt gewijzigd vanuit de NSO CLI die toegankelijk is via SSH of ncs_cli -C -noaaa.

Om breedsprakigheid in te stellen voor logs van alle Python-VM's.

config
Python-VM-logging level-debug
commit-geen-netwerk

Terugkeren:
config
Geen Python-VM-logging-niveaufoutopsporing
commit-geen-netwerk

De huidige instellingen voor Python-VM-logboekregistratie bekijken:
Logboekregistratie voor actieve configuratie Python-VM weergeven

upgrade.log

Dit log is standaard ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <upgrade-log>.

  true
  
    ${NCS_LOG_DIR}/upgrade.log
    true 
   

Na het bewerken van ncs.conf voert u ncs --reload uit.

vlot.log

Dit log is standaard ingeschakeld bij de breedtegraad van INFO. Als u de breedtegraad voor dit log wilt inschakelen en instellen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <raft-log>.

  true
  
    ${NCS_LOG_DIR}/raft.log
    true 
   
  trace

Na het bewerken van ncs.conf voert u ncs --reload uit.

HA-Raft EPMD-uitgang

Deze uitvoer is standaard niet ingeschakeld en schrijft niet naar een logbestand. In plaats daarvan schrijft het naar een terminal.

1. Alle NSO-instanties stoppen
   systemctl stop ncs.service
2. Open een nieuwe terminal, stop EPMD en start EPMD in de foutopsporingsmodus
   epmd -kill epmd -d
   
3. Start NSO
   systemctl start ncs.service
4. Het probleem reproduceren. De terminal toont EPMD-debugging-gegevens.

xpath.trace

Dit log is standaard niet ingeschakeld. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <xpath-trace-log>.

  true
  ${NCS_LOG_DIR}/xpath.trace

Na het bewerken van ncs.conf voert u ncs --reload uit.

ncserr.log

Dit logboek bevat een beperkte hoeveelheid informatie. NSO onderhoudt 5 foutbestanden, elk met een maximale grootte van 1 MB standaard. In de zeldzame situatie waarin zich een probleem voordoet dat meer dan 5 MB aan loggegevens creëert, moet u de maximale grootte verhogen. Dit log is standaard ingeschakeld. Als u de maximale grootte van dit log wilt wijzigen in 10 MB per bestand, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <error-log>.

  true
  ${NCS_LOG_DIR}/ncserr.log
  S10M

Na het bewerken van ncs.conf voert u ncs --reload uit.

transer.log

Dit log is niet standaard ingeschakeld, maar ingeschakeld in ncs.conf bij de eerste installatie. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <transaction-error-log>.

  true
  ${NCS_LOG_DIR}/transerr.log

Na het bewerken van ncs.conf voert u ncs --reload uit.

progress.trace

Dit log is niet standaard ingeschakeld, maar ingeschakeld in ncs.conf bij de eerste installatie. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <progress-trace>.

  true
  ${NCS_LOG_DIR}

Na het bewerken van ncs.conf voert u ncs --reload uit.

ncs-smart-licensing.log

Dit log is standaard niet ingeschakeld. Het log is ingeschakeld vanuit de NSO CLI die toegankelijk is via SSH of ncs_cli -C -noaaa. Dit log inschakelen:

config

Smart-License Smart-Agent Stout-Capture ingeschakeld

commit-geen-netwerk

U kunt de logboekwijziging als volgt herstellen:

config

Geen Smart-License Smart-Agent Stout-Capture ingeschakeld

commit-geen-netwerk

noordwaarts

localhost: xxxx.access

Dit log is standaard ingeschakeld. De naam van dit logboek varieert op basis van de HTTP-poort. Standaard 8080 en 8888. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <webui-access-log>.

  true
  ${NCS_LOG_DIR}

Na het bewerken van ncs.conf voert u ncs --reload uit.

traffic.trace

Dit log is standaard niet ingeschakeld. traffic.trace-logs worden gegenereerd in een directory zoals /var/log/ncs/trace_20240628_010010/. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <webui-access-log>.

  true
  ${NCS_LOG_DIR}
  true

Na het bewerken van ncs.conf voert u ncs --reload uit.

netconf.log

Dit log is standaard ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en voegt u de inhoud toe na <netconf-log>.

  true
  
    ${NCS_LOG_DIR}/netconf.log
    true 
   

Na het bewerken van ncs.conf voert u ncs uit --reload

Extra optie: Invoegen true na  de NSO log de rpc-antwoord status "ok" of "fout".

netconf-trace.log

Dit log is standaard niet ingeschakeld. Als u dit log wilt inschakelen, opent u /etc/ncs/ncs.conf en wijzigt u de inhoud van <netconf-trace-log>.

  true
  ${NCS_LOG_DIR}/netconf-trace.log

Na het bewerken van ncs.conf voert u ncs --reload uit.

json-rpc.log

Dit log is standaard niet ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en voegt u de inhoud toe na <jsonrpc-log>.

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

Na het bewerken van ncs.conf voert u ncs --reload uit.

zuidwaarts

Apparaat NED Trace

Dit log is standaard niet ingeschakeld. Het log is ingeschakeld vanuit de NSO CLI die toegankelijk is via SSH of ncs_cli -C -noaaa.

Een trace voor een apparaat inschakelen:

config
Apparaat <apparaatnaam> trace raw
Apparaat <apparaatnaam> Ned-instellingen <Ned-ID> Foutopsporing op loggerniveau
commit-geen-netwerk

Als u alle loginstellingen wilt weergeven die op een apparaat zijn toegepast, gebruikt u Apparaat <apparaatnaam> actieve instellingen tonen.

Als u de inhoud van een apparaattraceringsbestand wilt wissen, gebruikt u apparaatnaam <clear-trace> voor apparaten.

U schakelt als volgt apparaattracering uit:

config

Geen apparaten <apparaatnaam> traceren

commit-geen-netwerk

audit-network.log

Dit log is standaard niet ingeschakeld. Om dit log in te schakelen, opent u /etc/ncs/ncs.conf en voegt u de inhoud toe na <audit-network-log>.

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

Na het bewerken van ncs.conf voert u ncs --reload uit.