DokumentationCommerceTools

[Nur PaaS]{class="badge informative" title="Gilt nur für Adobe Commerce in Cloud-Projekten (von Adobe verwaltete PaaS-Infrastruktur) und lokale Projekte."}

Installationshandbuch

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Experte
  • Admin
  • Entwickler
IMPORTANT
Ab dem 23. April 2024 wird die Site-Wide Analysis Tool für alle Adobe Commerce On-Premise-Kunden eingestellt.

Die Site-Wide Analysis Tool bietet rund um die Uhr Echtzeit-Leistungsüberwachung, Berichte und Empfehlungen, um die Sicherheit und Betriebsfähigkeit von Adobe Commerce auf Cloud-Infrastrukturinstallationen sicherzustellen. Außerdem enthält es detaillierte Informationen über verfügbare und installierte Patches, Erweiterungen von Drittanbietern und Ihre Adobe Commerce-Installation.

INFO
Erfahren Sie wie SieSite-Wide Analysis Tool aktivieren und Berichte erstellen.

Wenn Sie über eine lokale Installation von Adobe Commerce verfügen, installieren Sie einen Agenten auf Ihrer Infrastruktur, um das Tool zu verwenden. Sie müssen den Agenten nicht in Cloud-Infrastrukturprojekten auf Adobe Commerce installieren.

Agent

Mit dem Site-Wide Analysis Tool Agent können Sie die Site-Wide Analysis Tool für lokale Installationen von Adobe Commerce verwenden.

Der Site-Wide Analysis Tool Agent sammelt Applikation- und Geschäftsdaten, analysiert sie und bietet zusätzliche Einblicke in die Integrität Ihrer Installation, damit Sie Kundenerlebnis verbessern können. Es überwacht Ihre Anwendung und hilft Ihnen, Leistungs-, Sicherheits-, Verfügbarkeits- und Anwendungsprobleme zu identifizieren.

Die Installation des Agenten erfordert die folgenden Schritte:

  1. Überprüfen Sie die Systemanforderungen.

  2. Konfigurieren von API-Schlüsseln in der Commerce Services Connector.

  3. Installieren Sie den Agenten.

  4. Führen Sie den Agenten aus.

INFO
Der Agent unterstützt Adobe Commerce-Installationen mit mehreren Knoten. Installieren und konfigurieren Sie den Agenten auf jedem Knoten.

Systemanforderungen

Ihre lokale Infrastruktur muss vor der Installation des Agenten die folgenden Anforderungen erfüllen:

  • Betriebssysteme

    • Linux x86-64 wie Red Hat® Enterprise Linux (RHEL), CentOS, Ubuntu, Debian und Ähnliches
    note important
    IMPORTANT
    Adobe Commerce wird auf Microsoft Windows oder macOS nicht unterstützt.

  • Adobe Systems Commerce 2.4.5-p1 oder höher (aufgrund der Abhängigkeit von Dienst Connector)

  • Commerce Services Connector extension

  • PHP CLI

  • Bash-/Shell-Dienstprogramme

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

Der Agent erfordert, dass die Commerce Services Connector Erweiterung auf Ihrem System installiert und mit API-Schlüsseln konfiguriert ist. Führen Sie den folgenden Befehl aus, um zu überprüfen, ob die Erweiterung installiert ist:

bin/magento module:status Magento_ServicesId

Wenn Sie die Erweiterung installiert und mit einem vorhandenen API-Schlüssel für einen anderen Dienst konfiguriert haben, MÜSSEN Sie den API-Schlüssel neu generieren und im Adobe Systems Commerce-Administrator für den Agenten aktualisieren.

  1. Setzen Sie Ihre Website in Wartungsmodus.

  2. Melden Sie sich bei account.magento.com an.

    note note
    NOTE
    Wenn Sie Probleme beim Zugriff auf Ihr -Konto haben, finden Sie unter Anmeldung beim Adobe Commerce-Support oder Cloud-Konto nicht möglich Hilfe zur Fehlerbehebung.

  3. Klicken Sie auf API Portal.

  4. Klicken Sie Delete neben dem vorhandenen API-Schlüssel.

  5. Konfigurieren Sie einen neuen API-Schlüssel.

IMPORTANT
Wenn Sie neue Schlüssel im API-Portal generieren, aktualisieren Sie die API-Schlüssel in der Admin configuration sofort. Wenn Sie neue Schlüssel generieren und die Schlüssel im Admin nicht aktualisieren, funktionieren Ihre SaaS-Erweiterungen nicht mehr und Sie verlieren wertvolle Daten.

