Guide d’installation

IMPORTANT
À compter du 23 avril 2024, la Site-Wide Analysis Tool sera mis hors service pour tous les clients Adobe Commerce sur site.

La variable Site-Wide Analysis Tool fournit 24/7 surveillance des performances, rapports et recommandations en temps réel pour garantir la sécurité et la maniabilité d’Adobe Commerce sur les installations d’infrastructure cloud. Il fournit également des informations détaillées sur les correctifs disponibles et installés, les extensions tierces et votre installation Adobe Commerce.

INFO
Formation procédure d’activation la valeur Site-Wide Analysis Tool et générer des rapports.

Si vous disposez d’une installation sur site d’Adobe Commerce, installez un agent sur votre infrastructure pour utiliser l’outil. Vous n’avez pas besoin d’installer l’agent sur Adobe Commerce sur les projets d’infrastructure cloud.

Agent

La variable Site-Wide Analysis Tool L’agent vous permet d’utiliser la variable Site-Wide Analysis Tool pour les installations sur site d’Adobe Commerce.

La variable Site-Wide Analysis Tool L’agent collecte les données de l’application et de l’entreprise, les analyse et fournit des informations supplémentaires sur l’intégrité de votre installation afin que vous puissiez améliorer l’expérience client. Il surveille votre application et vous aide à identifier les problèmes de performances, de sécurité, de disponibilité et d’application.

L’installation de l’agent nécessite les étapes suivantes :

  1. Vérification de la configuration requise.

  2. Configuration des clés d’API dans Commerce Services Connector extension .

  3. Installez l’agent.

  4. Exécutez l’agent.

INFO
L’agent prend en charge les installations Adobe Commerce à plusieurs noeuds. Installer et configurer l’agent sur chaque noeud.

Configuration requise

Votre infrastructure sur site doit répondre aux exigences suivantes avant d’installer l’agent :

  • Systèmes d’exploitation

    • Linux x86-64 les distributions, telles que Red Hat® Enterprise Linux (RHEL), CentOS, Ubuntu, Debian, et similaires
    note important
    IMPORTANT
    Adobe Commerce n’est pas pris en charge sur Microsoft Windows ou macOS.
  • Adobe Commerce 2.4.5-p1 ou version ultérieure (en raison de la dépendance de Service Connector)

  • Commerce Services Connector extension

  • CLI PHP

  • Utilitaires de base/shell

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

L’agent requiert la variable Commerce Services Connector l’extension à installer sur votre système et configuré avec les clés API. Pour vérifier que l’extension est installée, exécutez la commande suivante :

bin/magento module:status Magento_ServicesId

Si vous avez installé l’extension et l’avez configurée à l’aide d’une clé API existante pour un autre service, vous DOIT régénérer la clé API et mettez-le à jour dans l’administrateur Adobe Commerce de l’agent.

  1. Placez votre site web dans mode de maintenance.

  2. Se connecter account.magento.com.

    note note
    NOTE
    Si vous rencontrez des problèmes pour accéder à votre compte, reportez-vous à la section Impossible de se connecter au support Adobe Commerce ou au compte cloud pour obtenir de l’aide sur la résolution des problèmes.
  3. Cliquez sur API Portal.

  4. Cliquez sur Delete en regard de la clé API existante.

  5. Configurer une nouvelle clé API.

IMPORTANT
Si vous générez de nouvelles clés dans le portail API, mettez immédiatement à jour les clés API dans la variable Admin configuration. Si vous générez de nouvelles clés et que vous ne mettez pas à jour les clés dans la variable Admin, vos extensions SaaS ne fonctionneront plus et vous perdrez des données importantes.

Si l’extension n’est pas installée, procédez comme suit pour l’installer :

  1. Ajoutez l’extension à votre composer.json et installez-le.

    code language-bash
    composer require magento/services-id
    
  2. Activez l’extension .

    code language-bash
    bin/magento module:enable Magento_ServicesId
    
  3. Mettez à jour le schéma de la base de données.

    code language-bash
    bin/magento setup:upgrade
    
  4. Effacez le cache.

    code language-bash
    bin/magento cache:clean
    
  5. Configuration des clés d’API pour connecter l’extension à votre système.

