Abilita registri e versioni NSO

Introduzione

Questo documento descrive i vari log disponibili in NSO, il loro utilizzo e come abilitarli.

Prerequisiti

Requisiti

Per visualizzare, abilitare e impostare i registri, è necessario disporre dell'accesso all'ambiente host su cui è in esecuzione il servizio NSO, nonché dell'accesso alla CLI NSO e alla porta IPC NSO.

Componenti usati

Cisco Crosswork Network Service Orchestrator (NSO) versione 6.4.1

Questo documento è stato redatto per le opzioni di registrazione disponibili a partire dalla versione 6.4 di NSO. Sebbene la maggior parte delle informazioni contenute in questo documento siano valide per più versioni, alcuni log possono essere stati deprecati o aggiunti rispetto alla versione in uso. Questo documento non copre la configurazione per l'esportazione dei log al di fuori del sistema NSO.

I comandi forniti in questo documento presuppongono un NSO di installazione del sistema che utilizza l'impostazione predefinita della directory. Nell'ambiente in uso, la posizione di alcuni file può variare.

• ncs.conf è disponibile in $NCS_CONFIG_DIR, per impostazione predefinita /etc/ncs/ncs.conf
• I registri sono disponibili in $NCS_LOG_DIR, per impostazione predefinita /var/log/ncs/
• NSO è installato in $NCSDIR, per impostazione predefinita /opt/ncs/
• La directory di esecuzione di NSO è $NCS_RUN_DIR, per impostazione predefinita /var/opt/ncs/

Le informazioni discusse in questo documento fanno riferimento a dispositivi usati in uno specifico ambiente di emulazione. Su tutti i dispositivi menzionati nel documento la configurazione è stata ripristinata ai valori predefiniti. Se la rete è operativa, valutare attentamente eventuali conseguenze derivanti dall'uso dei comandi.

Linee guida generali per il log

Impatto registrazione

L'attivazione dei registri con un livello di dettaglio superiore può causare un aumento del carico e dei requisiti di spazio su disco per il server NSO. Questa considerazione è particolarmente utile per i log altamente attivi, ad esempio devel.log. L'attivazione del livello di dettaglio per brevi periodi di tempo durante la risoluzione dei problemi non rappresenta in genere un problema, ma quando si attiva il livello di dettaglio per periodi di tempo più lunghi, assicurarsi di tenere in considerazione le risorse e lo spazio su disco.

Generazione di un report tecnico

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

Options:
--install-dir : Specifica la directory per l'installazione dei file statici NCS, ad esempio l'opzione —install-dir del programma di installazione.

--full : Raccoglie un backup ncs del sistema, semplificando la riproduzione degli errori da parte del supporto Cisco.

--num-debug-dumps : Impostazione predefinita: 1. Genera uno snapshot di debug-dump. Per i casi in cui viene tenuta traccia delle perdite di risorse, ad esempio le perdite di memoria/descrittore del file, impostare questo valore su 3.

Opzioni consigliate:
/opt/ncs/current/bin/ncs-collect-tech-report --num-debug-dumps 3

È possibile raccogliere e fornire separatamente un backup per limitare le dimensioni dei file del bundle in modo da facilitare il caricamento.

Il report tecnico viene generato nella directory corrente da cui viene eseguito lo script.

Nota: Un report tecnico raccoglie il contenuto della directory dei log NSO. Verificare che questa directory non contenga alcun report o backup tecnici precedenti alla generazione del nuovo report.

Generazione di un backup

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

I backup vengono generati in /var/opt/ncs/backups/.

File di registro non generati

Quando un file di registro viene archiviato o eliminato, NSO deve creare un nuovo file. In genere ciò si verifica automaticamente ma, in caso contrario, utilizzare il comando:
/opt/ncs/current/bin/ncs_cmd -c reopen_logs.

Nota: Quando si limita l'accesso alla porta IPC, ad esempio utilizzando l'impostazione ipc-access nel file ncs.conf, assicurarsi di definire le variabili necessarie come parte di cron o anacron in modo che la rotazione settimanale dei registri possa riaprire correttamente i registri.

Panoramica sui log

