Activar registros y verbosidades de NSO

Introducción

Este documento describe los diversos registros disponibles en NSO, para qué se utilizan y cómo habilitarlos.

Prerequisites

Requirements

Para ver, habilitar y establecer registros, necesita un usuario con acceso al entorno host que ejecuta el servicio NSO, así como acceso al puerto NSO CLI y NSO IPC.

Componentes Utilizados

Cisco Crosswork Network Service Orchestrator (NSO) versión 6.4.1

Este documento se ha escrito para las opciones de registro disponibles a partir de NSO 6.4. Aunque la mayor parte de la información de este documento se aplica a todas las versiones, algunos registros pueden haberse dejado de utilizar o agregado en comparación con la versión que está utilizando. Este documento no cubre la configuración para exportar registros fuera del sistema NSO.

Los comandos proporcionados en este documento asumen que un NSO instalado en el sistema utiliza la configuración de directorio predeterminada. En su entorno, las ubicaciones de ciertos archivos pueden diferir.

• ncs.conf se encuentra en $NCS_CONFIG_DIR, de forma predeterminada /etc/ncs/ncs.conf
• Los registros se pueden encontrar en $NCS_LOG_DIR, de forma predeterminada /var/log/ncs/
• NSO se instala en $NCSDIR, de forma predeterminada /opt/ncs/
• El directorio en ejecución de NSO es $NCS_RUN_DIR, de forma predeterminada /var/opt/ncs/

La información que contiene este documento se creó a partir de los dispositivos en un ambiente de laboratorio específico. Todos los dispositivos que se utilizan en este documento se pusieron en funcionamiento con una configuración verificada (predeterminada). Si tiene una red en vivo, asegúrese de entender el posible impacto de cualquier comando.

Pautas generales de registro

Impacto del registro

La habilitación de registros con mayor detalle puede aumentar la carga y los requisitos de espacio en disco del servidor NSO. Esto se tiene especialmente en cuenta para los registros muy activos como devel.log. Habilitar la verbosidad durante breves períodos de tiempo durante la resolución de problemas no suele ser una preocupación, pero al habilitarlos durante períodos de tiempo más largos, asegúrese de tener en cuenta los recursos y el espacio en disco.

Generación de un informe técnico

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

Opciones:
--install-dir : Especifica el directorio para la instalación de los archivos estáticos de NCS, como la opción —install-dir del instalador.

--full : Recopila una copia de seguridad de ncs del sistema, lo que facilita al equipo de soporte técnico de Cisco reproducir los errores.

--num-debug-dumps : Predeterminado 1, Genera una instantánea de debug-dump. Para los casos que rastrean fugas de recursos, como fugas de memoria/descriptor de archivo, establezca esto en 3.

Opciones recomendadas:
/opt/ncs/current/bin/ncs-collect-tech-report --num-debug-dumps 3

Se puede recopilar una copia de seguridad y proporcionarla por separado para limitar el tamaño de archivo del paquete y facilitar así las cargas.

El informe técnico se genera en el directorio actual desde el que se ejecuta el script.

Nota: Un informe técnico recopila el contenido del directorio de registro de NSO. Verifique que este directorio no contenga informes técnicos o copias de seguridad anteriores antes de generar su nuevo informe técnico.

Generación de una copia de seguridad

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

Los backups se generan en /var/opt/ncs/backups/.

Archivos de registro que no se generan

Cuando se archiva o elimina un archivo de registro, NSO necesita crear un nuevo archivo. Por lo general, esto sucede automáticamente, pero en caso de que no lo hiciera, utilice el comando:
/opt/ncs/current/bin/ncs_cmd -c reopen_logs.

Nota: Al restringir el acceso al puerto IPC, por ejemplo, usando la configuración ipc-access en ncs.conf, asegúrese de definir las variables necesarias como parte de cron o anacron para que la rotación de registros semanal pueda volver a abrir correctamente los registros.

Descripción General de Registros

