Registro de configuración

El registro de configuración es una función que captura los cambios de configuración del sitio y las actividades administrativas en la base de datos. Esta función está habilitada de forma predeterminada. Puede utilizar el contenido registrado para:

• Diagnosticar y solucionar problemas después de realizar cambios de configuración. El registro proporciona un rastro.
• Ayudar en la gestión de cambios y realizar un seguimiento de las configuraciones.
• Informar sobre la actividad de administración.

Puede establecer las preferencias de registro de configuración, mostrar los registros de configuración y generar informes HTML y CSV desde Citrix Studio. Puede filtrar las visualizaciones del registro de configuración por intervalos de fechas y resultados de búsqueda de texto completo. El registro obligatorio, cuando está habilitado, impide que se realicen cambios de configuración a menos que puedan registrarse. Con el permiso adecuado, puede eliminar entradas del registro de configuración. No puede utilizar la función de registro de configuración para editar el contenido del registro.

El registro de configuración utiliza un SDK de PowerShell y el Servicio de registro de configuración. El Servicio de registro de configuración se ejecuta en cada Controller del sitio. Si un Controller falla, el servicio de otro Controller gestiona automáticamente las solicitudes de registro.

De forma predeterminada, la función de registro de configuración está habilitada y utiliza la base de datos que se crea al crear el sitio (la base de datos de configuración del sitio). Puede especificar una ubicación diferente para la base de datos. La base de datos de registro de configuración admite las mismas características de alta disponibilidad que la base de datos de configuración del sitio.

El acceso al registro de configuración se controla mediante la administración delegada, con los permisos de edición de preferencias de registro y de visualización de registros de configuración.

Los registros de configuración se localizan cuando se crean. Por ejemplo, un registro creado en inglés se lee en inglés, independientemente de la configuración regional del lector.

Qué se registra

Se registran los cambios de configuración y las actividades administrativas iniciadas desde Studio, Director y los scripts de PowerShell. Algunos ejemplos de cambios de configuración registrados incluyen trabajar con (crear, modificar, eliminar, asignar):

• Catálogos de máquinas
• Grupos de entrega (incluida la modificación de la configuración de administración de energía)
• Roles y ámbitos de administrador
• Recursos y conexiones de host
• Directivas de Citrix a través de Studio

Algunos ejemplos de cambios administrativos registrados son:

• Administración de energía de una máquina virtual o un escritorio de usuario
• Studio o Director enviando un mensaje a un usuario

Las siguientes operaciones no se registran:

• Operaciones autónomas como el encendido de máquinas virtuales por parte de la administración de grupos.
• Acciones de directiva implementadas a través de la Consola de administración de directivas de grupo (GPMC); utilice las herramientas de Microsoft para ver los registros de esas acciones.
• Cambios realizados a través del registro, acceso directo a la base de datos o desde orígenes distintos de Studio, Director o PowerShell.
• Cuando se inicializa la implementación, el registro de configuración está disponible cuando la primera instancia del Servicio de registro de configuración se registra en el Servicio de configuración. Por lo tanto, las primeras fases de la configuración no se registran (por ejemplo, cuando se obtiene y aplica el esquema de la base de datos, cuando se inicializa un hipervisor).

Administrar el registro de configuración

De forma predeterminada, el registro de configuración utiliza la base de datos que se crea al crear un sitio (también conocida como base de datos de configuración del sitio). Citrix recomienda utilizar una ubicación independiente para la base de datos de registro de configuración (y la base de datos de supervisión) por los siguientes motivos:

• Es probable que la estrategia de copia de seguridad de la base de datos de registro de configuración difiera de la estrategia de copia de seguridad de la base de datos de configuración del sitio.
• El volumen de datos recopilados para el registro de configuración (y el Servicio de supervisión) podría afectar negativamente al espacio disponible para la base de datos de configuración del sitio.
• Divide el único punto de fallo de las tres bases de datos.

Las ediciones de producto que no admiten el registro de configuración no tienen un nodo de Registro en Studio.

Habilitar y deshabilitar el registro de configuración y el registro obligatorio

De forma predeterminada, el registro de configuración está habilitado y el registro obligatorio está deshabilitado.

