Saltar al contenido principal

Registros

Semaphore escribe los registros del servidor en stdout y almacena los registros de Tareas y de Actividad en una base de datos, centralizando la información clave de los registros y eliminando la necesidad de hacer copias de seguridad de los archivos de registro por separado. Los únicos datos almacenados en el sistema de archivos son los datos de caché.

Registro del servidor​

Semaphore no escribe registros en archivos. En su lugar, todos los registros de la aplicación se escriben en stdout.
Si Semaphore se ejecuta como servicio de systemd, puede ver los registros con el siguiente comando:

journalctl -u semaphore.service -f

Si Semaphore se ejecuta en un contenedor Docker, puede ver los registros con el siguiente comando:

docker logs -f my-semaphore-container

Esto proporciona una vista en vivo (en streaming) de los registros.

Registro de actividad​

El Registro de actividad captura acciones de usuario realizadas en Semaphore, incluidas:

  • Añadir o eliminar recursos (p. ej., Plantillas, Inventarios, Repositorios).
  • Añadir o eliminar miembros del equipo.

Versión Pro 2.10 y posteriores Pro​

Semaphore Pro 2.10+ permite escribir el Registro de actividad y el registro de Tareas en un archivo. Para habilitarlo, añada la siguiente configuración a su config.json:

{
  "log": {
    "events": {
      "enabled": true,
      "logger": {
        "filename": "./events.log"
        // other logger options
      }
    },
    "tasks": {
      "enabled": true,
      "logger": {
        "filename": "./tasks.log"
        // other logger options
      },
			"result_logger": {
				"filename": "./task_results.log"
        // other logger options
			}
    }
  }
}

O puede hacerlo mediante las siguientes variables de entorno:

export SEMAPHORE_EVENT_LOG_ENABLED=True
export SEMAPHORE_EVENT_LOGGER={"filename": "./events.log"}

export SEMAPHORE_TASK_LOG_ENABLED=True
export SEMAPHORE_TASK_LOGGER={"filename": "./tasks.log"}

Opciones de registro de actividad (eventos)​

Las opciones de registro de actividad (eventos) permiten configurar cómo Semaphore registra en un archivo las acciones de usuario y los eventos del sistema. Estos ajustes controlan el comportamiento del registro de eventos, incluido si está habilitado, el formato de las entradas de registro y la configuración específica del logger. Cuando está habilitado, las acciones de usuario como crear plantillas o gestionar equipos se escribirán en el archivo de registro especificado según estos ajustes.

ParámetroVariables de entornoDescripción
enabledSEMAPHORE_EVENT_LOG_ENABLEDHabilita el registro de eventos en archivo.
formatSEMAPHORE_EVENT_LOG_FORMATFormato de los registros. Déjelo vacío para formato raw o establézcalo en json.
loggerSEMAPHORE_EVENT_LOGGEROpciones del logger.

Opciones de registro de tareas​

Las opciones de registro de tareas permiten configurar cómo Semaphore registra en un archivo los detalles de ejecución de las tareas. Estos ajustes controlan el registro de los eventos relacionados con tareas, incluidos los inicios, las finalizaciones y su estado de ejecución. Cuando está habilitado, todas las operaciones de tareas y sus resultados se escribirán en el archivo de registro especificado según estos ajustes, proporcionando una traza de auditoría detallada del historial de ejecución de tareas.

ParámetroVariables de entornoDescripción
enabledSEMAPHORE_TASK_LOG_ENABLEDHabilita el registro de tareas en archivo.
formatSEMAPHORE_TASK_LOG_FORMATFormato de los registros. Déjelo vacío para formato raw o establézcalo en json.
loggerSEMAPHORE_TASK_LOGGEROpciones del logger.
result_loggerSEMAPHORE_TASK_RESULT_LOGGEROpciones del logger.

Opciones del logger​