• Registri interni NSO
  • ncs.log: Il registro ncs registra il processo principale dell'NSO. Le informazioni approfondite disponibili sono limitate, ma è possibile utilizzarle per problemi relativi a chiusura, avvio, caricamento di pacchetti e aggiornamenti.
  • audit.log: Il log di controllo registra tutti gli utenti che eseguono l'autenticazione su NSO tramite qualsiasi API. Registra inoltre qualsiasi attività sulla CLI NSO e sulle interfacce northbound a bassa densità.
  • audit-log-commit: L'attivazione di questa impostazione migliora il file audit.log. Non crea un proprio registro. Registra tutte le modifiche non predefinite nel database CDB NSO durante le operazioni di commit e sincronizzazione da.
  • audit-log-commit-defaults: L'attivazione di questa impostazione migliora il file audit.log. Non crea un proprio registro. Registra tutte le modifiche predefinite al database CDB NSO durante le operazioni di commit e di sincronizzazione da.
  • devel.log: Il log di sviluppo registra le operazioni generali e i workflow di NSO. 
  • ncs-java-vm.log: Il log Java registra tutte le operazioni relative alla Java VM. In particolare, qualsiasi Network Element Driver (NED) e i pacchetti di servizi scritti in Java. Tutti i dispositivi terminali della CLI sono scritti in Java. 
  • ncs-python-vm.log: I registri Python registrano l'attività relativa ai pacchetti di servizi scritti in Python. Viene generato un log Python separato per ogni service-package scritto in Python. Nessun NED è scritto in python. 
  • file upgrade.log: Il log di aggiornamento registra le modifiche nei modelli NSO durante gli aggiornamenti NSO, inclusi gli aggiornamenti della versione NSO e gli aggiornamenti dei pacchetti NSO durante il ricaricamento dei pacchetti. 
  • raft.log: Un registro specifico per i cluster NSO che sfruttano le funzionalità HA-Raft. 
  • Uscita HA-raft EPMD: Questo output non è un log NSO tradizionale, EPMD viene utilizzato in HA-raft per facilitare la scoperta dei nodi. Nelle istruzioni che seguono viene illustrato come ottenere le informazioni di debug per EPMD.
  • registrazione epmd: Voci di registrazione aggiuntive aggiunte per la funzionalità HA-Raft.
  • xpath.trace: La traccia xpath registra tutte le valutazioni xpath eseguite dall'NSO. Questa operazione può essere utile per capire perché un'operazione di eliminazione richiede molto tempo. 
  • ncserr.log: Il file ncserr.log è un registro binario che registra gli errori relativi ai processi interni dal daemon NCS. Obbligatorio per quasi tutti i messaggi di errore 'internal error' e gli scenari di arresto anomalo. 
  • transerr.log: Il log degli errori delle transazioni è un log per la raccolta di informazioni sulle transazioni non riuscite che causano errori di avvio del CDB o errori delle transazioni di runtime.
  • progress.trace: La traccia di avanzamento viene utilizzata per la traccia degli eventi di avanzamento generati dalle transazioni e dalle azioni nel sistema. I dati da emettere sono configurati in /progress/trace.
  • ncs-smart-licensing.log: Registri per lo smart-agent della licenza all'interno dell'NSO.
• In direzione nord: Arrivo a NSO da elementi verso nord
  • audit.log: I comandi del log di controllo vengono eseguiti nella CLI NSO.
  • localhost:8080.access/localhost:8888.access: Si tratta di un log degli accessi per il server Web incorporato e raccoglie l'attività HTTP. Questo file è conforme al formato di log comune, definito da Apache
  • traffic.trace: Questo registro raccoglie il traffico HTTP con livello di dettaglio molto elevato. Utilizzarlo per eseguire il debug dell'API Restconf e json-rpc. 
  • netconf.log: Log per API netconf 
  • netconf-trace.log: Log per API netconf con elevato livello di dettaglio
  • json-rpc.log: Log per API json-rpc.log
• Verso sud: Registrazione della comunicazione dall'NSO alla rete.
  • Tracce NED dispositivo: Ogni dispositivo genera la propria traccia. Alle tracce dispositivo viene assegnato il nome end-<end-id>-<devicename>.trace o netconf-<devicename>.trace
  • audit-network.log: Registra i comandi di configurazione inviati da NSO ai dispositivi in direzione sud.
• Log di sistema
  • Log Linux: Si trova in genere in /var/log/ e include registri quali messaggi o syslog. Queste variano a seconda dell'host.
  • ncs_crash.dump: Dump di sistema NSO generato quando NSO termina a causa di problemi di memoria.
  • Dump core: Quando NSO viene terminato per motivi non legati alla memoria, Linux può generare un dump del core chiamato core.<PID>

Affinché Linux generi un dump di base, è necessario che siano soddisfatte alcune condizioni. La configurazione massima è l'impostazione più comune che impedisce un dump. Vedere Pagina Manuale Linux per un elenco completo dei requisiti

Nota: I registri di sistema non vengono raccolti dal rapporto tecnico NCS, ma possono essere utili per problemi di prestazioni e di crash.

Abilitazione dei log e impostazione del livello di dettaglio

Nota: La modifica delle impostazioni di configurazione nel file ncs.conf viene applicata eseguendo il ncs --reload comando. ncs --reload, it ricarica i valori dal file ncs.conf e aggiorna il sistema in esecuzione, oltre a chiudere e riaprire tutti i file di registro in modo da applicare le modifiche di registrazione. Ciò non interrompe i servizi.