• Registros internos de NSO
  • ncs.log: El registro de ncs registra el proceso principal de NSO. Tiene información limitada en profundidad, pero se puede utilizar para problemas relacionados con el apagado, el inicio, la carga de paquetes y las actualizaciones.
  • audit.log: El registro de auditoría registra a los usuarios que se autentican en NSO a través de cualquier API. También registra cualquier actividad en la CLI de NSO y las interfaces ascendentes de baja verbosidad.
  • audit-log-commit: La habilitación de esta configuración mejora audit.log. No crea su propio registro. Registra todos los cambios no predeterminados en NSO CDB durante las operaciones de confirmación y sincronización desde.
  • audit-log-commit-defaults : La habilitación de esta configuración mejora audit.log. No crea su propio registro. Registra todos los cambios predeterminados en NSO CDB durante las operaciones de confirmación y sincronización desde.
  • devel.log: El registro de desarrollo registra las operaciones generales y los flujos de trabajo de NSO. 
  • ncs-java-vm.log: El registro de java registra todas las operaciones relacionadas con java-vm. En particular, cualquier controlador de elementos de red (NED) y paquetes de servicios escritos en Java. Todos los CLI NED están escritos en Java. 
  • ncs-python-vm.log: Los registros de Python registran la actividad relacionada con los paquetes de servicio escritos en Python. Se genera un registro de python independiente para cada paquete de servicio escrito en python. No hay NED escritos en Python. 
  • upgrade.log: El registro de actualizaciones registra los cambios en los modelos de NSO durante las actualizaciones de NSO, incluidas las actualizaciones de la versión de NSO y las actualizaciones de paquetes de NSO durante la recarga de paquetes. 
  • raft.log: Un registro específico para los clústeres de NSO que aprovechan las capacidades de HA-Raft. 
  • Salida EPMD de HA-raft: Esta salida no es un registro tradicional de NSO, EPMD se utiliza en HA-raft para ayudar a detectar nodos. Estas instrucciones explican cómo obtener información de depuración para EPMD.
  • registro de epmd: Entradas de registro adicionales agregadas para la funcionalidad HA-Raft.
  • xpath.trace: El seguimiento de xpath registra todas las evaluaciones de xpath que realiza NSO. Esto puede resultar útil para averiguar por qué una operación de eliminación está tardando mucho tiempo. 
  • ncserr.log: El archivo ncserr.log son registros binarios que registran errores de procesos internos del demonio NCS. Obligatorio para casi cualquier mensaje de error "interno" y escenario de desperfecto. 
  • transfer.log: El registro de errores de transacción es un registro para recopilar información sobre las transacciones fallidas que dan lugar a un error de arranque CDB o a un error de transacción en tiempo de ejecución.
  • progress.trace: El seguimiento del progreso se utiliza para realizar el seguimiento de los eventos de progreso emitidos por las transacciones y acciones del sistema. Los datos que se van a emitir se configuran en /progress/trace.
  • ncs-smart-licensing.log: Registros del agente inteligente de licencias dentro de NSO.
• En sentido ascendente: Llegada a NSO desde elementos ascendentes
  • audit.log: Los comandos de registro de auditoría se ejecutan en la CLI de NSO.
  • localhost:8080.access/localhost:8888.access : Este es un registro de acceso para el servidor Web incrustado y recopila la actividad HTTP. Este archivo cumple con el Formato Común de Log, como lo define Apache
  • traffic.trace: Este registro recopila tráfico HTTP con una verbosidad muy alta. Utilícelo para depurar la API Restconf y json-rpc. 
  • netconf.log: Registro de la API de netconf 
  • netconf-trace.log: Registro de API netconf de gran verbosidad
  • json-rpc.log: Registro de la API json-rpc.log
• Hacia el sur: Comunicación de registro que va de NSO a la red.
  • Seguimientos de dispositivos NED: Cada dispositivo genera su propio seguimiento. Los seguimientos de dispositivos se denominan ned-<ned-id>-<devicename>.trace o netconf-<devicename>.trace
  • audit-network.log: Registra los comandos de configuración enviados por NSO a los dispositivos descendentes.
• Registros del sistema
  • Registros de Linux: Normalmente se encuentra en /var/log/ e incluye registros como mensajes o syslog. Estos varían según el host.
  • ncs_crash.dump: Volcado del sistema NSO generado cuando NSO finaliza debido a problemas de memoria.
  • Vaciado de memoria: Cuando se termina NSO por razones que no son de memoria, Linux puede generar un vaciado de memoria llamado core.<PID>

Se deben cumplir ciertas condiciones para que Linux genere un vaciado de memoria. La configuración ulimit es el parámetro más común que impide un volcado. Consulte la Página de Manual de Linux para obtener una lista completa de los requisitos