Installation de l’agent

Nous avons créé une script shell pour simplifier l’installation. Nous vous recommandons d’utiliser le script shell, mais vous pouvez suivre le installation manuelle si nécessaire.

INFO
Une fois l’agent installé, il se met à jour automatiquement lorsqu’une nouvelle version est disponible.

Scripts

  1. Téléchargez et exécutez le script shell.

    code language-bash
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    
    note tip
    TIP
    Nous vous recommandons d’installer l’agent en dehors de votre répertoire de projet Adobe Commerce racine.
  2. Vérifiez l’installation.

    code language-bash
    ./scheduler -v
    
    code language-bash
    Version: 1.0.1
    Success exit.
    
  3. Après avoir téléchargé et installé l’agent, configurer son exécution à l’aide de l’une des méthodes suivantes :

    • Service (recommandé si vous disposez de l’accès racine)

    • Cron

Manuel manual

Si vous ne souhaitez pas utiliser notre script shell pour installer l’agent, vous devez l’installer manuellement en procédant comme suit :

  1. Créez un répertoire dans lequel télécharger l’agent.

    note tip
    TIP
    Nous vous recommandons d’installer l’agent en dehors de votre répertoire de projet Adobe Commerce racine.
  2. Téléchargez le fichier binaire et décompressez-le.

    note info
    INFO
    Pour utiliser la variable Site-Wide Analysis Tool, vous devez d’abord lire et accepter les Conditions d’utilisation qui s’affichent lorsque vous accédez au tableau de bord à partir de l’administrateur Adobe Commerce.

    Pour le AMD64 architecture :

    1. Téléchargez l’archive du lanceur.

      code language-bash
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-amd64.tar.gz
      
    2. Décompressez l’archive du lanceur.

      code language-bash
      tar -xf launcher.linux-amd64.tar.gz
      

    Pour le ARM64 architecture :

    1. Téléchargez l’archive du lanceur.

      code language-bash
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-arm64.tar.gz
      
    2. Décompressez l’archive du lanceur.

      code language-bash
      tar -xf launcher.linux-arm64.tar.gz
      
  3. (Facultatif) Vérifiez la signature du fichier de somme de contrôle.

    code language-bash
    echo -n "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FnOEFNSUlDQ2dLQ0FnRUE0M2FBTk1WRXR3eEZBdTd4TE91dQpacG5FTk9pV3Y2aXpLS29HendGRitMTzZXNEpOR3lRS1Jha0MxTXRsU283VnFPWnhUbHZSSFhQZWt6TG5vSHVHCmdmNEZKa3RPUEE2S3d6cjF4WFZ3RVg4MEFYU1JNYTFadzdyOThhenh0ZHdURVh3bU9GUXdDcjYramFOM3ErbUoKbkRlUWYzMThsclk0NVJxWHV1R294QzBhbWVoakRnTGxJUSs1d1kxR1NtRGRiaDFJOWZqMENVNkNzaFpsOXFtdgorelhjWGh4dlhmTUU4MUZsVUN1elRydHJFb1Bsc3dtVHN3ODNVY1lGNTFUak8zWWVlRno3RFRhRUhMUVVhUlBKClJtVzdxWE9kTGdRdGxIV0t3V2ppMFlrM0d0Ylc3NVBMQ2pGdEQzNytkVDFpTEtzYjFyR0VUYm42V3I0Nno4Z24KY1Q4cVFhS3pYRThoWjJPSDhSWjN1aFVpRHhZQUszdmdsYXJSdUFacmVYMVE2ZHdwYW9ZcERKa29XOXNjNXlkWApBTkJsYnBjVXhiYkpaWThLS0lRSURnTFdOckw3SVNxK2FnYlRXektFZEl0Ni9EZm1YUnJlUmlMbDlQMldvOFRyCnFxaHNHRlZoRHZlMFN6MjYyOU55amgwelloSmRUWXRpdldxbGl6VTdWbXBob1NrVnNqTGtwQXBiUUNtVm9vNkgKakJmdU1sY1JPeWI4TXJCMXZTNDJRU1MrNktkMytwR3JyVnh0akNWaWwyekhSSTRMRGwrVzUwR1B6LzFkeEw2TgprZktZWjVhNUdCZm00aUNlaWVNa3lBT2lKTkxNa1cvcTdwM200ejdUQjJnbWtldm1aU3Z5MnVMNGJLYlRoYXRlCm9sdlpFd253WWRxaktkcVkrOVM1UlNVQ0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==" | base64 -d > release.pub
    
    code language-bash
    openssl dgst -sha256 -verify release.pub -signature launcher.sha256 launcher.checksum
    
  4. (Facultatif) Vérifiez la somme de contrôle.

    code language-bash
    shasum -a 512 -c launcher.checksum
    
  5. Créez le config.yaml avec le contenu suivant.

    code language-yaml
    project:
      appname: "Acme Inc" # Company or site name that you provided when installing the agent
    application:
      phppath: php # Path to your PHP CLI interpreter (usually /usr/bin/php)
      magentopath: /var/www/html/example.com # Root directory where your Adobe Commerce application is installed (usually /var/www/html)
      checkregistrypath: /path/to/swat-agent/tmp # Temporary directory for the agent (usually /usr/local/swat-agent/tmp)
      issandbox: false # Enabling sandbox mode to use the agent on staging environment (true or false)
      database:
        user: your-adobe-commerce-db-username # Database user for your Adobe Commerce installation
        password: your-password # Database password for the specified user for your Adobe Commerce installation
        host: 127.0.0.1 # Database host for your Adobe Commerce installation
        dbname: your-adobe-commerce-db-name # Database name for your Adobe Commerce installation
        port: 3306 # Database port for your Adobe Commerce installation (usually 3306)
        tableprefix: # Table Prefix for your Adobe Commerce installation (default value: empty)
     enableautoupgrade: true # Enables automatic upgrade (restart required after an upgrade; agent does not check for upgrades if the option is disabled; true or false)
     runchecksonstart: true # Collect data on the first run (Usually 1)
     loglevel: error # Determines what events are logged based on severity (usually error)
    
  6. Vérifiez l’installation.

    code language-bash
    scheduler -v
    
    code language-bash
    Version: 1.0.1
    Success exit.
    
  7. Après avoir téléchargé et installé l’agent, vous devez configurer son exécution à l’aide de l’une des méthodes suivantes :

    • Service (recommandé si vous disposez de l’accès racine)

    • Cron

