Registro de configuraciones
La función Registros de configuración (Configuration Logging) captura, en una base de datos, los cambios de configuración y las actividades de administración realizados en un sitio. Esta función está habilitada de forma predeterminada. Puede usar el contenido registrado para:
- Diagnosticar y solucionar problemas tras haberse realizado cambios de configuración. El registro proporciona un rastro de los pasos seguidos.
- Ayudar en la administración de cambios y en el seguimiento de las configuraciones.
- Realizar informes sobre las actividades administrativas.
Puede establecer las preferencias de la captura de registros, mostrar los registros de configuración y generar informes HTML y CSV desde Citrix Studio. Puede filtrar la presentación en pantalla de los registros por intervalos de fechas y por resultados de búsqueda de texto. Cuando está habilitado, el registro obligatorio impide que se hagan cambios de configuración a menos que sea posible registrarlos. Con los permisos adecuados, puede eliminar entradas de los registros de configuración. No se puede utilizar la función Registros de configuración para modificar su contenido.
La función Registros de configuración usa un SDK de PowerShell y el servicio Configuration Logging Service. El servicio Configuration Logging Service se ejecuta en todos los Controllers del sitio. Si un Controller falla, el servicio instalado en otro Controller pasa automáticamente a gestionar las solicitudes de captura de registros.
De forma predeterminada, la función Registros de configuración está habilitada y usa la base de datos que se crea en el momento de crear un sitio (la base de datos de configuración del sitio). Puede especificar otra ubicación para la base de datos. La base de datos de registros de configuración admite las mismas funciones de alta disponibilidad que la base de datos de configuración del sitio.
El acceso a los datos de los registros de configuración se controla mediante la administración delegada, con los permisos Modificar preferencias de registros y Ver registros de configuración.
Los registros de configuración toman el idioma 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 cambios de configuración y actividades de tipo administrativo iniciadas desde Studio, Director y scripts de PowerShell. Los ejemplos de cambios de configuración registrados incluyen trabajar con (crear, modificar, eliminar y asignar):
- Catálogos de máquinas
- Grupos de entrega (incluido cambiar la configuración de la 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 actividades de tipo administrativo que se registran:
- Administrar energía de una máquina virtual o un escritorio de usuario
- Cuando Studio o Director envían un mensaje a un usuario
Las siguientes operaciones no se registran:
- Operaciones autónomas, como el encendido de máquinas virtuales mediante la administración de agrupaciones.
- Acciones de directivas implementadas mediante la Consola de administración de directivas de grupo (GPMC); puede utilizar herramientas de Microsoft para ver los registros de estas acciones.
- Los cambios realizados en el Registro, los accesos realizados directamente en la base de datos o desde otros orígenes distintos de Studio, Director o PowerShell.
- Cuando se inicializa la implementación, los registros de configuración están disponibles cuando la primera instancia del servicio Configuration Logging Service se registra con el servicio de configuración (Configuration Service). Por lo tanto, las primeras fases de la configuración no se registran (por ejemplo, cuando el esquema de la base de datos se obtiene y se aplica o cuando un hipervisor se inicializa).
Administrar Registros de configuración
De forma predeterminada, Registros 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 usar otra ubicación para la base de datos de registros de configuración (y la base de datos de supervisión) por los siguientes motivos:
- Es probable que la estrategia de copia de seguridad para la base de datos de Registros de configuración sea distinta de la estrategia para la base de datos de configuración del sitio.
- El volumen de datos recopilados por los servicios de Registros de configuración (Configuration Logging) y de supervisión (Monitoring) puede afectar negativamente al espacio disponible en la base de datos de configuración del sitio.
- Elimina el punto de fallo único para las tres bases de datos.
Las ediciones del producto que no admiten los registros de configuración no tienen ningún nodo Registros en Studio.
Habilitar o inhabilitar los Registros de configuración y el registro obligatorio
De forma predeterminada, Registros de configuración (Configuration Logging) está habilitado, pero la captura obligatoria está inhabilitada.
- Inicie sesión en Web Studio y seleccione Registros en el panel de la izquierda.
- Seleccione Preferencias en la barra de acciones. El cuadro de diálogo Registros de configuración contiene información sobre las bases de datos e indica si los registros de configuración y el registro obligatorio están habilitados o inhabilitados.
-
Seleccione la acción pertinente:
Para habilitar Registros de configuración, seleccione Habilitar. Esta es la opción predeterminada. Si no se puede escribir en la base de datos, los datos de registros se descartan, aunque la operación sigue teniendo lugar.
Para inhabilitar Registros de configuración, seleccione Inhabilitar. Si la captura de registros estuvo habilitada previamente, los registros existentes se conservan y se pueden seguir consultando con el SDK de PowerShell.
Para habilitar la captura obligatoria de registros, seleccione Impedir cambios en la configuración si la base de datos no está disponible. No se permitirá ningún cambio de configuración o de tipo administrativo que normalmente se registraría, a menos que pueda registrarse en la base de datos de registros de configuración. Puede habilitar el registro obligatorio solo cuando Registros de configuración está habilitado; es decir, cuando Habilitar está seleccionado. Si el servicio de registros de configuración (Configuration Logging Service) falla y no se usa la alta disponibilidad, se asume que se aplica el registro obligatorio. En tales casos, las operaciones que normalmente se registrarían no se llevan a cabo.
Para inhabilitar la captura obligatoria de registros, seleccione Permitir cambios en la configuración si la base de datos no está disponible. Se permiten cambios de configuración y actividades de tipo administrativo incluso aunque no se pueda acceder a la base de datos de registros de configuración. Esta es la opción predeterminada.
Cambiar la ubicación de la base de datos de Registros de configuración
No se puede cambiar la ubicación de la base de datos cuando está habilitado el registro obligatorio, ya que el cambio de ubicación implica un breve intervalo de desconexión que no se puede registrar.
- Cree un servidor de base de datos mediante una versión compatible de SQL Server.
- Inicie sesión en Web Studio y seleccione Registros en el panel de la izquierda.
- Seleccione Preferencias en la barra de acciones.
- En el cuadro de diálogo “Preferencias de registros”, seleccione Cambiar base de datos de registros.
- En el cuadro de diálogo Cambiar base de datos de registros, especifique la ubicación del servidor que contiene el nuevo servidor de base de datos. Consulte Formatos de direcciones de bases de datos para conocer los formatos válidos.
- 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 mediante las credenciales del usuario actual de Studio. Si no puede, el sistema pedirá las credenciales del usuario de la base de datos. Studio carga el esquema de base de datos en la base de datos. (Las credenciales se conservan solo durante la creación de la base de datos.)
- Para crear la base de datos manualmente, haga clic en Generar script de base de datos. El script generado incluye instrucciones para crear manualmente la base de datos. Asegúrese de que la base de datos está vacía y de que al menos un usuario tiene permiso para acceder y cambiar la base de datos antes de cargar el esquema.
Los datos de registros de configuración de la base de datos anterior no se importarán en la nueva base de datos. Los registros no pueden combinarse desde ambas bases de datos al consultarlos. La primera entrada del registro en la nueva base de datos de registros de configuración indica que se ha producido un cambio en la base de datos, pero no identifica la base de datos anterior.
Mostrar el contenido de los registros de configuración
Cuando se inician cambios de configuración y actividades de tipo administrativo, las operaciones de alto nivel creadas con Studio y Director se muestran en el panel central superior de Studio. Una operación de alto nivel tiene como resultado la llamada a uno o varios servicios y SDK, que son operaciones de bajo nivel. Cuando se selecciona una operación de alto nivel en el panel superior, el panel inferior muestra las operaciones de bajo nivel.
Si la operación falla antes de completarse, la operación de registro puede no completarse en la base de datos. Por ejemplo: puede que una entrada inicial no tenga una entrada final. En estos casos, el registro indica que hay información que falta. Cuando se muestran registros correspondientes a intervalos de tiempo, los registros incompletos se muestran si los datos cumplen los requisitos. Por ejemplo: si se solicitan todos los registros de los últimos cinco días y hay un registro con una hora de inicio dentro de esos cinco días, pero no tiene hora de fin, será incluido de todos modos.
Cuando se utiliza un script que llama a los cmdlets de PowerShell, si se crea una operación de bajo nivel sin especificar su correspondiente operación de alto nivel, el servicio de registros de configuración (Configuration Logging) creará una operación de alto nivel suplente.
Para ver el contenido de los registros de configuración, seleccione Registros en el panel de navegación de Studio. De forma predeterminada, el panel central muestra el contenido de las entradas de los registros por orden cronológico (primero las entradas más recientes), separadas por su fecha. Puede hacer lo siguiente:
- Ordenar los elementos en pantalla por el encabezado de la columna.
- Filtrar los elementos en pantalla mediante un intervalo de un día o texto en el cuadro Buscar. Para volver a la versión estándar después de utilizar la búsqueda, borre el texto del cuadro Buscar.
- Elija qué columnas aparecerán en la pantalla. Para ello, seleccione el icono Columnas que mostrar en la esquina superior derecha de la tabla. Por ejemplo, para ver la dirección IP que usa el administrador para acceder a Web Studio, haga clic en el icono y agregue la columna IP de cliente.
Generar informes
Puede generar informes CSV y HTML que contengan los datos de los registros de configuración.
- El informe CSV es un volcado de todos los datos de registros correspondientes a un intervalo de tiempo específico. Los datos jerárquicos en la base de datos se vuelcan sin estructura en una sola tabla CSV. Ningún aspecto de los datos tiene prioridad en la tabla. No se utiliza ningún tipo de formato y no se supone ningún tipo de legibilidad humana. El archivo (denominado MyReport) contiene datos en formato universalmente consumible. Los archivos CSV se usan a menudo para archivos históricos o como fuentes de datos para alguna herramienta de gestión de datos o de creación de informes como Microsoft Excel.
- El informe HTML presenta los datos de registros correspondientes a un intervalo de tiempo, en un formato legible para las personas. Proporciona una vista estructurada y explorable donde se pueden consultar los cambios. Un informe HTML consta de dos archivos, llamados Resumen y Detalles. El archivo de Resumen consiste en una lista de las operaciones de alto nivel: cuándo ocurrió cada operación, quién la realizó y el resultado de esta. Cuando se hace clic en el enlace Detalles junto a cada operación, se abre el archivo de Detalles con las operaciones de bajo nivel asociadas, que ofrecen información adicional sobre la operación.
Para generar un informe de registros de configuración, seleccione Registros en el panel de navegación de Studio y, a continuación, seleccione Crear informe personalizado en la barra de acciones.
- Seleccione el intervalo de fechas del informe.
- Seleccione el formato del informe: CSV, HTML o ambos.
- Busque la ubicación donde quiere guardar el informe.
Eliminar contenido de los registros de configuración
Para eliminar el registro de configuración, debe tener ciertos permisos de administración delegada y permisos para la base de datos de SQL Server.
-
Administración delegada: Debe tener un rol de administración delegada que le permita leer la configuración de la implementación. El rol Administrador total tiene ese permiso. Si se trata de un rol personalizado, éste debe tener seleccionados Solo lectura o Administrar en la categoría Otros permisos.
Para crear una copia de seguridad de los datos de registros de configuración antes de eliminarlos, el rol personalizado también debe tener seleccionados Solo lectura o Administrar en la categoría de Permisos para registros.
-
Base de datos SQL Server: Debe tener unas credenciales de inicio de sesión de SQL Server con permiso para eliminar registros de la base de datos. Hay dos formas de hacerlo:
-
Usar unas credenciales para la base de datos SQL Server con un rol sysadmin de servidor, que permite realizar cualquier actividad en el servidor de la base de datos. De forma alternativa, los roles
serveradminosetupadminde servidor permiten realizar operaciones de eliminación. -
Si la implementación requiere más seguridad, use unas credenciales de base de datos que no sean de sysadmin asignadas a un usuario de la base de datos que tenga permisos para eliminar registros de esta.
- En SQL Server Management Studio, cree unas credenciales de inicio de sesión de SQL Server con un rol de servidor que no sea ‘sysadmin’.
- Asigne esas credenciales de inicio de sesión a un usuario de la base de datos. SQL Server crea automáticamente un usuario en la base de datos con el mismo nombre que esas credenciales.
- En Pertenencia al rol de la base de datos, especifique al menos uno de los miembros de rol para el usuario de la base de datos:
ConfigurationLoggingSchema_ROLEodbowner.
Para obtener información adicional, consulte la documentación sobre SQL Server Management Studio.
-
Para eliminar los registros de configuración:
- Inicie sesión en Web Studio y seleccione Registros en el panel de la izquierda.
- Seleccione Eliminar registros en la barra de acciones.
- Verá la opción para crear una copia de seguridad de los registros antes de eliminarlos. Si decide crear una copia de seguridad, vaya a la ubicación donde se guarda la copia archivada. La copia de seguridad se crea como un archivo CSV.
Una vez eliminados los registros de configuración, la eliminación de los registros es la primera actividad que se anotará en el nuevo registro vacío. Esa entrada proporciona información acerca de quién y cuándo eliminó los registros.
Ver los 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 sesión en Web Studio.
Para ver los comandos de PowerShell correspondientes a las acciones de interfaz de usuario que realizó durante el día, haga clic en la ficha PowerShell.
Asociar metadatos a registros de configuración
Puede adjuntar metadatos a los registros de configuración asociando un par name-value llamado MetadataMap a los registros de registro.
Nota:
- Solo puede adjuntar metadatos a objetos de operaciones de alto nivel.
- Los metadatos se asocian a los registros existentes en el momento de la ejecución.
Establecer los metadatos
Ejecute el comando Set-LogHighLevelOperationMetadata de PowerShell para asociar un registro a MetadataMap.
Set-LogHighLevelOperationMetadata toma los siguientes parámetros:
- Id: ID de la operación de alto nivel.
-
InputObject: Las operaciones de alto nivel a las que se agregan los metadatos. Esta es una alternativa al parámetro
Id, en el que 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 por agregar. 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.
-
Mapa: Diccionario de pares (nombre, valor) para las propiedades. Esta es una alternativa a configurar los metadatos mediante los parámetros
-Namey-Value.
Por ejemplo, para adjuntar los metadatos a todos los registros de registro de alto nivel con el 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
Obtención con los metadatos
Ejecute los siguientes comandos de PowerShell para usar los metadatos asociados para obtener los registros:
-
Búsqueda por clave y valor:
Get-LogHighLevelOperation -Metadata "Key:Value" -
Búsqueda por valor y cualquier clave:
Get-LogHighLevelOperation -Metadata "*:Value" -
Búsqueda por clave y cualquier valor:
Get-LogHighLevelOperation -Metadata "Key:*"
Quitar los metadatos
Ejecute el comando Remove-LogHighLevelOperationMetadata de PowerShell para quitar los metadatos asociados.
Remove-LogHighLevelOperationMetadata toma los siguientes parámetros:
- Id: ID de la operación de alto nivel.
-
InputObject: Las operaciones de alto nivel a las que se agregan los metadatos. Esta es una alternativa al parámetro
Id`, en el que 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 por quitar. Establézcalo en $null para quitar todos los metadatos del objeto especificado.
- Mapa: Diccionario de pares (nombre, valor) para las propiedades. Puede ser una tabla hash (creada con @{“nombre1” = “val1”; “nombre2” = “val2”}) o un diccionario de cadenas (creado con el nuevo objeto “System.Collections.Generic.Dictionary[Cadena, Cadena]”). Se quitan las propiedades cuyos nombres coinciden con las claves del mapa.
En este artículo
- Qué se registra
- Administrar Registros de configuración
- Habilitar o inhabilitar los Registros de configuración y el registro obligatorio
- Cambiar la ubicación de la base de datos de Registros de configuración
- Mostrar el contenido de los registros de configuración
- Generar informes
- Eliminar contenido de los registros de configuración
- Ver los registros de API y PowerShell
- Asociar metadatos a registros de configuración