Rola Ansible New Relic

newrelic.newrelic_install to rola Ansible, która pomoże Ci w rozwijaniu możliwości obserwacji New Relic. Wykorzystuje New Relic CLI oraz repozytorium Open Installation New Relic.

Uwaga: Instalacja konkretnych wersji agenta nie jest wspierana, ta rola zawsze zainstaluje najnowszą wersję agenta New Relic.

Proszę, zapoznaj się z poniższymi sekcjami, aby poznać szczegóły dotyczące instalacji, jak zacząć, zmiennych roli, zależności oraz przykład playbooka Ansible pokazującego zastosowanie tej roli.

Jeśli potrzebujesz pomocy z Ansible dla systemu Windows, zerknij na Konfigurowanie hosta Windows w dokumentacji Ansible.

Instalacja

Ansible Galaxy

ansible-galaxy install newrelic.newrelic_install

Link do Galaxy

Upewnij się, że masz zainstalowane ansible.windows i ansible.utils, jeśli nie są już zainstalowane:

ansible-galaxy collection install ansible.windows ansible.utils

Instalacja ręczna

Jeśli chcesz użyć lokalnej kopii roli, sklonuj repozytorium i uruchom make w katalogu głównym projektu, aby skopiować to repozytorium do ~/.ansible/roles/newrelic.newrelic_install, umożliwiając roli zachowanie się, jakby była zainstalowana z Galaxy.

Jak zacząć

Po zainstalowaniu, dołącz rolę newrelic.newrelic_install do nowego lub istniejącego playbooka. Na przykład:

- name: Instalacja New Relic
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
  environment:
    NEW_RELIC_API_KEY: <klucz API>
    NEW_RELIC_ACCOUNT_ID: <ID konta>
    NEW_RELIC_REGION: <region>

Zmienne

Zmienne roli

targets (wymagana)

Lista celów instalacji do uruchomienia na hostach. Dostępne opcje to:

• infrastructure (Linux i Windows)
• logs (Linux i Windows)
• apm-php (Linux)
• apm-nodejs (Linux)
• apm-dotnet (Linux i Windows)
• apm-java (Linux)
• apache (Linux)
• mssql (Windows)
• mysql (Linux)
• nginx (Linux)

Ważne uwagi:

• Cel logs wymaga infrastructure, a błąd zostanie zgłoszony, jeśli logs zostanie określony bez infrastructure.
• Instalacja agenta apm-nodejs jest wspierana tylko dla aplikacji zarządzanych przez PM2. Aby zainstalować agenta za pomocą menedżera pakietów takiego jak npm lub yarn, proszę spojrzeć na nasze dokumenty.
• Instalacja agenta apm-dotnet dla systemu Windows jest wspierana tylko dla aplikacji hostowanych przez IIS. Instalacje w systemie Linux są wspierane tylko dla aplikacji .NET działających jako usługa systemd.
• Instalacja agenta apm-java wspiera Java działającą w Tomcat, Wildfly/Jboss oraz Jetty (samodzielnie). Należy pamiętać, że to jest ograniczona instalacja APM dla Javy, która wprowadza instrumentację niektórych serwerów aplikacji Java poprzez dynamiczne podłączanie za pomocą introspektora Java New Relic. Więcej szczegółów tutaj.
• Następujące integracje wymagają instalacji agenta infrastruktury:
  • apm-java
  • apache
  • mssql
  • mysql
  • nginx

tags (opcjonalna)

Pary klucz-wartość oznaczeń przekazywanych do instalacji.

install_timeout_seconds (opcjonalna)

Ustawia limit czasu dla zadania instalacji. Nadpisuje domyślny czas oczekiwania wynoszący 600 sekund.

verbosity (opcjonalna)

Opcje szczegółowości dla instalacji (debug lub trace). Zapisuje szczegółowy wynik do pliku dziennika na hoście.

Domyślne

Ustawione w defaults/main.yml:

• cli_install_url
• cli_install_download_location
• target_name_map
• verbosity_on_log_file_path_linux
• verbosity_on_log_file_path_windows
• default_install_timeout_seconds

Zmienne środowiskowe

Wartości są ustawiane pod słowem kluczowym environment w Twoim playbooku:

• NEW_RELIC_API_KEY (wymagany)
• NEW_RELIC_ACCOUNT_ID (wymagany)
• NEW_RELIC_REGION (opcjonalny: 'US' lub 'EU', domyślnie 'US')

Dodatkowo, opcjonalna zmienna HTTPS_PROXY może być ustawiona, aby włączyć proxy dla Twojej instalacji.

apm-php:

• NEW_RELIC_APPLICATION_NAME (opcjonalna) Nazwa aplikacji PHP do instrumentacji. Ta nazwa będzie wyświetlana w sekcji APM & Services New Relic. Jeśli zostanie pominięta, domyślnie zostanie ustawiona na PHP Application.

apache:

• NEW_RELIC_APACHE_STATUS_URL (opcjonalna) Adres URL do sprawdzania statusu serwera webowego Apache. Jest używane, aby upewnić się, że serwer Apache działa na hoście i jest w dobrym stanie przed próbą instalacji Apache On-Host Integration. Domyślnie: http://127.0.0.1/server-status?auto

mssql:

• NEW_RELIC_MSSQL_DB_HOSTNAME (opcjonalna) Nazwa hosta lub adres IP, na którym działa serwer MS SQL. Domyślnie używana jest odkryta nazwa hosta, jeśli nie podano.
• NEW_RELIC_MSSQL_DB_PORT (opcjonalna) Port, na którym nasłuchuje serwer MS SQL. Domyślnie jest to 1433.
• NEW_RELIC_MSSQL_DB_USERNAME (opcjonalna) Nazwa użytkownika do uzyskania dostępu do serwera MS SQL. Domyślnie ustawione na newrelic. Jeśli używasz użytkownika domenowego, użyj składni domain\user.
• NEW_RELIC_MSSQL_DB_PASSWORD (opcjonalna) Hasło dla podanego użytkownika SQL lub domenowego. Jeśli nie podano hasła, zostanie wygenerowane losowe hasło.
• NEW_RELIC_MSSQL_SQL_USERNAME (opcjonalna) Opcjonalne dane uwierzytelniające przekazywane do sqlcmd podczas tworzenia użytkownika SQL określonego przez NEW_RELIC_MSSQL_DB_USERNAME. Jeśli pominięte, używana będzie domyślna nazwa logowania.
• NEW_RELIC_MSSQL_SQL_PASSWORD (opcjonalna) Opcjonalne dane uwierzytelniające przekazywane do sqlcmd podczas tworzenia użytkownika SQL określonego przez NEW_RELIC_MSSQL_DB_USERNAME. Jeśli pominięte, używane będzie domyślne hasło logowania.
• NEW_RELIC_MSSQL_ENABLE_BUFFER_METRICS (opcjonalna) Włącz zbieranie metryk puli buforów. Domyślnie ustawione na true.
• NEW_RELIC_MSSQL_ENABLE_RESERVE_METRICS (opcjonalna) Włącz zbieranie metryk rezerwacji przestrzeni partycji bazy danych. Domyślnie ustawione na true.

mysql:

• NEW_RELIC_MYSQL_PORT (opcjonalna) Domyślnie ustawiona na 3306, jeśli nie podano.
• NEW_RELIC_MYSQL_USERNAME (opcjonalna) Domyślnie ustawiona na newrelic, jeśli nie podano innej. To jest nazwa użytkownika, którą integracja mysql ustawi i która zostanie również ustawiona w pliku konfiguracyjnym integracji (np. mysql-config.yml) do celów raportowania danych. Więcej informacji w integracji MySQL.
• NEW_RELIC_MYSQL_PASSWORD (opcjonalna) Hasło dla użytkownika określonego w NEW_RELIC_MYSQL_USERNAME. Więcej informacji w integracji MySQL.
• NEW_RELIC_MYSQL_ROOT_PASSWORD (wymagana) Integracja mysql potrzebuje dostępu do mysql, aby utworzyć odpowiednie dane uwierzytelniające.

