Wdrażanie agenta LogDNA za pomocą Ansible

Opis

Rola Ansible Galaxy do instalacji i konfiguracji agenta LogDNA

Wymagania

• Wersja Ansible: >=2.1
• Przetestowane na następujących systemach operacyjnych:
  • CentOS 6
  • CentOS 7
  • Ubuntu 12.04 - Precise
  • Ubuntu 14.04 - Trusty
  • Ubuntu 16.04 - Xenial
  • Ubuntu 17.10 - Artful
  • Debian 8 - Jessie

Zmienne roli

Zmienne specyficzne dla zadań

• agent_install: true jeśli ma być zainstalowany (domyślnie: true)
• agent_config: true jeśli ma być skonfigurowany (domyślnie: true)
• agent_service: (domyślnie: started), wspierające:
  • started: aby uruchomić usługę agenta LogDNA, jeśli conf_key jest określony
  • restarted: aby zrestartować usługę agenta LogDNA
  • stopped: aby zatrzymać usługę agenta LogDNA.

Zmienne konfiguracyjne

Te zmienne odpowiadają bezpośrednio opcjom konfiguracyjnym dla agenta LogDNA:

• conf_key: Klucz Ingestji LogDNA - usługa agenta LogDNA nie uruchomi się, jeśli conf_key nie jest określony
• conf_config: Ścieżka do pliku konfiguracyjnego agenta LogDNA (domyślnie /etc/logdna.conf)
• conf_logdir: Katalogi logów do dodania
• conf_logfile: Pliki logów do dodania
• conf_exclude: Pliki logów lub katalogi do wykluczenia
• conf_exclude_regex: Reguła wykluczenia dla linii logów
• conf_hostname: Alternatywna nazwa hosta do użycia
• conf_tags: Tag do dodania.

Jak zainstalować

• Online z Ansible Galaxy: ansible-galaxy install logdna.logdna
• Bezpośrednio z kodu źródłowego: ansible-galaxy install git+https://github.com/logdna/ansible-logdna.git

Przykładowy plik playbook

- hosts: <hosts>
  vars:
    conf_key: <Klucz Ingestji LogDNA>
  roles:
     - { role: logdna.logdna }

Przykłady użycia

• Aby zainstalować, skonfigurować i uruchomić usługę na określonych hostach:

- hosts: <hosts>
  vars:
    conf_key: <Klucz Ingestji LogDNA>
    # Wszystkie inne specyfikacje parametrów konfiguracyjnych
  roles:
     - { role: logdna.logdna }

• Aby ponownie skonfigurować i zrestartować usługę na określonych hostach:

- hosts: <hosts>
  vars:
    # specyfikacje parametrów ponownej konfiguracji
    agent_service: restarted
  roles:
     - { role: logdna.logdna }

• Aby tylko zainstalować, ale nie konfigurować ani nie dotykać usługi:

- hosts: <hosts>
  vars:
    # nie ustawiaj Klucza Ingestji LogDNA
    agent_config: false
  roles:
     - { role: logdna.logdna }

• Aby zatrzymać usługę:

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

Wtyczka Callback LogDNA

Wtyczka Callback LogDNA to narzędzie do wysyłania logów z każdego uruchomienia ansible-playbook do LogDNA. Obecnie wspiera następujące kategorie logów: STATS, FAILED, OK, UNREACHABLE, ASYNC_FAILED, ASYNC_OK. Można ją skonfigurować w następujący sposób:

• Jeśli pakiet Python LogDNA Agent nie jest zainstalowany, proszę zainstalować go za pomocą jednego z następujących poleceń, w zależności od wersji Pythona, której używasz: pip install logdna lub pip3 install logdna
• Jeśli używana wersja Ansible jest starsza niż v2.6 (tj. <= v2.5), wykonaj następujący krok:
  • Pobierz wtyczkę stąd tutaj do folderu wtyczek callback. Możesz znaleźć folder za pomocą tego polecenia: echo $(ansible-doc -F | awk 'FNR == 1 {print $2}' | sed 's/\/modules/+/g' | cut -d'+' -f 1)/plugins/callback
• Jeśli nie ma ansible.cfg na twoim systemie, wykonaj następujące kroki:
  • Upewnij się, że folder /etc/ansible istnieje, używając mkdir -p /etc/ansible
  • Pobierz ansible.cfg stąd tutaj do /etc/ansible/
• Użyj ANSIBLE_CONFIG=< Ścieżka do ansible.cfg >
• Otwórz ansible.cfg i wykonaj następujące kroki:
  • Odkomentuj linię zawierającą callback_whitelist, jeśli była zakomentowana, i dodaj logdna
  • Odkomentuj linię zawierającą callback_plugins, jeśli była zakomentowana, i zaktualizuj ścieżkę do wtyczek callback
• Aby wtyczka działała, należy ustawić następujące zmienne środowiskowe:
  • LOGDNA_INGESTION_KEY: Klucz Ingestji LogDNA w celu przesyłania logów - wymagane
  • ANSIBLE_IGNORE_ERRORS: Czy ignorować błędy przy niepowodzeniu, czy nie; Fałsz domyślnie - opcjonalne
  • LOGDNA_HOSTNAME: Alternatywna nazwa hosta do użycia w logach - opcjonalne
  • LOGDNA_TAGS: Lista tagów oddzielonych przecinkiem; ansible domyślnie - opcjonalne

Wkład

Wszelkie wkłady są zawsze mile widziane. Zobacz przewodnik po wkładzie, aby dowiedzieć się, jak możesz pomóc.

Licencja i autorzy

• Autor: Samir Musali, LogDNA
• Licencja: MIT