Nota: El informe técnico de NCS no recopila los registros del sistema, pero pueden ser útiles para problemas relacionados con el rendimiento y el desperfecto.

Habilitación de Registros y Configuración de Verbosidad

Nota: Los cambios en los parámetros de configuración del archivo ncs.conf se aplican mediante la ejecución del ncs --reload comando. ncs --reload, it vuelve a cargar los valores del archivo ncs.conf y actualiza el sistema en ejecución, así como cierra y vuelve a abrir todos los archivos de registro para que se apliquen los cambios de registro. Esto no interrumpe los servicios.

Pautas generales

• Cuando no hay una configuración específica en el archivo ncs.conf, NSO adopta el comportamiento predeterminado especificado en el /opt/ncs/current/src/ncs/ncs_config/tailf-ncs-config.yang archivo.
• Cuando se especifica que un registro está habilitado de forma predeterminada, significa que el registro está habilitado aunque falte la configuración para habilitarlo.
• Algunos registros están deshabilitados de forma predeterminada, pero durante la primera instalación de NSO, ncs.conf tiene instrucciones específicas para habilitar el registro.
• Cuando no haya una configuración específica en el archivo ncs.conf, puede agregar la configuración como se muestra en la logs container, es decir, entre   y   en el archivo ncs.conf. 

Interno

ncs.log

Este registro está activado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <ncs-log>.

  true
  
    ${NCS_LOG_DIR}/ncs.log
    true 
   

Después de editar ncs.conf, ejecute ncs —reload.

audit.log

Este registro está activado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

Después de editar ncs.conf, ejecute ncs —reload.

audit-log-commit y audit-log-commit-defaults

Este registro no está habilitado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y agregue el contenido después de <audit-log>.

  true
  
    ${NCS_LOG_DIR}/audit.log
    true 
   

true
true

Después de editar ncs.conf, ejecute ncs —reload.

devel.log

Este registro está habilitado de forma predeterminada en información detallada. Para habilitar y cambiar el nivel de detalle de este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <developer-log>.

  true
  
    ${NCS_LOG_DIR}/devel.log
    true 
   

trace

Después de editar ncs.conf, ejecute ncs —reload.

ncs-java-vm.log

Este registro está habilitado de forma predeterminada en información detallada. Es posible establecer la verbosidad de los elementos individuales administrados por java-vm. La verbosidad se altera desde la CLI de NSO, a la que se puede acceder a través de SSH o ncs_cli -C -noaaa

Para aumentar la verbosidad de todos los elementos de Java en com.tailf:

config
java-vm java-logging logger com.tailf level level-trace
commit no-networking

Para aumentar el detalle de un paquete NED específico:

config

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

commit no-networking

Para aumentar la verbosidad del cliente SSHJ utilizado en los paquetes NED de Java:

config

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

commit no-networking

Nota: Cisco recomienda configurar el registro para el cliente SSHJ en error de nivel. Está desactivada de forma predeterminada.

Para revertir el registro de un elemento Java específico:

config

no java-vm java-logging logger com.tailf

commit no-networking

Para ver la configuración de registro actual de java-vm:

show running-config java-vm java-logging

ncs-python-vm.log

Este registro está habilitado de forma predeterminada en información detallada. La verbosidad se altera desde la CLI de NSO, a la que se puede acceder a través de SSH o ncs_cli -C -noaaa.

Para establecer la verbosidad de los registros de todas las VM de Python.

config
python-vm logging level level-debug
commit no-networking

Para retroceder:
config
no python-vm logging level level-debug
commit no-networking

Para ver la configuración de registro actual de python-vm:
show running-config python-vm logging

upgrade.log

Este registro está activado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <upgrade-log>.

  true
  
    ${NCS_LOG_DIR}/upgrade.log
    true 
   

Después de editar ncs.conf, ejecute ncs —reload.

raft.log

Este registro está habilitado de forma predeterminada en información detallada. Para habilitar y establecer la verbosidad de este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <raft-log>.

  true
  
    ${NCS_LOG_DIR}/raft.log
    true 
   
  trace

Después de editar ncs.conf, ejecute ncs —reload.

Salida HA-Raft EPMD

Este resultado no está habilitado de forma predeterminada y no escribe en un archivo de registro. En su lugar, escribe en un terminal.

1. Detener todas las instancias de NSO
   systemctl stop ncs.service