Indicazioni generali

• Quando nel file ncs.conf non è presente una configurazione specifica, NSO adotta il comportamento predefinito come specificato nel /opt/ncs/current/src/ncs/ncs_config/tailf-ncs-config.yang file.
• Se per impostazione predefinita un registro è specificato come abilitato, significa che il registro è abilitato anche se manca la configurazione per abilitarlo.
• Alcuni registri sono disabilitati per impostazione predefinita, ma durante la prima installazione di NSO, ncs.conf dispone di istruzioni specifiche per abilitare il registro.
• Se nel file ncs.conf non è presente una configurazione specifica, è possibile aggiungerla come mostrato nella logs container, che indica tra   e   nel file ncs.conf. 

Interno

registro.ncs

Questo registro è attivato per impostazione predefinita. Per attivare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <ncs-log>.

  true
  
    ${NCS_LOG_DIR}/ncs.log
    true 
   

Dopo aver modificato ncs.conf, eseguite ncs —reload.

audit.log

Questo registro è attivato per impostazione predefinita. Per attivare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

Dopo aver modificato ncs.conf, eseguite ncs —reload.

audit-log-commit e audit-log-commit-default

Per impostazione predefinita, questo registro non è attivato. Per attivare questo registro, aprire /etc/ncs/ncs.conf e aggiungere il contenuto dopo <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

true
true

Dopo aver modificato ncs.conf, eseguite ncs —reload.

diavola.log

Per impostazione predefinita, questo registro è attivato al livello di dettaglio INFO. Per attivare e modificare il livello di dettaglio per questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <developer-log>.

  true
  
    ${NCS_LOG_DIR}/devel.log
    true 
   

trace

Dopo aver modificato ncs.conf, eseguite ncs —reload.

ncs-java-vm.log

Per impostazione predefinita, questo registro è attivato al livello di dettaglio INFO. È possibile impostare il livello di dettaglio per singoli elementi gestiti da Java-vm. Il livello di dettaglio viene modificato dalla CLI di NSO a cui è possibile accedere tramite SSH o ncs_cli -C -noaa

Per aumentare il livello di dettaglio in tutti gli elementi java in com.tailf:

config
java-vm java-logging logger com.tailf level-trace
eseguire il commit senza connessione di rete

Per aumentare il livello di dettaglio per un pacchetto END specifico:

config

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

eseguire il commit senza connessione di rete

Per aumentare il livello di dettaglio per il client SSHJ utilizzato nei pacchetti Java NED:

config

java-vm java-logging logger net.schmizz.sshj level-error

eseguire il commit senza connessione di rete

Nota: Cisco consiglia di impostare la registrazione per il client SSHJ su errore di livello. Per impostazione predefinita, è disabilitato.

Per ripristinare la registrazione di un elemento Java specifico:

config

no java-vm java-logging logger com.tailf

eseguire il commit senza connessione di rete

Per visualizzare le impostazioni di registrazione della Java VM corrente:

show running-config java-vm java-logging

ncs-python-vm.log

Per impostazione predefinita, questo registro è attivato al livello di dettaglio INFO. Il livello di dettaglio viene modificato dalla CLI di NSO a cui è possibile accedere tramite SSH o ncs_cli -C -noaa.

Per impostare il livello di dettaglio per i log di tutte le VM Python.

config
debug livello di registrazione python-vm
eseguire il commit senza connessione di rete

Per tornare indietro:
config
no python-vm logging level-debug
eseguire il commit senza connessione di rete

Per visualizzare le impostazioni di registrazione correnti della macchina virtuale Python:
show running-config python-vm logging

aggiorna.log

Questo registro è attivato per impostazione predefinita. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <upgrade-log>.

  true
  
    ${NCS_LOG_DIR}/upgrade.log
    true 
   

Dopo aver modificato ncs.conf, eseguite ncs —reload.

trafiletto.log

Per impostazione predefinita, questo registro è attivato al livello di dettaglio INFO. Per attivare e impostare il livello di dettaglio per questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <raft-log>.

  true
  
    ${NCS_LOG_DIR}/raft.log
    true 
   
  trace

Dopo aver modificato ncs.conf, eseguite ncs —reload.

Uscita EPMD ad alta velocità

Questo output non è abilitato per impostazione predefinita e non scrive in un file di log. Invece scrive su un terminale.

1. Arresta tutte le istanze NSO
   systemctl stop ncs.service
2. Aprire un nuovo terminale, arrestare EPMD e avviare EPMD in modalità di debug
   epmd -kill epmd -d
   
3. Avvia NSO
   systemctl start ncs.service
4. Riprodurre il quesito. Il terminale mostra i dati di debug EPMD.