ParámetroTipoDescripción
filenameStringRuta y nombre del archivo en el que se escriben los registros. Los archivos de registro de respaldo se conservarán en el mismo directorio. Si está vacío, se usa processname-lumberjack.log en el directorio temporal.
maxsizeIntegerTamaño máximo en megabytes del archivo de registro antes de rotarlo. El valor predeterminado es 100 megabytes.
maxageIntegerNúmero máximo de días que se conservan los archivos de registro antiguos, según la marca de tiempo codificada en su nombre de archivo. Tenga en cuenta que un día se define como 24 horas y puede no corresponder exactamente con los días naturales debido al horario de verano, segundos intercalares, etc. De forma predeterminada no se eliminan archivos de registro antiguos por antigüedad.
maxbackupsIntegerNúmero máximo de archivos de registro antiguos que se conservan. De forma predeterminada se conservan todos los archivos de registro antiguos (aunque MaxAge puede seguir provocando su eliminación).
localtimeBooleanDetermina si la hora utilizada para formatear las marcas de tiempo en los archivos de respaldo es la hora local del equipo. De forma predeterminada se usa la hora UTC.
compressBooleanDetermina si los archivos de registro rotados deben comprimirse con gzip. De forma predeterminada no se realiza compresión.

Cada línea del archivo sigue este formato:

2024-01-03 12:00:34 user=234234 object=template action=delete

Historial de tareas​

Semaphore almacena en la base de datos la información sobre la ejecución de tareas. El historial de tareas ofrece una vista detallada de todas las tareas ejecutadas, incluido su estado y sus registros. Puede supervisar las tareas en tiempo real o revisar los registros históricos a través de la interfaz web.

Configurar la retención de tareas​

De forma predeterminada, Semaphore almacena todas las tareas en la base de datos. Si ejecuta un gran número de tareas, estas pueden ocupar una cantidad considerable de espacio en disco.

Puede configurar cuántas tareas se conservan por plantilla usando uno de los siguientes métodos:

  1. Variable de entorno 
    SEMAPHORE_MAX_TASKS_PER_TEMPLATE=30
  2. Opción en config.json 
    {
      "max_tasks_per_template": 30
    }

Cuando el número de tareas supera este límite, los registros de tareas más antiguos se eliminan automáticamente.

Compatibilidad con el protocolo syslog Enterprise​

Semaphore puede reenviar las entradas del registro de actividad y de tareas a un colector syslog externo para su almacenamiento a largo plazo o para una supervisión centralizada. El reenvío a syslog está deshabilitado de forma predeterminada.

Configure la compatibilidad con syslog en config.json:

"syslog": {
  "enabled": true,
  "network": "udp",
  "address": "logs.example.com:514",
  "tag": "semaphore"
}

Las mismas opciones están disponibles mediante variables de entorno si prefiere no editar el archivo JSON:

SEMAPHORE_SYSLOG_ENABLED=true
SEMAPHORE_SYSLOG_NETWORK=udp
SEMAPHORE_SYSLOG_ADDRESS=logs.example.com:514
SEMAPHORE_SYSLOG_TAG=semaphore

Opciones de syslog​

ParámetroVariables de entornoDescripción
enabledSEMAPHORE_SYSLOG_ENABLEDActiva o desactiva el reenvío a syslog.
networkSEMAPHORE_SYSLOG_NETWORKProtocolo utilizado para llegar al colector, como udp o tcp.
addressSEMAPHORE_SYSLOG_ADDRESSDirección del colector en formato host:port.
tagSEMAPHORE_SYSLOG_TAGIdentificador opcional que se antepone a cada mensaje.

Reinicie el servicio de Semaphore después de cambiar estos valores para que se aplique el nuevo destino de syslog.

Integración con SIEM​

Los inicios de sesión y los cambios en las cuentas, como nuevos usuarios, roles y tokens de API, pueden guardarse en el registro de auditoría. Semaphore Pro puede enviarlo a un SIEM.

Resumen​

  • Registro del servidor: se escribe en stdout; puede verse con journalctl si se ejecuta bajo systemd.
  • Registro de actividad y tareas: registra todas las acciones de usuario. Opcionalmente, Pro 2.10+ puede escribirlos en un archivo.
  • Historial de tareas: almacena los registros de ejecución de tareas en tiempo real e históricos. La retención se puede configurar por plantilla.
  • Registro de auditoría: registra los inicios de sesión y los cambios en las cuentas. Desactivado por defecto.

Seguir estas pautas garantiza una visibilidad adecuada de las operaciones de Semaphore UI, a la vez que se controla el uso de almacenamiento y la retención de registros.