1. Inicie sesión en Web Studio y seleccione Registro en el panel izquierdo.
2. Seleccione Preferencias en la barra de acciones. El cuadro de diálogo de registro de configuración contiene información de la base de datos e indica si el registro de configuración y el registro obligatorio están habilitados o deshabilitados.

3. Seleccione la acción deseada:

   Para habilitar el registro de configuración, seleccione Habilitar. Esta es la configuración predeterminada. Si no se puede escribir en la base de datos, la información de registro se descarta, pero la operación continúa.

   Para deshabilitar el registro de configuración, seleccione Deshabilitar. Si el registro estaba habilitado anteriormente, los registros existentes siguen siendo legibles con el SDK de PowerShell.

   Para habilitar el registro obligatorio, seleccione Impedir cambios en la configuración del sitio cuando la base de datos no esté disponible. No se permite ningún cambio de configuración o actividad administrativa que normalmente se registra a menos que se pueda escribir en la base de datos de registro de configuración. Solo puede habilitar el registro obligatorio cuando el registro de configuración está habilitado (cuando se selecciona Habilitar). Si el servicio de registro de configuración falla y la alta disponibilidad no está en uso, se asume el registro obligatorio. En tales casos, las operaciones que normalmente se registrarían no se realizan.

   Para deshabilitar el registro obligatorio, seleccione Permitir cambios en la configuración del sitio cuando la base de datos no esté disponible. Se permiten los cambios de configuración y las actividades administrativas, incluso si no se puede acceder a la base de datos de registro de configuración. Esta es la configuración predeterminada.

Cambiar la ubicación de la base de datos de registro de configuración

No puede cambiar la ubicación de la base de datos cuando el registro obligatorio está habilitado, porque el cambio de ubicación incluye un breve intervalo de desconexión que no se puede registrar.

1. Cree un servidor de bases de datos, utilizando una versión compatible de SQL Server.
2. Inicie sesión en Web Studio y seleccione Registro en el panel izquierdo.
3. Seleccione Preferencias en la barra de acciones.
4. En el cuadro de diálogo Preferencias de registro, seleccione Cambiar base de datos de registro.
5. En el cuadro de diálogo Cambiar base de datos de registro, especifique la ubicación del servidor que contiene el nuevo servidor de base de datos. Consulte Formatos de dirección de base de datos para ver los formatos válidos.
6. Para permitir que Studio cree la base de datos, haga clic en Aceptar. Cuando se le solicite, haga clic en Aceptar, y la base de datos se creará automáticamente. Studio intenta acceder a la base de datos utilizando las credenciales del usuario actual de Studio. Si eso falla, se le pedirán las credenciales del usuario de la base de datos. A continuación, Studio carga el esquema de la base de datos en la misma. (Las credenciales se conservan solo durante la creación de la base de datos).
7. Para crear la base de datos manualmente, haga clic en Generar script de base de datos. El script generado incluye instrucciones para crear la base de datos manualmente. Asegúrese de que la base de datos esté vacía y de que al menos un usuario tenga permiso para acceder y cambiar la base de datos antes de cargar el esquema.

Los datos de registro de configuración de la base de datos anterior no se importan a la nueva base de datos. Los registros no se pueden agregar de ambas bases de datos al recuperarlos. La primera entrada de registro en la nueva base de datos de registro de configuración indica que se produjo un cambio en la base de datos, pero no identifica la base de datos anterior.

Ver contenido del registro de configuración

Para ver el contenido del registro de configuración, seleccione Registro en el panel izquierdo y, a continuación, seleccione la ficha Eventos.

De forma predeterminada, los registros de eventos se enumeran por nombres de administrador. Puede realizar las siguientes tareas según sea necesario:

• Ver detalles del registro. Una operación de alto nivel da como resultado una o más llamadas de servicio y SDK, que son operaciones de bajo nivel. Cuando selecciona una operación de alto nivel en el panel superior, el panel inferior muestra las operaciones de bajo nivel.
• Ordenar la visualización. Ordene la visualización haciendo clic en el encabezado de una columna.
• Filtrar registros. Refine la visualización estableciendo condiciones de filtro como intervalos de días o períodos personalizados, o introduciendo nombres de tareas principales completos o parciales en el cuadro de búsqueda. Para volver a la visualización estándar después de usar la búsqueda, borre el texto del cuadro de búsqueda.
• Exportar registros. Exporte los registros seleccionados o todos los registros a un archivo CSV para archivarlos o analizarlos posteriormente.
• Personalizar columnas. Adapte la visualización a sus necesidades agregando columnas no predeterminadas como IP de cliente y Etiquetas.
• Administrar etiquetas. Agregue, edite y elimine etiquetas para los registros de eventos a fin de mejorar la organización y el seguimiento de los registros.