2. Abra un nuevo terminal, detenga EPMD e inicie EPMD en modo de depuración
   epmd -kill epmd -d
   
3. Iniciar NSO
   systemctl start ncs.service
4. Reproduzca el problema. El terminal muestra los datos de depuración de EPMD.

xpath.trace

Este registro no está habilitado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <xpath-trace-log>.

  true
  ${NCS_LOG_DIR}/xpath.trace

Después de editar ncs.conf, ejecute ncs —reload.

ncserr.log

Este registro registra una cantidad limitada de información. NSO mantiene 5 archivos de error, cada uno con un tamaño máximo de 1 MB de forma predeterminada. En la rara situación en la que ocurre un problema que crea más de 5MB en los datos de registro, necesita aumentar el tamaño máximo. Este registro está activado de forma predeterminada. Para modificar el tamaño máximo de este registro a 10 MB por archivo, abra /etc/ncs/ncs.conf y cambie el contenido de <error-log>.

  true
  ${NCS_LOG_DIR}/ncserr.log
  S10M

Después de editar ncs.conf, ejecute ncs —reload.

transerr.log

Este registro no está habilitado de forma predeterminada, pero sí en ncs.conf en la primera instalación. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <transaction-error-log>.

  true
  ${NCS_LOG_DIR}/transerr.log

Después de editar ncs.conf, ejecute ncs —reload.

progress.trace

Este registro no está habilitado de forma predeterminada, pero sí en ncs.conf en la primera instalación. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <progress-trace>.

  true
  ${NCS_LOG_DIR}

Después de editar ncs.conf, ejecute ncs —reload.

ncs-smart-licensing.log

Este registro no está habilitado de forma predeterminada. El registro se habilita desde la CLI de NSO, a la que se puede acceder a través de SSH o ncs_cli -C -noaaa. Para habilitar este registro:

config

smart-license smart-agent stdout-capture enabled

commit no-networking

Para revertir el cambio de registro:

config

no smart-license smart-agent stdout-capture enabled

commit no-networking

En sentido ascendente

localhost:xxxx.access

Este registro está activado de forma predeterminada. El nombre de este registro varía según el puerto HTTP. De forma predeterminada, 8080 y 8888. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <webui-access-log>.

  true
  ${NCS_LOG_DIR}

Después de editar ncs.conf, ejecute ncs —reload.

traffic.trace

Este registro no está habilitado de forma predeterminada. los logs de traffic.trace se generan en un directorio como /var/log/ncs/trace_20240628_010010/. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <webui-access-log>.

  true
  ${NCS_LOG_DIR}
  true

Después de editar ncs.conf, ejecute ncs —reload.

netconf.log

Este registro está activado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y agregue el contenido después de <netconf-log>.

  true
  
    ${NCS_LOG_DIR}/netconf.log
    true 
   

Después de editar ncs.conf, ejecute ncs —reload

Opción adicional: Inserte true después de  para que NSO registre el estado de respuesta rpc "ok" o "error".

netconf-trace.log

Este registro no está habilitado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y cambie el contenido de <netconf-trace-log>.

  true
  ${NCS_LOG_DIR}/netconf-trace.log

Después de editar ncs.conf, ejecute ncs —reload.

json-rpc.log

Este registro no está habilitado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y agregue el contenido después de <jsonrpc-log>.

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

Después de editar ncs.conf, ejecute ncs —reload.

Hacia el sur

Seguimiento de dispositivo NED

Este registro no está habilitado de forma predeterminada. El registro se habilita desde la CLI de NSO, a la que se puede acceder a través de SSH o ncs_cli -C -noaaa.

Para habilitar un seguimiento para un dispositivo:

config
devices device <devicename> trace raw
devices device <devicename> end-settings <ned-id> logger level debug
commit no-networking

Para ver todas las configuraciones de registro aplicadas a un dispositivo, utilice show devices device <devicename> active-settings.

Para borrar el contenido de un archivo de seguimiento de dispositivos, utilice devices device <devicename> clear-trace.

Para deshabilitar el seguimiento de dispositivos:

config

no devices device <devicename> trace

commit no-networking

audit-network.log

Este registro no está habilitado de forma predeterminada. Para habilitar este registro, abra /etc/ncs/ncs.conf y agregue el contenido después de <audit-network-log>.

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

Después de editar ncs.conf, ejecute ncs —reload.