Exécution de l’agent run-the-agent

Nous vous recommandons de configurer l’agent pour qu’il s’exécute en tant que service. Si vous disposez d’un accès limité à votre infrastructure et que vous ne disposez pas d’autorisations racine, vous devez utiliser cron au lieu de .

Service service

  1. Création d’un fichier d’unité systemd (/etc/systemd/system/scheduler.service) avec la configuration suivante (remplacez <filesystemowner> avec l’utilisateur UNIX® propriétaire du répertoire dans lequel l’agent et le logiciel Adobe Commerce sont installés). Si vous avez téléchargé l’agent en tant qu’utilisateur root, modifiez le répertoire et le propriétaire des fichiers imbriqués.

    code language-config
    [Unit]
    Wants=network.target
    After=network.target
    
    [Service]
    Type=simple
    User=<filesystemowner>
    ExecStart=/path/to/agent/scheduler
    Restart=always
    RestartSec=3
    
    [Install]
    WantedBy=multi-user.target
    
  2. Lancez le service.

    code language-bash
    systemctl daemon-reload
    
    code language-bash
    systemctl start scheduler
    
    code language-bash
    systemctl enable scheduler
    
  3. Vérifiez que le service est en cours d’exécution.

    code language-bash
    journalctl -u scheduler | grep "Application is going to update" | tail -1 && echo "Agent is successfully installed"
    

Cron cron

