New Relic Ansible Rolle

newrelic.newrelic_install ist eine Ansible Rolle, die Ihnen hilft, Ihre Observability-Bemühungen mit New Relic zu skalieren. Sie nutzt die New Relic CLI und das New Relic Open Installation Repository, um dies zu erreichen.

Hinweis: Die Installation spezifischer Versionen eines Agenten wird nicht unterstützt. Diese Rolle installiert immer die neueste veröffentlichte Version eines New Relic Agenten.

Bitte schauen Sie sich die folgenden Abschnitte für Details zur Installation, zum Einstieg, zu den Variablen der Rolle, zu Abhängigkeiten und zu einem Beispiel-ansible playbook, das die Nutzung dieser Rolle demonstriert, an.

Wenn Sie Hilfe mit Ansible für Windows-OS benötigen, werfen Sie einen Blick auf Einrichten eines Windows-Hosts von der Ansible-Dokumentation.

Installation

Ansible Galaxy

ansible-galaxy install newrelic.newrelic_install

Link zu Galaxy

Stellen Sie sicher, dass Sie ansible.windows und ansible.utils haben, wenn diese noch nicht installiert sind:

ansible-galaxy collection install ansible.windows ansible.utils

Manuell

Wenn Sie eine lokale Kopie der Rolle verwenden möchten, klonen Sie das Repository und führen Sie make im Projektstammverzeichnis aus, um dieses Repository nach ~/.ansible/roles/newrelic.newrelic_install zu kopieren, damit die Rolle so funktioniert, als wäre sie aus Galaxy installiert worden.

Erste Schritte

Nach der Installation fügen Sie die Rolle newrelic.newrelic_install in ein neues oder bestehendes Playbook ein. Zum Beispiel:

- name: New Relic installieren
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
  environment:
    NEW_RELIC_API_KEY: <API-Schlüssel>
    NEW_RELIC_ACCOUNT_ID: <Kontonummer>
    NEW_RELIC_REGION: <Region>

Variablen

Rollenvariablen

targets (Erforderlich)

Liste der Zielinstallationen, die auf den Hosts ausgeführt werden sollen. Verfügbare Optionen sind:

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

Wichtige Hinweise:

• Das Ziel logs erfordert infrastructure, und es wird ein Fehler angezeigt, wenn logs ohne infrastructure angegeben wird.
• Die Installation des apm-nodejs Agents wird nur für Apps unterstützt, die von PM2 verwaltet werden. Weitere Informationen finden Sie in unseren Dokumenten.
• Die Installation des apm-dotnet Agents für Windows wird nur für von IIS gehostete Apps unterstützt. Linux-Installationen werden nur für .NET-Anwendungen unterstützt, die als systemd-Dienst ausgeführt werden.
• Die Installation des apm-java Agents unterstützt Java, das in Tomcat, Wildfly/Jboss und Jetty (standalone) läuft. Beachten Sie, dass dies eine eingeschränkte Java APM-Installation ist, die bestimmte Java-Anwendungsserver durch dynamische Anbindung mit dem Java-Introspektor von New Relic instrumentiert. Weitere Details finden Sie hier.
• Die folgenden Integrationen erfordern die Installation des Infrastruktur-Agenten:
  • apm-java
  • apache
  • mssql
  • mysql
  • nginx

tags (Optional)

Schlüssel-Wert-Paare von Tags, die bei der Installation übergeben werden.

install_timeout_seconds (Optional)

Setzt das Timeout für die Installationsaufgabe. Überschreibt das Standard-Timeout von 600 Sekunden.

verbosity (Optional)

Ausführlichkeitsoptionen für die Installation (debug oder trace). Schreibt ausführliche Ausgaben in eine Protokolldatei auf dem Host.

Standardeinstellungen

In defaults/main.yml festgelegt:

• 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

Umgebungsvariablen

Werte werden unter dem environment-Keyword in Ihrem Playbook gesetzt:

• NEW_RELIC_API_KEY (erforderlich)
• NEW_RELIC_ACCOUNT_ID (erforderlich)
• NEW_RELIC_REGION (optional: 'US' oder 'EU', Standard 'US')

Zusätzlich kann eine optionale Variable HTTPS_PROXY gesetzt werden, um einen Proxy für Ihre Installation zu aktivieren.

apm-php:

• NEW_RELIC_APPLICATION_NAME (optional) Der Name der PHP-Anwendung, die instrumentiert werden soll. Dieser Name wird unter New Relic's APM & Services aufgeführt. Wenn er weggelassen wird, lautet der Standard PHP Application.

apache:

• NEW_RELIC_APACHE_STATUS_URL (optional) Die URL zur Überprüfung des Status des Apache-Webservers. Dies wird verwendet, um sicherzustellen, dass ein Apache-Webserver auf dem Host läuft und sich in einem gesunden Zustand befindet, bevor versucht wird, die Apache On-Host-Integration zu installieren. Standardmäßig: http://127.0.0.1/server-status?auto

mssql:

• NEW_RELIC_MSSQL_DB_HOSTNAME (optional) Hostname oder IP-Adresse, auf der der MS SQL-Server läuft. Standardmäßig wird der entdeckte Hostname verwendet, wenn nicht angegeben.
• NEW_RELIC_MSSQL_DB_PORT (optional) Port, auf dem der MS SQL-Server hört. Standardmäßig 1433.
• NEW_RELIC_MSSQL_DB_USERNAME (optional) Benutzername für den Zugriff auf den MS SQL-Server. Standardmäßig newrelic. Wenn ein Domainbenutzer verwendet wird, verwenden Sie die Syntax domain\user.
• NEW_RELIC_MSSQL_DB_PASSWORD (optional) Passwort für den angegebenen SQL- oder Domainbenutzer. Wenn kein Passwort angegeben ist, wird ein zufälliges Passwort generiert.
• NEW_RELIC_MSSQL_SQL_USERNAME (optional) Optionale Berechtigungsüberschreibung, die sqlcmd beim Erstellen des SQL-Benutzers, der durch NEW_RELIC_MSSQL_DB_USERNAME angegeben wird, übergeben wird. Wenn weggelassen, wird der Standard-Login-Benutzername verwendet.
• NEW_RELIC_MSSQL_SQL_PASSWORD (optional) Optionale Berechtigungsüberschreibung, die sqlcmd beim Erstellen des SQL-Benutzers übergeben wird, der durch NEW_RELIC_MSSQL_DB_USERNAME angegeben wird. Wenn weggelassen, wird das Standard-Login-Passwort verwendet.
• NEW_RELIC_MSSQL_ENABLE_BUFFER_METRICS (optional) Aktiviert die Erfassung von Pufferpool-Metriken. Standardmäßig auf true.
• NEW_RELIC_MSSQL_ENABLE_RESERVE_METRICS (optional) Aktiviert die Erfassung des Reservemetrik von Datenbankpartitionen. Standardmäßig auf true.

mysql:

• NEW_RELIC_MYSQL_PORT (optional) Standardmäßig auf 3306, wenn nicht angegeben.
• NEW_RELIC_MYSQL_USERNAME (optional) Standardmäßig auf newrelic, wenn nicht anders angegeben. Dies ist der Benutzername, den die mysql-Integration einrichten wird und der auch in der Konfigurationsdatei der Integration (z.B.: mysql-config.yml) für Berichtsziele angegeben wird. Weitere Informationen zur MySQL-Integration.
• NEW_RELIC_MYSQL_PASSWORD (optional) Das Passwort für den unter NEW_RELIC_MYSQL_USERNAME angegebenen Benutzer. Weitere Informationen zur MySQL-Integration.
• NEW_RELIC_MYSQL_ROOT_PASSWORD (erforderlich) Die mysql-Integration benötigt den Zugriff auf mysql, um die entsprechenden Anmeldedaten zu erstellen.

Siehe ansibles Remote-Umgebung für weitere Informationen.

Versionskompatibilität

• Ansible: Getestet mit Ansible Core 2.13 und 2.14. Ansible Core-Versionen vor 2.10 werden nicht unterstützt.
• Python: Getestet mit Python 3.10.

Abhängigkeiten

Python-Anforderungen: requirements.txt

Ansible-Anforderungen: requirements.yml

Beispiel-Playbook

- name: New Relic installieren
  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: <API-Schlüssel>
    NEW_RELIC_ACCOUNT_ID: <Kontonummer>
    NEW_RELIC_REGION: <Region>
    NEW_RELIC_APPLICATION_NAME: "Meine Anwendung"
    HTTPS_PROXY: "http://my.proxy:8888"

• Finden Sie Ihren Schlüssel: API-Schlüssel UI

• Finden Sie Ihre Kontonummer: Dokumentation zur Kontonummer

Unterstützung

New Relic hostet und moderiert ein Online-Forum, in dem Kunden mit New Relic-Mitarbeitern und anderen Kunden interagieren können, um Hilfe zu erhalten und Best Practices auszutauschen. Wie bei allen offiziellen Open-Source-Projekten von New Relic gibt es ein verwandtes Community-Thema im New Relic Explorers Hub. Sie finden das Thema/die Diskussionen dieses Projekts hier:

• New Relic Dokumentation: Umfassende Anleitung zur Nutzung unserer Plattform
• New Relic Community: Der beste Ort, um Fragen zur Fehlersuche zu stellen
• New Relic Developer: Ressourcen zum Erstellen benutzerdefinierter Observability-Anwendungen
• New Relic University: Eine Reihe von Online-Trainings für New Relic-Benutzer jeder Stufe
• New Relic Technischer Support 24/7/365 Ticketunterstützung. Lesen Sie mehr über unser Technischer Support-Angebote.

Mitwirken

Wir freuen uns über Ihre Beiträge zur Verbesserung der newrelic.newrelic_install Ansible-Rolle! Denken Sie daran, dass Sie, wenn Sie Ihren Pull-Request einreichen, die CLA über das Klicken im CLA-Assistant unterzeichnen müssen. Sie müssen die CLA nur einmal pro Projekt unterzeichnen.

Wenn Sie Fragen haben oder unsere Unternehmens-CLA ausführen möchten (die erforderlich ist, wenn Ihr Beitrag im Namen eines Unternehmens erfolgt), senden Sie uns eine E-Mail an opensource@newrelic.com.

Hinweis zu Sicherheitsanfälligkeiten

Wie in unserer Sicherheitspolitik erwähnt, engagiert sich New Relic für die Privatsphäre und Sicherheit unserer Kunden und deren Daten. Wir sind der Ansicht, dass eine koordinierte Offenlegung durch Sicherheitsforscher und die Zusammenarbeit mit der Sicherheitsgemeinschaft wichtige Mittel sind, um unsere Sicherheitsziele zu erreichen.

Wenn Sie glauben, Sie hätten eine Sicherheitsanfälligkeit in diesem Projekt oder in einem der Produkte oder Websites von New Relic gefunden, freuen wir uns über Ihre Meldung über HackerOne.

Wenn Sie zu diesem Projekt beitragen möchten, überprüfen Sie bitte diese Richtlinien.

Allen Mitwirkenden danken wir! Ohne Ihren Beitrag wäre dieses Projekt nicht das, was es heute ist.

Lizenz

Dieses Projekt steht unter der Apache 2.0 Lizenz.