Zobacz zdalne środowisko ansible po więcej informacji.

Kompatybilność wersji

• Ansible: Testowane z wersjami Ansible Core 2.13 i 2.14. Wersje Ansible Core przed 2.10 nie są wspierane.
• Python: Testowane z Pythonem 3.10.

Zależności

Wymagania Pythona: requirements.txt

Wymagania Ansible: requirements.yml

Przykład Playbooka

- name: Instalacja New Relic
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
        install_timeout_seconds: 1000
        verbosity: debug
  environment:
    NEW_RELIC_API_KEY: <klucz API>
    NEW_RELIC_ACCOUNT_ID: <ID konta>
    NEW_RELIC_REGION: <region>
    NEW_RELIC_APPLICATION_NAME: "Moja Aplikacja"
    HTTPS_PROXY: "http://my.proxy:8888"

• Znajdź swój klucz użytkownika: Interfejs kluczy API

• Znajdź swoje ID konta: Dokumentacja ID konta

Wsparcie

New Relic tworzy i moderuje forum online, gdzie klienci mogą współpracować z pracownikami New Relic oraz innymi klientami, aby uzyskać pomoc i dzielić się najlepszymi praktykami. Jak w każdym oficjalnym projekcie open source New Relic, istnieje powiązany temat społecznościowy w hubie explorerów New Relic. Możesz znaleźć temat/wątki tego projektu tutaj:

• Dokumentacja New Relic: Wszechstronne informacje na temat korzystania z naszej platformy
• Społeczność New Relic: Najlepsze miejsce, aby angażować się w pytania dotyczące rozwiązywania problemów
• Deweloper New Relic: Zasoby do budowy własnych aplikacji do obserwacji
• Uniwersytet New Relic: Szereg szkoleń online dla użytkowników New Relic na każdym poziomie
• Wsparcie techniczne New Relic: Wsparcie 24/7/365. Przeczytaj więcej o naszych ofertach wsparcia technicznego.

Wkład

Zachęcamy do przesyłania swoich uwag, aby ulepszyć rolę ansible newrelic.newrelic_install! Pamiętaj, że gdy przesyłasz swoje zapytanie o włączenie, musisz podpisać CLA, korzystając z kliknięcia poprzez CLA-Assistant. Musisz podpisać CLA tylko raz dla danego projektu.

Jeśli masz jakiekolwiek pytania, lub aby wykonać naszą korporacyjną CLA (która jest wymagana, jeśli Twój wkład jest w imieniu firmy), napisz do nas na opensource@newrelic.com.

Uwaga na temat luk w bezpieczeństwie

Jak opisano w naszej polityce bezpieczeństwa, New Relic jest zobowiązane do prywatności i bezpieczeństwa naszych klientów oraz ich danych. Wierzymy, że zapewnienie skoordynowanego ujawnienia przez badaczy bezpieczeństwa i współpraca ze społecznością bezpieczeństwa są ważnymi środkami do osiągnięcia naszych celów bezpieczeństwa.

Jeśli uważasz, że odkryłeś lukę bezpieczeństwa w tym projekcie lub jakimkolwiek produkcie lub witrynie New Relic, serdecznie zachęcamy do zgłoszenia tego do New Relic za pośrednictwem HackerOne.

Jeśli chciałbyś przyczynić się do tego projektu, zapoznaj się z tymi wskazówkami.

Wszystkim współpracownikom dziękujemy! Bez Waszego wkładu ten projekt nie byłby tym, czym jest dzisiaj.

Licencja

Ten projekt jest licencjonowany na podstawie Licencji Apache 2.0.