Si vous ne disposez pas d’autorisations root ou si vous ne disposez pas des autorisations nécessaires pour configurer un service en tant que root, vous pouvez utiliser cron à la place.

Mettez à jour votre planning cron :

( crontab -l ; echo "* * * * * flock -n /tmp/swat-agent.lockfile -c '/path/to/agent/scheduler' >> /path/to/agent/errors.log 2>&1" ) | sort - | uniq - | crontab -

Désinstaller

Exécutez les commandes suivantes pour désinstaller le service de votre système et supprimer tous les fichiers générés :

  1. Arrêtez le planificateur.

    code language-bash
    systemctl stop scheduler
    
  2. Désactivez le planificateur.

    code language-bash
    systemctl disable scheduler
    
  3. Suppression de la fonction du service de planificateur systemd fichier d’unité.

    code language-bash
    rm /etc/systemd/system/scheduler.service
    
  4. Rechargez la variable systemd configuration du gestionnaire.

    code language-bash
    systemctl daemon-reload
    
  5. Réinitialiser les systemd des unités d’un état en échec.

    code language-bash
    systemctl reset-failed
    
  6. Supprimez le répertoire du service du planificateur.

    code language-bash
    rm -rf <CHECK_REGISTRY_PATH> #see SWAT_AGENT_APPLICATION_CHECK_REGISTRY_PATH in /etc/systemd/system/scheduler.service
    
  7. Supprimez le fichier binaire du planificateur.

    code language-bash
    rm /usr/local/bin/scheduler
    

Si vous avez configuré l’agent pour qu’il s’exécute avec cron à la place, utilisez les instructions suivantes :

  1. Supprimez l’agent de la liste crontab.

    code language-bash
    crontab -e
    
  2. Arrêtez la tâche en cours.

    code language-bash
    ps aux | grep scheduler
    
  3. Supprimez le répertoire dans lequel vous avez installé l’agent.

    code language-bash
    rm -rf swat-agent
    

Dépannage

Clés d’accès non analysées correctement

L’erreur suivante peut s’afficher si vos clés d’accès ne sont pas correctement analysées :

ERRO[2022-10-10 00:01:41] Error while refreshing token: error while getting jwt from magento: invalid character 'M' looking for beginning of value
FATA[2022-12-10 20:38:44] bad http status from https://updater.supportinsights.adobe.com/linux-amd64.json: 403 Forbidden

Pour résoudre cette erreur, procédez comme suit :

  1. Effectuez une installation par script, enregistrez la sortie et vérifiez la sortie pour les erreurs.
  2. Vérifiez les config.yaml et vérifiez que le chemin d’accès à votre instance Commerce et à votre instance PHP est correct.
  3. Assurez-vous que l’utilisateur qui exécute le planificateur se trouve dans la variable propriétaire du système de fichiers Groupe Unix ou est le même utilisateur que le propriétaire du système de fichiers.
  4. Assurez-vous que la variable Connecteur Commerce Services les clés sont correctement installées et essayez de les mettre à jour pour connecter l’extension à votre système.
  5. Désinstaller l’agent après la mise à jour des clés et la réinstallation à l’aide de la fonction script d’installation.
  6. Exécutez le planificateur et vérifiez si vous recevez toujours la même erreur.
  7. Si vous recevez toujours la même erreur, augmentez le niveau de journalisation dans la variable config.yaml pour déboguer et ouvrir un ticket d’assistance.

SIGFAULT Erreur

Si une SIGFAULT lors de l’exécution du fichier binaire, vous ne l’exécutez probablement pas en tant que propriétaire de fichier des fichiers Adobe Commerce et Agent.
Pour résoudre ce problème, vérifiez si tous les fichiers du répertoire de l’agent qui ont le même utilisateur que le propriétaire de fichier que les fichiers Adobe Commerce et le fichier binaire doivent être exécutés sous cet utilisateur.
Vous pouvez utiliser la variable chown pour modifier le propriétaire des fichiers et passer à l’utilisateur approprié.
Assurez-vous que votre mécanisme de démonisation (Cron ou System.d) exécute le processus sous l’utilisateur approprié.

recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3