Wenn die Erweiterung nicht installiert ist, verwenden Sie die folgenden Anweisungen, um sie zu installieren:

  1. Fügen Sie die Erweiterung Ihrer composer.json-Datei hinzu und installieren Sie sie.

    code language-bash 
    composer require magento/services-id

  2. Aktivieren Sie die Erweiterung.

    code language-bash 
    bin/magento module:enable Magento_ServicesId

  3. Aktualisieren Sie das Datenbankschema.

    code language-bash 
    bin/magento setup:upgrade

  4. Klar den Cache.

    code language-bash 
    bin/magento cache:clean

  5. Konfigurieren Sie API-Schlüssel , um die Erweiterung mit Ihrem System zu verbinden.

Installieren den Agenten

Wir haben ein Shell-Skript🔗 erstellt, um die Installation zu vereinfachen. Wir empfehlen die Verwendung des Shell-Skripts, Sie können aber bei Bedarf die manuelle Installationsmethode folgen.

INFO
Sobald der Agent installiert ist, aktualisiert er sich selbst, sobald eine neue Version verfügbar ist.

Gescript

  1. Herunterladen und Ausführen des Shell-Skripts.

    code language-bash 
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    note tip
    TIP
    Es wird empfohlen, den Agenten außerhalb Ihres Adobe Commerce-Stammprojektverzeichnisses zu installieren.

  2. Überprüfen Sie die Installation.

    code language-bash 
    ./scheduler -v
    code language-bash 
    Version: 1.0.1
Success exit.

  3. Nach dem Herunterladen und Installieren des Agenten konfigurieren Sie ihn fürAusführung) mit einer der folgenden Methoden:

    • Service (empfohlen, wenn Sie über Stammzugriff verfügen)

    • Cron

Manuell manual

Wenn Sie den Agenten nicht mit unserem Shell-Skript installieren möchten, müssen Sie ihn manuell installieren, indem Sie die folgenden Schritte ausführen:

  1. Erstellen Sie ein Verzeichnis, in das Sie den Agenten herunterladen möchten.

    note tip
    TIP
    Es wird empfohlen, den Agenten außerhalb Ihres Adobe Commerce-Stammprojektverzeichnisses zu installieren.

  2. Laden Sie die Binärdatei herunter und entpacken Sie sie.

    note info
    INFO
    Um die Site-Wide Analysis Toolzu verwenden, müssen Sie zunächst die Nutzungsbedingungen lesen und akzeptieren, die angezeigt werden, wenn Sie über den Adobe Systems Commerce-Administrator auf die Dashboard zugreifen.

    Für die AMD64-Architektur:

    1. Laden Sie das Starter-Archiv herunter.

      code language-bash 
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-amd64.tar.gz

    2. Entpacken Sie das Starter-Archiv.

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

    Für die ARM64-Architektur:

    1. Laden Sie das Starter-Archiv herunter.

      code language-bash 
      curl -O https://updater.supportinsights.adobe.com/launcher/launcher.linux-arm64.tar.gz

    2. Entpacken Sie das Starter-Archiv.

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

  3. (Optional) Überprüfen der Signatur für die Prüfsummendatei.

    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. (Optional) Überprüfen Sie die Prüfsumme.

    code language-bash 
    shasum -a 512 -c launcher.checksum

  5. Erstellen Sie die config.yaml-Datei mit folgendem Inhalt.

    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. Überprüfen Sie die Installation.

    code language-bash 
    scheduler -v
    code language-bash 
    Version: 1.0.1
Success exit.

  7. Nach dem Herunterladen und Installieren des Agenten müssen Sie ihn so konfigurieren, dass er ausgeführt, indem Sie eine der folgenden Methoden verwenden:

Ausführen des Agenten run-the-agent

Es wird empfohlen, den Agenten so zu konfigurieren, dass er als Dienst ausgeführt wird. Wenn Sie eingeschränkten Zugriff auf Ihre Infrastruktur haben und keine Stammberechtigungen haben, müssen Sie stattdessen cron verwenden.

Service service

  1. Erstellen Sie eine systemd-(/etc/systemd/system/scheduler.service) mit der folgenden Konfiguration (ersetzen Sie <filesystemowner> durch den UNIX®-Benutzer, dem das Verzeichnis gehört, in dem der Agent und die Adobe Commerce-Software installiert sind). Wenn Sie den Agenten als Root-Benutzer heruntergeladen haben, ändern Sie das Verzeichnis und den Besitzer der verschachtelten Dateien.

    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. Starten Sie den Service.

    code language-bash 
    systemctl daemon-reload
    code language-bash 
    systemctl start scheduler
    code language-bash 
    systemctl enable scheduler

  3. Überprüfen Sie, ob der Dienst ausgeführt wird.

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

