DokumentationCommerceInstrumente

Installationshandbuch

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Experte
  • Admin
  • Entwickler
IMPORTANT
Mit Wirkung vom 23. April 2024 wird der Site-Wide Analysis Tool für alle Adobe Commerce-Kunden vor Ort eingestellt.

Der Site-Wide Analysis Tool bietet rund um die Uhr eine Leistungsüberwachung, Berichte und Empfehlungen zur Gewährleistung der Sicherheit und Bedienbarkeit von Adobe Commerce bei Cloud-Infrastrukturinstallationen. Darüber hinaus finden Sie detaillierte Informationen zu verfügbaren und installierten Patches, Erweiterungen von Drittanbietern und Ihrer Adobe Commerce-Installation.

INFO
Erfahren Sie, wie Sie 🔗 die Site-Wide Analysis Tool aktivieren und Berichte generieren.

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

Agent

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

Der Site-Wide Analysis Tool-Agent sammelt Anwendungs- und Geschäftsdaten, analysiert sie und liefert zusätzliche Einblicke in den Zustand Ihrer Installation, sodass Sie das Kundenerlebnis verbessern können. Sie überwacht Ihre Anwendung und hilft Ihnen bei der Erkennung von Leistungs-, Sicherheits-, Verfügbarkeits- und Anwendungsproblemen.

Die Installation des Agenten erfordert die folgenden Schritte:

  1. Überprüfen Sie die Systemanforderungen.

  2. Konfigurieren Sie API-Schlüssel in der Erweiterung 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 die folgenden Anforderungen erfüllen, bevor der Agent installiert wird:

  • Betriebssysteme

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

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

  • Commerce Services Connector extension

  • PHP CLI

  • Bash-/Shell-Dienstprogramme

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

Der Agent erfordert die Installation der Erweiterung Commerce Services Connector auf Ihrem System und die Konfiguration 3} mit API-Schlüsseln.Um zu überprüfen, ob die Erweiterung installiert ist, führen Sie den folgenden Befehl aus:

bin/magento module:status Magento_ServicesId

Wenn Sie die Erweiterung installiert und mithilfe eines vorhandenen API-Schlüssels für einen anderen Dienst konfiguriert haben, MÜSSEN Sie den API-Schlüssel neu generieren und ihn im Adobe Commerce-Admin für den Agenten aktualisieren.

  1. Setzen Sie Ihre Website in den Wartungsmodus.

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

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

  3. Klicken Sie auf API Portal.

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

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

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

Wenn die Erweiterung nicht installiert ist, installieren Sie sie mit den folgenden Anweisungen:

  1. Fügen Sie die Erweiterung zu 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. Löschen Sie den Cache.

    code language-bash 
    bin/magento cache:clean

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

Installieren des Agenten

Wir haben ein Shell-Skript erstellt, um die Installation zu vereinfachen. Es wird empfohlen, das Shell-Skript zu verwenden. Sie können jedoch bei Bedarf die Methode manuelle Installation befolgen.

INFO
Nachdem der Agent installiert wurde, wird er automatisch aktualisiert, sobald eine neue Version verfügbar ist.

Skripten

  1. Laden Sie das Shell-Skript herunter und führen Sie es aus.

    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 des Stammordners des Adobe Commerce-Projekts zu installieren.

  2. Überprüfen Sie die Installation.

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

  3. Nachdem Sie den Agenten heruntergeladen und installiert haben, konfigurieren Sie ihn mithilfe einer der folgenden Methoden für die Ausführung von 🔗:

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

    • Cron

Manuell manual

Wenn Sie den Agenten nicht mithilfe unseres Shell-Skripts 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 des Stammordners des Adobe Commerce-Projekts zu installieren.

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

    note info
    INFO
    Um den Site-Wide Analysis Tool zu verwenden, müssen Sie zunächst die Nutzungsbedingungen lesen und akzeptieren, die beim Zugriff auf das Dashboard über den Adobe Commerce-Administrator angezeigt werden.

    Für die Architektur von AMD64:

    1. Laden Sie das Starterarchiv herunter.

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

    2. Entpacken Sie das Starterarchiv.

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

    Für die Architektur von ARM64:

    1. Laden Sie das Starterarchiv herunter.

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

    2. Entpacken Sie das Starterarchiv.

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

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

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

  5. Erstellen Sie die Datei "config.yaml" 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. Nachdem Sie den Agenten heruntergeladen und installiert haben, müssen Sie ihn mithilfe einer der folgenden Methoden für die Ausführung von 🔗 konfigurieren:

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

    • Cron

