rol de winlogbeat

Resumen

Este rol:

• instala winlogbeat en Windows
• copia el archivo de configuración preparado (ruta del log, conexión a elasticsearch, etc.)

Tareas del rol

• [Opcional] Crear carpeta(s) para rutas personalizadas
• Instalar winlogbeat
• Copiar el archivo de configuración

Requisitos

• Versión mínima de Ansible para la instalación: 2.8
• Sistemas Operativos soportados:
  • Windows
    • 2016
    • 2019

Variables del Rol

Puedes sobreescribir cualquiera de las variables a continuación estableciendo "variable: valor" en el playbook.

• winlogbeat_version Se usa para seleccionar la rama principal de Winlogbeat que se instalará. El valor predeterminado es 7.
• winlogbeat_last_version Se usa para seleccionar una versión específica de Winlogbeat para instalar. El valor predeterminado es 7.4.2
• winlogbeat_node_name Nombre del nodo de winlogbeat. El valor predeterminado es {{ inventory_hostname }}. Si esta opción no está definida, se utiliza el nombre del host.
• winlogbeat_ssl_enabled Activa/desactiva la conexión SSL entre winlogbeat y logstash/elasticsearch. Las opciones SSL deben ser configuradas mediante los campos correspondientes como se muestra a continuación:

  ssl:
    key: 'c:\tls\private\server.key'
    certificate: 'c:\tls\certs\server.pem'
    certificate_authorities: 'c:\CA\ca-root.pem'

La sección path de las opciones de configuración define dónde Winlogbeat busca sus archivos. Por ejemplo, Winlogbeat busca el archivo de plantilla de Elasticsearch en la ruta de configuración y escribe archivos de log en la ruta de logs. Winlogbeat busca sus archivos de registro en la ruta de datos. Los valores predeterminados para un host de Linux están configurados de la siguiente manera:

path:
  home: 'c:\program files\winlogbeat'
  config: 'c:\program files\winlogbeat'
  data: 'c:\programdata\winlogbeat'
  logs: 'c:\programdata\winlogbeat\logs'

• win_download_path Directorio temporal para Windows para descargar y descomprimir el paquete de Winlogbeat. El valor predeterminado es '{{ ansible_env.TEMP }}/winlogbeat' (el valor de ansible_env.TEMP resuelve el problema de idempotencia)

Personalización de salida:

• winlogbeat_output Se usa para configurar qué salida utilizar al enviar datos (elasticsearch o logstash). El valor predeterminado es elasticsearch

• elasticsearch.host Array de hosts a los que conectarse. El valor predeterminado es localhost

• elasticsearch.port Valor para establecer un puerto personalizado. El valor predeterminado es 9200

• logstash.host Array de hosts a los que conectarse. El valor predeterminado es localhost

• logstash.port Valor para establecer un puerto personalizado. El valor predeterminado es 5044

Parámetros de configuración avanzados:

La sección winlogbeat(systemd)\initd de las opciones de configuración define qué script de inicio se utilizará para gestionar el servicio winlogbeat dependiendo del sistema operativo *nix. Se tendrán en cuenta las rutas personalizadas (si están configuradas).

• winlogbeat_service_name Nombre del script de nssm\init que gestiona el servicio winlogbeat

• winlogbeat_bulk_max_size Número máximo de eventos para agrupar en una sola solicitud de Logstash. El valor predeterminado es 500

• winlogbeat_worker Número de trabajadores por host de Elasticsearch. El valor predeterminado es 1

• winlogbeat_logging_to_syslog Enviar toda la salida de registro a syslog. El valor predeterminado es false

• winlogbeat_logging_to_files Enviar toda la salida de registro a archivos rotativos. El valor predeterminado es true

• winlogbeat_rotateeverybytes Define el límite de tamaño del archivo de log. El valor predeterminado es 104857600 = 100MB

• winlogbeat_keepfiles Número de archivos de log a mantener. El valor predeterminado es 30

• winlogbeat_ignore_older Valor (cualquier cadena de tiempo como 2h, 5m se puede usar) por encima del cual se ignorarán los registros. El valor predeterminado es 0 (deshabilitado)

• winlogbeat_logname Nombre de los archivos de registro. El valor predeterminado es "winlogbeat.log"

Dependencias

ca-cert (solo para instalación con SSL)

Ejemplo de Playbook

Instalando la versión 7.x de Winlogbeat:

- name: Instalar winlogbeat
  hosts: all
  roles:
    - role: lean_delivery.winlogbeat

Licencia

Apache

Información del Autor

autores:

• Lean Delivery Team team@lean-delivery.com