Guida all’installazione

IMPORTANT
A decorrere dal 23 aprile 2024, la Site-Wide Analysis Tool sarà disattivato per tutti i clienti on-premise di Adobe Commerce.

Il Site-Wide Analysis Tool fornisce monitoraggio delle prestazioni in tempo reale 24 ore su 24, 7 giorni su 7, rapporti e raccomandazioni per garantire la sicurezza e l’operabilità di Adobe Commerce sulle installazioni dell’infrastruttura cloud. Fornisce inoltre informazioni dettagliate sulle patch disponibili e installate, sulle estensioni di terze parti e sull’installazione di Adobe Commerce.

INFO
Scopri come abilitare il Site-Wide Analysis Tool e generare rapporti.

Se hai installato Adobe Commerce on-premise, installa un agente nell’infrastruttura per utilizzare lo strumento. Non è necessario installare l’agente su Adobe Commerce nei progetti di infrastruttura cloud.

Agente

Il Site-Wide Analysis Tool L'agente ti consente di utilizzare Site-Wide Analysis Tool per gli impianti locali di Adobe Commerce.

Il Site-Wide Analysis Tool L'agente raccoglie dati sull'applicazione e sul business, li analizza e fornisce ulteriori informazioni sullo stato dell'installazione per migliorare l'esperienza del cliente. Monitora l'applicazione e consente di identificare le prestazioni, la sicurezza, la disponibilità e i problemi dell'applicazione.

La procedura per l'installazione dell'agente è la seguente:

  1. Verificare i requisiti di sistema.

  2. Configurare le chiavi API in Commerce Services Connector estensione.

  3. Installa l’agente.

  4. Esegui l’agente.

INFO
L'agente supporta installazioni Adobe Commerce a più nodi. Installa e configura l’agente su ciascun nodo.

Requisiti di sistema

Prima di installare l'agente, l'infrastruttura locale deve soddisfare i seguenti requisiti:

  • Sistemi operativi

    • Linux x86-64 distribuzioni, come Red Hat® Enterprise Linux (RHEL), CentOS, Ubuntu, Debian, e simili
    note important
    IMPORTANT
    Adobe Commerce non è supportato su Microsoft Windows o macOS.
  • Adobe Commerce 2.4.5-p1 o versione successiva (a causa della dipendenza del connettore di servizio)

  • Commerce Services Connector extension

  • CLI PHP

  • Utilità Bash/shell

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

L'agente richiede Commerce Services Connector da installare sul sistema e configurato con le chiavi API. Per verificare che l’estensione sia installata, esegui il seguente comando:

bin/magento module:status Magento_ServicesId

Se hai installato l’estensione e l’hai configurata utilizzando una chiave API esistente per un servizio diverso, DEVE rigenerare la chiave API e aggiornarlo in Adobe Commerce Admin per l’agente.

  1. Inserisci il tuo sito web in modalità di manutenzione.

  2. Accedi a account.magento.com.

    note note
    NOTE
    In caso di problemi di accesso all’account, consulta Impossibile accedere al supporto Adobe Commerce o all’account cloud per assistenza nella risoluzione dei problemi.
  3. Clic API Portal.

  4. Clic Delete accanto alla chiave API esistente.

  5. Configura una nuova chiave API.

IMPORTANT
Se generi nuove chiavi nel portale API, aggiorna immediatamente le chiavi API in Admin configuration. Se si generano nuove chiavi e non si aggiornano le chiavi in Admin, le estensioni SaaS non funzioneranno più e si perderanno dati importanti.

Se l'estensione non è installata, attenersi alle istruzioni seguenti per installarla:

  1. Aggiungi l'estensione al tuo composer.json e installarlo.

    code language-bash
    composer require magento/services-id
    
  2. Abilita l'estensione.

    code language-bash
    bin/magento module:enable Magento_ServicesId
    
  3. Aggiornare lo schema del database.

    code language-bash
    bin/magento setup:upgrade
    
  4. Cancella la cache.

    code language-bash
    bin/magento cache:clean
    
  5. Configurare le chiavi API per collegare l'estensione al sistema.

Installare l’agente

È stata creata una script shell per semplificare l'installazione. È consigliabile utilizzare lo script della shell, ma è possibile seguire la installazione manuale se necessario.

INFO
Dopo l’installazione, l’agente si aggiornerà automaticamente quando sarà disponibile una nuova versione.