Características de la visualización:

• Si una operación falla antes de completarse, es posible que la operación de registro no se complete en la base de datos. Por ejemplo, un registro de inicio no tiene un registro de detención correspondiente. En tales casos, el registro indica que falta información. Cuando se muestran los registros según los intervalos de tiempo, se muestran los registros incompletos si los datos coinciden con los criterios.

  Por ejemplo, si solicita registros de los últimos cinco días y un registro con una hora de inicio en los últimos cinco días no tiene una hora de finalización, se incluye.

• Cuando se utiliza un script que llama a cmdlets de PowerShell, si se crea una operación de bajo nivel sin especificar una operación principal de alto nivel, el registro de configuración crea una operación de alto nivel sustituta.

Generar informes

Puede generar informes CSV y HTML que contengan datos de registro de configuración.

• El informe CSV contiene todos los datos de registro de un intervalo de tiempo especificado. Los datos jerárquicos de la base de datos se aplanan en una única tabla CSV. Ningún aspecto de los datos tiene precedencia en el archivo. No se utiliza ningún formato y no se asume ninguna legibilidad humana. El archivo (denominado MyReport) contiene los datos en un formato universalmente consumible. Los archivos CSV se utilizan a menudo para archivar datos o como fuente de datos para una herramienta de informes o manipulación de datos como Microsoft Excel.
• El informe HTML proporciona una forma legible por humanos de los datos de registro para un intervalo de tiempo especificado. Proporciona una vista estructurada y navegable para revisar los cambios. Un informe HTML consta de dos archivos, denominados Resumen y Detalles. El Resumen enumera las operaciones de alto nivel: cuándo ocurrió cada operación, quién la realizó y el resultado. Al hacer clic en un enlace de Detalles junto a cada operación, se accede a las operaciones de bajo nivel en el archivo de Detalles, que proporciona información adicional.

Para generar un informe de registro de configuración, seleccione Registro en el panel de navegación de Studio y, a continuación, seleccione Crear informe personalizado en la barra de acciones.

• Seleccione el rango de fechas para el informe.
• Seleccione el formato del informe: CSV, HTML o ambos.
• Busque la ubicación donde desea guardar el informe.

Eliminar contenido del registro de configuración

Para eliminar el registro de configuración, debe tener ciertos permisos de administración delegada y de base de datos de SQL Server.

• Administración delegada: Debe tener un rol de administración delegada que permita la lectura de la configuración de la implementación. El rol de administrador completo tiene este permiso. Un rol personalizado debe tener la opción Solo lectura o Administrar seleccionada en la categoría Otros permisos.

  Para crear una copia de seguridad de los datos de registro de configuración antes de eliminarlos, el rol personalizado también debe tener la opción Solo lectura o Administrar seleccionada en la categoría Permisos de registro.

• Base de datos de SQL Server: Debe tener un inicio de sesión de SQL Server con permiso para eliminar registros de la base de datos. Hay dos maneras de hacerlo:

  • Utilice un inicio de sesión de base de datos de SQL Server con un rol de servidor sysadmin, que le permite realizar cualquier actividad en el servidor de la base de datos. Alternativamente, los roles de servidor serveradmin o setupadmin le permiten realizar operaciones de eliminación.

  • Si su implementación requiere más seguridad, utilice un inicio de sesión de base de datos que no sea sysadmin, asignado a un usuario de la base de datos que tenga permiso para eliminar registros de la base de datos.

    1. En SQL Server Management Studio, cree un inicio de sesión de SQL Server con un rol de servidor distinto de ‘sysadmin’.
    2. Asigne el inicio de sesión a un usuario en la base de datos. SQL Server crea automáticamente un usuario en la base de datos con el mismo nombre que el inicio de sesión.
    3. En la pertenencia a roles de base de datos, especifique al menos uno de los miembros del rol para el usuario de la base de datos: ConfigurationLoggingSchema_ROLE o dbowner.

    Para obtener más información, consulte la documentación de SQL Server Management Studio.

