Desplegar el Agente LogDNA con Ansible

Descripción

Rol de Ansible Galaxy para instalar y configurar el Agente LogDNA.

Requisitos

• Versión de Ansible: >=2.1
• Probado en los siguientes sistemas operativos:
  • CentOS 6
  • CentOS 7
  • Ubuntu 12.04 - Precise
  • Ubuntu 14.04 - Trusty
  • Ubuntu 16.04 - Xenial
  • Ubuntu 17.10 - Artful
  • Debian 8 - Jessie

Variables del Rol

Variables Específicas de Tareas

• agent_install: true si se debe instalar (valor predeterminado: true)
• agent_config: true si se debe configurar (valor predeterminado: true)
• agent_service: (valor predeterminado: started), soporta:
  • started: para iniciar el Servicio del Agente LogDNA si se especifica conf_key
  • restarted: para reiniciar el Servicio del Agente LogDNA
  • stopped: para detener el Servicio del Agente LogDNA.

Variables de Configuración

Estas variables se relacionan directamente con las opciones de configuración nativas para el Agente LogDNA:

• conf_key: Clave de Ingestión de LogDNA - el servicio del Agente LogDNA no se iniciará si no se especifica conf_key
• conf_config: Ruta del archivo para la configuración del Agente LogDNA (valor predeterminado: /etc/logdna.conf)
• conf_logdir: Directorios de registro a agregar
• conf_logfile: Archivos de registro a agregar
• conf_exclude: Archivos o directorios de registro a excluir
• conf_exclude_regex: Regla de exclusión para líneas de registro
• conf_hostname: Nombre de host alternativo a usar
• conf_tags: Etiquetas a agregar.

Cómo Instalar

• En línea desde Ansible Galaxy: ansible-galaxy install logdna.logdna
• Directamente desde el código fuente: ansible-galaxy install git+https://github.com/logdna/ansible-logdna.git

Ejemplo de Playbook

- hosts: <hosts>
  vars:
    conf_key: <Clave de Ingestión de LogDNA>
  roles:
     - { role: logdna.logdna }

Casos de Uso

• Para instalar, configurar y comenzar el servicio en los hosts especificados:

- hosts: <hosts>
  vars:
    conf_key: <Clave de Ingestión de LogDNA>
    # Todas las demás especificaciones de parámetros de configuración
  roles:
     - { role: logdna.logdna }

• Para reconfigurar y reiniciar el servicio en los hosts especificados:

- hosts: <hosts>
  vars:
    # especificaciones de parámetros de reconfiguración
    agent_service: restarted
  roles:
     - { role: logdna.logdna }

• Solo instalar pero no configurar o tocar el servicio:

- hosts: <hosts>
  vars:
    # no establecer la Clave de Ingestión de LogDNA
    agent_config: false
  roles:
     - { role: logdna.logdna }

• Detener el servicio:

- hosts: <hosts>
  vars:
    agent_install: false
    agent_config: false
    agent_service: stopped
  roles:
     - { role: logdna.logdna }

Plugin de Callback de LogDNA

El Plugin de Callback de LogDNA es un controlador para enviar los registros de cada ejecución de ansible-playbook a LogDNA. En este momento, soporta las siguientes categorías de registros: STATS, FAILED, OK, UNREACHABLE, ASYNC_FAILED, ASYNC_OK. Se puede configurar de la siguiente manera:

• Si el paquete Python del Agente LogDNA no está instalado, instálelo usando uno de los siguientes comandos según la versión de Python que esté utilizando: pip install logdna o pip3 install logdna
• Si la versión de Ansible que está utilizando es anterior a v2.6 (es decir, <= v2.5), haga lo siguiente:
  • Descargue el plugin desde aquí en la carpeta de plugins de callback. Puede encontrar la carpeta con el siguiente comando: echo $(ansible-doc -F | awk 'FNR == 1 {print $2}' | sed 's/\/modules/+/g' | cut -d'+' -f 1)/plugins/callback
• Si no hay un ansible.cfg en su sistema, haga los siguientes pasos:
  • Asegúrese de que exista la carpeta /etc/ansible ejecutando mkdir -p /etc/ansible
  • Descargue ansible.cfg desde aquí en /etc/ansible/
• Ejecute ANSIBLE_CONFIG=< Ruta al ansible.cfg >
• Abra ansible.cfg y haga los siguientes pasos:
  • Descomente la línea que contiene callback_whitelist, si está comentada, y agregue logdna
  • Descomente la línea que contiene callback_plugins, si está comentada, y actualice la ruta a los Plugins de Callback
• Para que el plugin funcione, se deben establecer las siguientes variables ambientales:
  • LOGDNA_INGESTION_KEY: Clave de Ingestión de LogDNA para transmitir los registros - obligatoria
  • ANSIBLE_IGNORE_ERRORS: Si se deben ignorar los errores en caso de fallo o no; False por defecto - opcional
  • LOGDNA_HOSTNAME: Nombre de host alternativo a usar en los registros - opcional
  • LOGDNA_TAGS: Lista de etiquetas separadas por comas; ansible por defecto - opcional

Contribuciones

Las contribuciones siempre son bienvenidas. Consulte la guía de contribuciones para aprender cómo puede ayudar.

Licencia y Autores

• Autor: Samir Musali, LogDNA
• Licencia: MIT