newrelic.newrelic_install

Aperçu Versions Perspectives

Bannière du projet communautaire Open Source de New Relic.

Rôle Ansible New Relic

newrelic.newrelic_install est un Rôle Ansible qui vous aide à améliorer vos efforts d'observabilité avec New Relic. Il utilise le New Relic CLI et le dépôt d'installation ouverte de New Relic pour cela.

Remarque : Installer des versions spécifiques d'un agent n'est pas pris en charge, ce rôle installera toujours la dernière version disponible d'un agent New Relic.

Veuillez consulter les sections ci-dessous pour les détails sur l'installation, le démarrage, les variables du rôle, les dépendances et un exemple d'playbook Ansible montrant l'utilisation de ce rôle.

Si vous avez besoin d'aide avec Ansible pour Windows, consultez Configuration d'un hôte Windows sur le site de Documentation Ansible.

Installation

Ansible Galaxy

ansible-galaxy install newrelic.newrelic_install

Lien vers Galaxy

Assurez-vous d'avoir ansible.windows et ansible.utils s'ils ne sont pas déjà installés :

ansible-galaxy collection install ansible.windows ansible.utils

Manuel

Si vous souhaitez utiliser une copie locale du rôle, clonez le dépôt et exécutez make à la racine du projet pour copier ce dépôt dans ~/.ansible/roles/newrelic.newrelic_install, permettant au rôle de se comporter comme s'il avait été installé depuis Galaxy.

Pour commencer

Après l'installation, incluez le rôle newrelic.newrelic_install dans un nouveau playbook ou un playbook existant. Par exemple :

- name: Installer New Relic
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
  environment:
    NEW_RELIC_API_KEY: <Clé API>
    NEW_RELIC_ACCOUNT_ID: <ID de compte>
    NEW_RELIC_REGION: <Région>

Variables

Variables du rôle

targets (Obligatoire)

Liste des installations ciblées à réaliser sur les hôtes. Options disponibles :

  • 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)

Notes importantes :

  • La cible logs nécessite infrastructure, et une erreur sera générée si logs est spécifié sans infrastructure.
  • L'installation de l'agent apm-nodejs est uniquement prise en charge pour les applications gérées par PM2. Pour installer l'agent via un gestionnaire de paquets, comme npm ou yarn, reportez-vous à notre documentation.
  • L'installation de l'agent apm-dotnet pour Windows n'est prise en charge que pour les applications hébergées par IIS. Les installations Linux sont uniquement prises en charge pour les applications .NET s'exécutant en tant que service systemd.
  • L'installation de l'agent apm-java prend en charge Java fonctionnant sous Tomcat, Wildfly/Jboss, et Jetty (autonome). Notez que c'est une installation APM Java limitée qui instrumente certains serveurs d'applications Java via une attache dynamique en utilisant l'introspecteur Java de New Relic. Plus de détails ici.
  • Les intégrations suivantes nécessitent l'agent d'infrastructure installé :
    • apm-java
    • apache
    • mssql
    • mysql
    • nginx

tags (Optionnel)

Paires clé-valeur de tags passés à l'installation.

install_timeout_seconds (Optionnel)

Définit le temps d'attente pour la tâche d'installation. Remplace le temps d'attente par défaut de 600s.

verbosity (Optionnel)

Options de verbosité pour l'installation (debug ou trace). Écrit les sorties détaillées dans un fichier de log sur l'hôte.

Valeurs par défaut

Définies dans 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

Variables d'environnement

Les valeurs sont définies sous le mot-clé environment dans votre playbook :

  • NEW_RELIC_API_KEY (obligatoire)
  • NEW_RELIC_ACCOUNT_ID (obligatoire)
  • NEW_RELIC_REGION (optionnel : 'US' ou 'EU', par défaut 'US')

De plus, une variable HTTPS_PROXY optionnelle peut être définie pour activer un proxy pour votre installation.

apm-php :

  • NEW_RELIC_APPLICATION_NAME (optionnel) Le nom de l'application PHP à instrumenter. Ce nom sera affiché sous APM & Services de New Relic. Si omis, par défaut, cela sera PHP Application.

apache :

  • NEW_RELIC_APACHE_STATUS_URL (optionnel) L'URL pour vérifier l'état du serveur web Apache. Cela est utilisé pour s'assurer qu'un serveur web Apache fonctionne sur l'hôte et est en bon état avant de tenter d'installer l'intégration Apache On-Host. Valeur par défaut : http://127.0.0.1/server-status?auto