Para eliminar los registros de configuración:

1. Inicie sesión en Web Studio y seleccione Registro en el panel izquierdo.
2. Seleccione Eliminar registros en la barra de acciones.
3. Se le preguntará si desea crear una copia de seguridad de los registros antes de eliminarlos. Si elige crear una copia de seguridad, vaya a la ubicación donde se guarda el archivo de copia de seguridad. La copia de seguridad se crea como un archivo CSV.

Después de borrar los registros de configuración, la eliminación de registros es la primera actividad publicada en el registro vacío. Esa entrada proporciona detalles sobre quién eliminó los registros y cuándo.

Ver registros de API y PowerShell

Para supervisar las solicitudes de API realizadas durante la sesión actual, haga clic en la ficha API. Los registros de API se borran después de cerrar la sesión de Web Studio.

Para ver los comandos de PowerShell correspondientes a las acciones de interfaz de usuario que ha realizado durante el día, haga clic en la ficha PowerShell.

Asociar metadatos con registros de configuración

Puede adjuntar metadatos a los registros de configuración asociando un par name-value llamado MetadataMap con los registros de log.

Nota:

• Solo puede adjuntar metadatos a objetos de operación de alto nivel.
• Los metadatos se asocian con los registros existentes en el momento de la ejecución.

Establecer los metadatos

Ejecute el comando de PowerShell Set-LogHighLevelOperationMetadata para asociar un registro de log con el MetadataMap. Set-LogHighLevelOperationMetadata acepta los siguientes parámetros:

• Id: ID de la operación de alto nivel.
• InputObject: Las operaciones de alto nivel a las que añade los metadatos. Esta es una alternativa al parámetro Id donde se pasa un objeto de operación de alto nivel o una lista de objetos al comando de PowerShell.

• Name: Nombre de la propiedad de los metadatos que se van a añadir. La propiedad debe ser única para la operación de alto nivel especificada. La propiedad no puede contener ninguno de los siguientes caracteres ()\/;:#.*?=<>

  []”’.

• Value: Valor de la propiedad.
• Map: Diccionario de pares (nombre, valor) para las propiedades. Esta es una alternativa para establecer los metadatos utilizando los parámetros -Name y -Value.

Por ejemplo, para adjuntar los metadatos a todos los registros de log de alto nivel con Id 40, ejecute el siguiente comando de PowerShell:

Get-LogHighLevelOperation – Id 40 | Set-LogHighLevelOperationMetadata -Name A -Value B

Para adjuntar los metadatos al registro de alto nivel con el usuario abc@example.com, ejecute el siguiente comando de PowerShell:

Get-LogHighLevelOperation – User `abc@example.com` | Set-LogHighLevelOperationMetadata -Name C -Value D

Recuperar mediante los metadatos

Ejecute los siguientes comandos de PowerShell para usar los metadatos asociados y recuperar los registros de log:

• Buscar por clave y valor:

  Get-LogHighLevelOperation -Metadata "Key:Value"

• Buscar por valor cualquier clave:

  Get-LogHighLevelOperation -Metadata "*:Value"

• Buscar por clave y cualquier valor:

  Get-LogHighLevelOperation -Metadata "Key:*"

Eliminar los metadatos

Ejecute el comando de PowerShell Remove-LogHighLevelOperationMetadata para eliminar los metadatos asociados. Remove-LogHighLevelOperationMetadata acepta los siguientes parámetros:

• Id: ID de la operación de alto nivel.
• InputObject: Las operaciones de alto nivel a las que agrega los metadatos. Esta es una alternativa al parámetro Id donde se pasa un objeto de operación de alto nivel o una lista de objetos al comando de PowerShell.
• Name: Nombre de la propiedad de los metadatos que se van a eliminar. Establezca en $null para eliminar todos los metadatos del objeto especificado.
• Map: Diccionario de pares (nombre, valor) para las propiedades. Puede ser una tabla hash (creada con @{“name1” = “val1”; “name2” = “val2”}) o un diccionario de cadenas (creado con new-object “System.Collections.Generic.Dictionary[String, String]”). Se eliminan las propiedades cuyos nombres coinciden con las claves del mapa.