xpath.traccia

Per impostazione predefinita, questo registro non è attivato. Per attivare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <xpath-trace-log>.

  true
  ${NCS_LOG_DIR}/xpath.trace

Dopo aver modificato ncs.conf, eseguite ncs —reload.

ncserr.log

In questo registro viene registrata una quantità limitata di informazioni. NSO mantiene 5 file di errore, ciascuno con una dimensione massima di 1 MB per impostazione predefinita. Nelle rare situazioni in cui si verifica un problema che crea più di 5 MB di dati di registro, è necessario aumentare le dimensioni massime. Questo registro è attivato per impostazione predefinita. Per modificare le dimensioni massime di questo registro a 10 MB per file, aprire /etc/ncs/ncs.conf e modificare il contenuto di <error-log>.

  true
  ${NCS_LOG_DIR}/ncserr.log
  S10M

Dopo aver modificato ncs.conf, eseguite ncs —reload.

trasferisci.log

Per impostazione predefinita, questo registro non è attivato, ma lo è in ncs.conf alla prima installazione. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <transaction-error-log>.

  true
  ${NCS_LOG_DIR}/transerr.log

Dopo aver modificato ncs.conf, eseguite ncs —reload.

progresso.traccia

Per impostazione predefinita, questo registro non è attivato, ma lo è in ncs.conf alla prima installazione. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <progress-trace>.

  true
  ${NCS_LOG_DIR}

Dopo aver modificato ncs.conf, eseguite ncs —reload.

ncs-smart-licensing.log

Per impostazione predefinita, questo registro non è attivato. Il registro è abilitato dalla CLI di NSO a cui è possibile accedere tramite SSH o ncs_cli -C -noaaa. Per abilitare questo registro:

config

smart-license smart-agent stdout-capture abilitata

eseguire il commit senza connessione di rete

Per annullare la modifica della registrazione:

config

nessuna acquisizione stdout smart-agent smart-license abilitata

eseguire il commit senza connessione di rete

Northbound

localhost:xxxx.access

Questo registro è attivato per impostazione predefinita. Il nome di questo registro varia in base alla porta HTTP. Per impostazione predefinita, 8080 e 8888. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <webui-access-log>.

  true
  ${NCS_LOG_DIR}

Dopo aver modificato ncs.conf, eseguite ncs —reload.

traffico.traccia

Per impostazione predefinita, questo registro non è attivato. i registri traffic.trace vengono generati in una directory quale /var/log/ncs/trace_20240628_010010/. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <webui-access-log>.

  true
  ${NCS_LOG_DIR}
  true

Dopo aver modificato ncs.conf, eseguite ncs —reload.

netconf.log

Questo registro è attivato per impostazione predefinita. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e aggiungere il contenuto dopo <netconf-log>.

  true
  
    ${NCS_LOG_DIR}/netconf.log
    true 
   

Dopo aver modificato ncs.conf, eseguite ncs —reload

Opzione aggiuntiva: Inserire true dopo  che NSO registri lo stato di rpc-reply "ok" o "error".

netconf-trace.log

Per impostazione predefinita, questo registro non è attivato. Per abilitare questo registro, aprire /etc/ncs/ncs.conf e modificare il contenuto di <netconf-trace-log>.

  true
  ${NCS_LOG_DIR}/netconf-trace.log

Dopo aver modificato ncs.conf, eseguite ncs —reload.

json-rpc.log

Per impostazione predefinita, questo registro non è attivato. Per attivare questo registro, aprire /etc/ncs/ncs.conf e aggiungere il contenuto dopo <jsonrpc-log>.

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

Dopo aver modificato ncs.conf, eseguite ncs —reload.

Verso sud

Traccia NED dispositivo

Per impostazione predefinita, questo registro non è attivato. Il registro è abilitato dalla CLI di NSO a cui è possibile accedere tramite SSH o ncs_cli -C -noaaa.

Per abilitare una traccia per un dispositivo:

config
device device device <nomeperiferica> trace raw
device device <nomeperiferica> end-settings <id-finale> logger level debug
eseguire il commit senza connessione di rete

Per visualizzare tutte le impostazioni di registro applicate a un dispositivo, utilizzare show devices <nomedispositivo> active-settings.

Per cancellare il contenuto di un file di traccia del dispositivo, utilizzare devices device <nomedispositivo> clear-trace.

Per disabilitare la traccia del dispositivo:

config

nessuna traccia di device device <devicename>

eseguire il commit senza connessione di rete

audit-network.log

Per impostazione predefinita, questo registro non è attivato. Per attivare questo registro, aprire /etc/ncs/ncs.conf e aggiungere il contenuto dopo <audit-network-log>.

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

Dopo aver modificato ncs.conf, eseguite ncs —reload.