mssql :

  • NEW_RELIC_MSSQL_DB_HOSTNAME (optionnel) Nom d'hôte ou IP où le serveur MS SQL fonctionne. Par défaut, cela utilise le nom d'hôte découvert si non spécifié.
  • NEW_RELIC_MSSQL_DB_PORT (optionnel) Port sur lequel le serveur MS SQL écoute. Par défaut : 1433.
  • NEW_RELIC_MSSQL_DB_USERNAME (optionnel) Nom d'utilisateur pour accéder au serveur MS SQL. Par défaut : newrelic. Si vous utilisez un utilisateur de domaine, utilisez la syntaxe domaine\utilisateur.
  • NEW_RELIC_MSSQL_DB_PASSWORD (optionnel) Mot de passe pour l'utilisateur SQL ou de domaine donné. Si aucun mot de passe n'est fourni, un mot de passe aléatoire sera généré.
  • NEW_RELIC_MSSQL_SQL_USERNAME (optionnel) Remplaçant de crédentiel facultatif passé à sqlcmd lors de la création de l'utilisateur SQL spécifié par NEW_RELIC_MSSQL_DB_USERNAME. Si omis, le nom d'utilisateur de connexion par défaut sera utilisé.
  • NEW_RELIC_MSSQL_SQL_PASSWORD (optionnel) Remplaçant de crédentiel facultatif passé à sqlcmd lors de la création de l'utilisateur SQL spécifié par NEW_RELIC_MSSQL_DB_USERNAME. Si omis, le mot de passe de connexion par défaut sera utilisé.
  • NEW_RELIC_MSSQL_ENABLE_BUFFER_METRICS (optionnel) Activer la collecte des métriques de pool de mémoire tampon. Par défaut, c'est vrai.
  • NEW_RELIC_MSSQL_ENABLE_RESERVE_METRICS (optionnel) Activer la collecte d'espace de réserve de partition de base de données. Par défaut, c'est vrai.

mysql :

  • NEW_RELIC_MYSQL_PORT (optionnel) Par défaut : 3306 si non spécifié.
  • NEW_RELIC_MYSQL_USERNAME (optionnel) Par défaut : newrelic si aucun autre n'est spécifié. C'est le nom d'utilisateur que l'intégration mysql mettra en place et qui sera également dans le fichier de configuration de l'intégration (par exemple : mysql-config.yml) pour les données de rapport. En savoir plus sur l'intégration MySQL.
  • NEW_RELIC_MYSQL_PASSWORD (optionnel) Le mot de passe pour l'utilisateur spécifié dans NEW_RELIC_MYSQL_USERNAME. En savoir plus sur l'intégration MySQL.
  • NEW_RELIC_MYSQL_ROOT_PASSWORD (obligatoire) L'intégration mysql doit se connecter à mysql pour créer les informations d'identification appropriées.

Consultez l'environnement distant d'ansible pour plus d'informations.

Compatibilité des versions

  • Ansible : Testé avec les versions Ansible Core 2.13 et 2.14. Les versions antérieures à 2.10 ne sont pas prises en charge.
  • Python : Testé avec Python 3.10.

Dépendances

Exigences Python : requirements.txt

Exigences Ansible : requirements.yml

Exemple de Playbook

- name: Installer 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: <Clé API>
    NEW_RELIC_ACCOUNT_ID: <ID de compte>
    NEW_RELIC_REGION: <Région>
    NEW_RELIC_APPLICATION_NAME: "Mon Application"
    HTTPS_PROXY: "http://my.proxy:8888"

Support

New Relic anime et modère un forum en ligne où les clients peuvent interagir avec les employés de New Relic ainsi qu’avec d'autres clients pour obtenir de l'aide et partager des meilleures pratiques. Comme tous les projets open source officiels de New Relic, il existe un sujet de Communauté lié dans le New Relic Explorers Hub. Vous pouvez trouver le sujet/les discussions de ce projet ici :

Contribuer

Nous vous encourageons à contribuer à améliorer le rôle ansible newrelic.newrelic_install ! Gardez à l'esprit que lorsque vous soumettez votre pull request, vous devrez signer le CLA via un clic, en utilisant CLA-Assistant. Vous n'avez qu'à signer le CLA une fois par projet.

Si vous avez des questions, ou pour exécuter notre CLA d'entreprise (qui est requise si votre contribution est au nom d'une entreprise), envoyez-nous un e-mail à opensource@newrelic.com.

Remarque sur les vulnérabilités

Comme indiqué dans notre politique de sécurité, New Relic est engagé envers la confidentialité et la sécurité de nos clients et de leurs données. Nous croyons que fournir des divulgations coordonnées par des chercheurs en sécurité et interagir avec la communauté de sécurité sont des moyens importants pour atteindre nos objectifs de sécurité.

Si vous pensez avoir trouvé une vulnérabilité de sécurité dans ce projet ou dans l'un des produits ou sites Web de New Relic, nous vous encourageons et vous remercions de la signaler à New Relic via HackerOne.

Si vous souhaitez contribuer à ce projet, consultez ces directives.

À tous les contributeurs, nous vous remercions ! Sans votre contribution, ce projet ne serait pas ce qu'il est aujourd'hui.

Licence

Ce projet est sous licence Apache 2.0.

À propos du projet

Role for New Relic's Targeted Installs

role monitoring observability scalability performance infrastructure cloud logging host linux windows
Installer
ansible-galaxy install newrelic.newrelic_install
GitHub référentiel
7 étoiles
9 forks
16 problèmes ouverts
Licence
apache-2.0
Téléchargements
195.9k
Propriétaire