Con script

  1. Scarica ed esegui lo script della shell.

    code language-bash
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    
    note tip
    TIP
    È consigliabile installare l’agente all’esterno della directory principale del progetto Adobe Commerce.
  2. Verificare l'installazione.

    code language-bash
    ./scheduler -v
    
    code language-bash
    Version: 1.0.1
    Success exit.
    
  3. Dopo aver scaricato e installato l'agente, configuralo per l’esecuzione utilizzando uno dei seguenti metodi:

    • Servizio (opzione preferita se si dispone dell'accesso root)

    • Cron

Manuale manual

Se non si desidera utilizzare il nostro script shell per installare l'agente, è necessario installarlo manualmente eseguendo la procedura seguente:

  1. Creare una directory in cui scaricare l'agente.

    note tip
    TIP
    È consigliabile installare l’agente all’esterno della directory principale del progetto Adobe Commerce.
  2. Scarica il file binario e decomprimi.

    note info
    INFO
    Per utilizzare Site-Wide Analysis Tool, devi innanzitutto leggere e accettare le Condizioni d’uso presentate quando accedi al dashboard da Adobe Commerce Admin.

    Per AMD64 architettura:

    1. Scarica l’archivio del modulo di avvio.

      code language-bash
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-amd64.tar.gz
      
    2. Decomprimi l'archivio del modulo di avvio.

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

    Per ARM64 architettura:

    1. Scarica l’archivio del modulo di avvio.

      code language-bash
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-arm64.tar.gz
      
    2. Decomprimi l'archivio del modulo di avvio.

      code language-bash
      tar -xf launcher.linux-arm64.tar.gz
      
  3. (Facoltativo) Verificare la firma del file di checksum.

    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. (Facoltativo) Verifica il checksum.

    code language-bash
    shasum -a 512 -c launcher.checksum
    
  5. Creare config.yaml file con i seguenti contenuti.

    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. Verificare l'installazione.

    code language-bash
    scheduler -v
    
    code language-bash
    Version: 1.0.1
    Success exit.
    
  7. Dopo aver scaricato e installato l'agente, è necessario configuralo per l’esecuzione utilizzando uno dei seguenti metodi:

    • Servizio (opzione preferita se si dispone dell'accesso root)

    • Cron

Eseguire l’agente run-the-agent

È consigliabile configurare l’agente in modo che venga eseguito come servizio. Se disponi di un accesso limitato all’infrastruttura e non disponi delle autorizzazioni root, devi utilizzare cron invece.

Servizio service

  1. Creare un file di unità di sistema (/etc/systemd/system/scheduler.service) con la seguente configurazione (sostituisci <filesystemowner> con l'utente UNIX® proprietario della directory in cui sono installati l'agente e il software Adobe Commerce). Se l'agente è stato scaricato come utente root, modificare la directory e il proprietario dei file nidificati.

    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. Avvia il servizio.

    code language-bash
    systemctl daemon-reload
    
    code language-bash
    systemctl start scheduler
    
    code language-bash
    systemctl enable scheduler
    
  3. Verifica che il servizio sia in esecuzione.

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

Cron cron

Se non si dispone delle autorizzazioni radice o non si dispone delle autorizzazioni necessarie per configurare un servizio come radice, è possibile utilizzare cron.

Aggiorna la pianificazione 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 -

Disinstalla

Esegui i seguenti comandi per disinstallare il servizio dal sistema e rimuovere tutti i file generati:

  1. Arresta il modulo di pianificazione.

    code language-bash
    systemctl stop scheduler
    
  2. Disattiva la pianificazione.

    code language-bash
    systemctl disable scheduler
    
  3. Rimuovere il systemd file di unità.

    code language-bash
    rm /etc/systemd/system/scheduler.service
    
  4. Ricarica systemd configurazione del manager.

    code language-bash
    systemctl daemon-reload
    
  5. Reimposta qualsiasi systemd unità da uno stato di errore.

    code language-bash
    systemctl reset-failed
    
  6. Rimuovere la directory del servizio di pianificazione.

    code language-bash
    rm -rf <CHECK_REGISTRY_PATH> #see SWAT_AGENT_APPLICATION_CHECK_REGISTRY_PATH in /etc/systemd/system/scheduler.service
    
  7. Rimuovi il file binario dell'utilità di pianificazione.

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

Se invece hai configurato l’agente per l’esecuzione con cron, utilizza le seguenti istruzioni:

  1. Rimuovi l’agente dall’elenco crontab.

    code language-bash
    crontab -e
    
  2. Arresta il processo in esecuzione.

    code language-bash
    ps aux | grep scheduler
    
  3. Rimuovere la directory in cui è stato installato l'agente.

    code language-bash
    rm -rf swat-agent
    

Risoluzione dei problemi

Chiavi di accesso non analizzate correttamente

Se le chiavi di accesso non vengono analizzate correttamente, è possibile che venga visualizzato il seguente errore:

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

Per risolvere l'errore, effettuare le seguenti operazioni:

  1. Esegui una installazione con script, salva l'output ed esamina l'output per individuare eventuali errori.
  2. Rivedi il generato config.yaml e verificare che il percorso dell’istanza Commerce e del PHP sia corretto.
  3. Assicurarsi che l'utente che esegue la pianificazione si trovi nel proprietario del file system Unix è lo stesso utente del proprietario del file system.
  4. Assicurati che il Connettore Commerce Services Le chiavi sono installate correttamente e prova ad aggiornarle per collegare l'estensione al sistema.
  5. Disinstalla l'agente dopo aver aggiornato le chiavi e reinstallato utilizzando script di installazione.
  6. Eseguire il modulo di pianificazione e verificare se si riceve ancora lo stesso errore.
  7. Se ricevi ancora lo stesso errore, aumenta il livello di registro in config.yaml per eseguire il debug e aprire un ticket di supporto.

SIGFAULT Errore

Se viene visualizzata una SIGFAULT errore durante l’esecuzione del binario, è probabile che non venga eseguito come proprietario del file di Adobe Commerce e dei file dell’agente.
Per risolvere il problema, verifica se tutti i file all’interno della directory dell’agente che hanno lo stesso utente del proprietario del file che hanno i file di Adobe Commerce e il file binario devono essere eseguiti anche sotto tale utente.
È possibile utilizzare chown per cambiare il proprietario dei file e passare all'utente appropriato.
Assicurati che il meccanismo di daemonizzazione (Cron o System.d) esegua il processo sotto l’utente appropriato.

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