Ausführen des Agenten run-the-agent

Es wird empfohlen, den Agenten für die Ausführung als Dienst zu konfigurieren. Wenn Sie eingeschränkten Zugriff auf Ihre Infrastruktur haben und keine Root-Berechtigungen haben, müssen Sie stattdessen cron verwenden.

Dienst service

  1. Erstellen Sie eine systemd unit file (/etc/systemd/system/scheduler.service) mit der folgenden Konfiguration (ersetzen Sie <filesystemowner> durch den UNIX®-Benutzer, der Eigentümer des Ordners ist, in dem der Agent und die Adobe Commerce-Software installiert sind). Wenn Sie den Agenten als Stammbenutzer heruntergeladen haben, ändern Sie den Ordner und den Eigentümer 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 Dienst.

    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 aktiv ist.

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

Cron cron

Wenn Sie nicht über Root-Berechtigungen verfügen oder nicht über Berechtigungen zum Konfigurieren eines Dienstes als Root verfügen, 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 aus Ihrem System zu deinstallieren und alle generierten Dateien zu entfernen:

  1. Beenden Sie die Planung.

    code language-bash 
    systemctl stop scheduler

  2. Deaktivieren Sie die Planung.

    code language-bash 
    systemctl disable scheduler

  3. Entfernen Sie die Einheitendatei des Planungsdienstes "systemd".

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

  4. Laden Sie die Manager-Konfiguration systemd neu.

    code language-bash 
    systemctl daemon-reload

  5. Setzen Sie alle systemd -Einheiten aus einem fehlgeschlagenen Status zurück.

    code language-bash 
    systemctl reset-failed

  6. Entfernen Sie den Ordner des Scheduler-Dienstes.

    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 Binärdatei des Schedulers.

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

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

  1. Entfernen Sie den Agenten aus der Liste der Kronen.

    code language-bash 
    crontab -e

  2. Beenden Sie den laufenden Auftrag.

    code language-bash 
    ps aux | grep scheduler

  3. Entfernen Sie den Ordner, in dem Sie den Agenten installiert haben.

    code language-bash 
    rm -rf swat-agent

Fehlerbehebung

Zugriffsschlüssel nicht ordnungsgemäß analysiert

Wenn Ihre Zugriffsschlüssel nicht richtig 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 skriptgesteuerte Installation durch, speichern Sie die Ausgabe und überprüfen Sie die Ausgabe auf Fehler.
  2. Überprüfen Sie die generierte config.yaml -Datei und stellen Sie sicher, dass der Pfad zu Ihrer Commerce-Instanz und PHP korrekt ist.
  3. Stellen Sie sicher, dass sich der Benutzer, der den Planer ausführt, in der Unix-Gruppe Dateisysteminhaber oder demselben Benutzer wie der Dateisysteminhaber befindet.
  4. Vergewissern Sie sich, dass die Schlüssel Commerce Services Connector richtig installiert sind, und versuchen Sie, sie zu aktualisieren, um die Erweiterung mit Ihrem System zu verbinden.
  5. 🔗Deinstallieren Sie den Agenten, nachdem Sie die Schlüssel aktualisiert und mit dem Installationsskript neu installiert haben.
  6. Führen Sie den Planer aus und überprüfen Sie, ob Sie immer noch denselben Fehler erhalten.
  7. Wenn Sie immer noch denselben Fehler erhalten, erhöhen Sie die Protokollebene in config.yaml, um ein Support-Ticket zu debuggen und zu öffnen.

Fehler SIGFAULT

Wenn beim Ausführen der Binärdatei ein Fehler vom Typ SIGFAULT auftritt, führen Sie diesen wahrscheinlich nicht als Dateiinhaber von Adobe Commerce- und Agentendateien aus.
Um dieses Problem zu beheben, überprüfen Sie, ob alle Dateien im Agentenverzeichnis, die denselben Benutzer wie der Dateiinhaber haben, den Adobe Commerce-Dateien haben, und die Binärdatei auch unter diesem Benutzer ausgeführt werden sollen.
Sie können den Befehl chown verwenden, um den Dateiinhaber zu ändern und zum entsprechenden Benutzer zu wechseln.
Stellen Sie sicher, dass Ihr Daemonisierungsmechanismus (Cron oder System.d) den Prozess unter dem entsprechenden Benutzer ausführt.

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