Cron cron

Wenn Sie keine Stammberechtigungen haben oder nicht berechtigt sind, einen Service als Root zu konfigurieren, können Sie stattdessen cron verwenden.

Aktualisieren Sie Ihren Cron-Zeitplan:

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

Deinstallieren

Führen Sie die folgenden Befehle aus, um den Dienst von Ihrem System zu deinstallieren und alle generierten Dateien zu entfernen:

  1. Halt die Planung.

    code language-bash 
    systemctl stop scheduler

  2. Deaktivieren die Planung.

    code language-bash 
    systemctl disable scheduler

  3. Entfernen die Einheitendatei des Planung Dienstes systemd .

    code language-bash 
    rm /etc/systemd/system/scheduler.service

  4. Laden Sie die systemd Managerkonfiguration neu.

    code language-bash 
    systemctl daemon-reload

  5. Zurücksetzen alle systemd Einheiten, die sich in einem Fehlerzustand befinden.

    code language-bash 
    systemctl reset-failed

  6. Entfernen das Planung Dienstverzeichnis.

    code language-bash 
    rm -rf <CHECK_REGISTRY_PATH> #see SWAT_AGENT_APPLICATION_CHECK_REGISTRY_PATH in /etc/systemd/system/scheduler.service

  7. Entfernen Sie die Planungsbinärdatei.

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

Wenn Sie den Agenten stattdessen für die Ausführung mit Cron konfiguriert haben, verwenden Sie die folgenden Anweisungen:

  1. Entfernen Sie den Agenten aus der crontab-Liste.

    code language-bash 
    crontab -e

  2. Beenden Sie den laufenden Auftrag.

    code language-bash 
    ps aux | grep scheduler

  3. Entfernen Sie das Verzeichnis, in dem Sie den Agenten installiert haben.

    code language-bash 
    rm -rf swat-agent

Fehlerbehebung

Zugriffsschlüssel nicht ordnungsgemäß geparst

Wenn Ihre Zugriffsschlüssel nicht ordnungsgemäß analysiert werden, wird möglicherweise der folgende Fehler angezeigt:

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

Um diesen Fehler zu beheben, führen Sie die folgenden Schritte aus:

  1. Führen Sie eine Installation durch speichern Sie die Ausgabe und überprüfen Sie die Ausgabe auf Fehler.
  2. Überprüfen Sie die generierte config.yaml-Datei und überprüfen Sie, ob der Pfad zu Ihrer Commerce-Instanz und PHP korrekt ist.
  3. Stellen Sie sicher, dass sich der User, auf dem die Planung ausgeführt wird, im Dateisystem Verantwortlicher 🔗 Unix-Gruppe befindet oder mit dem Dateisystem identisch User Verantwortlicher ist.
  4. Stellen Sie sicher, dass die Commerce Services Connector-Schlüssel ordnungsgemäß installiert sind, und versuchen Sie, sie zu aktualisieren, um die Erweiterung mit Ihrem System zu verbinden.
  5. Deinstallieren Sie den Agenten nach dem Aktualisieren der Schlüssel und installieren Sie ihn mithilfe des Installationsskripts 🔗neu.
  6. Führen Sie die Planung aus und prüfen Sie, ob der Fehler weiterhin auftritt.
  7. Wenn Sie immer noch denselben Fehler erhalten, erhöhen Sie die Protokollebene in config.yaml Debugging und öffnen Sie ein Supportticket.

SIGFAULT Fehler

Wenn beim Ausführen der Binärdatei ein SIGFAULT-Fehler auftritt, führen Sie dies wahrscheinlich nicht als Dateibesitzer von Adobe Commerce- und Agentendateien aus.
Überprüfen Sie zur Behebung, ob alle Dateien im Agentenverzeichnis, die denselben Benutzer wie der Dateieigentümer haben, über den Adobe Commerce-Dateien verfügen, und die Binärdatei sollte auch unter diesem Benutzer ausgeführt werden.
Sie können den Befehl chown verwenden, um den Dateibesitzer zu ändern und zum entsprechenden Benutzer zu wechseln.
Stellen Sie sicher, dass Ihr Dämonisierungsmechanismus (Cron oder System.d) den Prozess unter dem entsprechenden Benutzer ausführt.

INFO
Siehe Zugreifen auf und Site-Wide Analysis Tool von Berichten.
recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3