DocumentatieCommerceGereedschappen

Hulplijn installeren

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Ervaren
  • Beheerder
  • Ontwikkelaar
IMPORTANT
Met ingang van 23 april 2024 wordt de Site-Wide Analysis Tool voor alle Adobe Commerce-klanten op locatie buiten bedrijf gesteld.

De Site-Wide Analysis Tool biedt 24/7 realtime prestatiebewaking, rapporten en aanbevelingen om de beveiliging en operabiliteit van Adobe Commerce bij installatie van wolkeninfrastructuur te garanderen. Het biedt ook gedetailleerde informatie over beschikbare en geïnstalleerde patches, extensies van derden en uw Adobe Commerce-installatie.

INFO
Leer hoe te omtoe te laten Site-Wide Analysis Tool en rapporten te produceren.

Als u een installatie van Adobe Commerce in de bedrijfsruimten hebt, installeert u een agent op uw infrastructuur om het hulpmiddel te gebruiken. U hoeft de agent niet op Adobe Commerce te installeren op cloudinfrastructuurprojecten.

Agent

Met de Site-Wide Analysis Tool -agent kunt u de Site-Wide Analysis Tool gebruiken voor installaties op locatie van Adobe Commerce.

De Site-Wide Analysis Tool Agent verzamelt toepassings- en bedrijfsgegevens, analyseert deze en biedt aanvullende inzichten over de gezondheid van uw installatie zodat u de gebruikerservaring kunt verbeteren. Het controleert uw toepassing en helpt u prestaties, veiligheid, beschikbaarheid, en toepassingskwesties identificeren.

Het installeren van de agent vereist de volgende stappen:

  1. Controleer de systeemvereisten.

  2. Configureer API-sleutels in de extensie Commerce Services Connector .

  3. Installeer de agent.

  4. Voer de agent uit.

INFO
De agent ondersteunt Adobe Commerce-installaties met meerdere knooppunten. Installeer en vorm de agent op elke knoop.

Systeemvereisten

Uw infrastructuur ter plaatse moet aan de volgende vereisten voldoen alvorens de agent te installeren:

  • Besturingssystemen

    • Linux x86-64 distributies, zoals Red Hat® Enterprise Linux (RHEL) , CentOS , Ubuntu , Debian en dergelijke
    note important
    IMPORTANT
    Adobe Commerce wordt niet ondersteund op Microsoft Windows of macOS .

  • Adobe Commerce 2.4.5-p1 of hoger (vanwege de afhankelijkheid van de Serviceconnector)

  • Commerce Services Connector extension

  • PHP CLI

  • Hulpprogramma's voor basis/shell

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

De agent vereist de Commerce Services Connectoruitbreiding die op uw systeem en wordt geïnstalleerd wordt gevormdmet API sleutels. Voer de volgende opdracht uit om te controleren of de extensie is geïnstalleerd:

bin/magento module:status Magento_ServicesId

Als u de uitbreiding hebt geïnstalleerd en het gevormd gebruikend een bestaande API sleutel voor de verschillende dienst, MOET u de API sleutel regenereren en het in Adobe Commerce Admin voor de agent bijwerken.

  1. Zet uw website in onderhoudswijze.

  2. Logboek in account.magento.com.

    note note
    NOTE
    Als u problemen hebt die tot uw rekening toegang hebben, zie Onbekwaam aan login aan de steun van Adobe Commerce of de wolkenrekeningvoor het oplossen van problemenhulp.

  3. Klik op API Portal.

  4. Klik op Delete naast de bestaande API-sleutel.

  5. vormeen nieuwe API sleutel.

IMPORTANT
Als u nieuwe sleutels in het Portaal van API produceert, werk onmiddellijk de sleutels API in Admin configuration bij. Als u nieuwe sleutels produceert en niet de sleutels in Admin bijwerkt, zullen uw uitbreidingen SaaS niet meer werken en u zult waardevolle gegevens verliezen.

Als de extensie niet is geïnstalleerd, gebruikt u de volgende instructies om deze te installeren:

  1. Voeg de extensie toe aan uw composer.json -bestand en installeer deze.

    code language-bash 
    composer require magento/services-id

  2. De extensie inschakelen.

    code language-bash 
    bin/magento module:enable Magento_ServicesId

  3. Werk het databaseschema bij.

    code language-bash 
    bin/magento setup:upgrade

  4. Wis de cache.

    code language-bash 
    bin/magento cache:clean

  5. vorm API Sleutelsom de uitbreiding met uw systeem te verbinden.

De agent installeren

Wij hebben a shell manuscriptgecreeerd om installatie te vereenvoudigen. Wij adviseren gebruikend het shell manuscript, maar u kunt de handinstallatiemethode indien nodig volgen.

INFO
Nadat de agent wordt geïnstalleerd, zal het automatisch bijwerken wanneer een nieuwe versie beschikbaar is.

Scripts

  1. Download en voer het shellscript uit.

    code language-bash 
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    note tip
    TIP
    We raden u aan de agent buiten de Adobe Commerce-hoofdprojectmap te installeren.

  2. Controleer de installatie.

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

  3. Na het downloaden en het installeren van de agent, vormt het omin werking te stellen gebruikend één van de volgende methodes:

    • Dienst(aangewezen als u worteltoegang hebt)

    • Cron

Handmatig manual

Als u niet ons shell manuscriptwilt gebruiken om de agent te installeren, dan moet u het manueel installeren door deze stappen te volgen:

  1. Maak een directory waarin u de agent wilt downloaden.

    note tip
    TIP
    We raden u aan de agent buiten de Adobe Commerce-hoofdprojectmap te installeren.

  2. Download het binaire bestand en pak het uit.

    note info
    INFO
    Als u Site-Wide Analysis Tool wilt gebruiken, moet u eerst de Gebruiksvoorwaarden lezen en accepteren die worden weergegeven wanneer u het dashboard opent via Adobe Commerce Admin.

    Voor de AMD64 architectuur:

    1. Download het archief van de startprogramma.

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

    2. Pak het archief van de draagprogramma's uit.

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

    Voor de ARM64 architectuur:

    1. Download het archief van de startprogramma.

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

    2. Pak het archief van de draagprogramma's uit.

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

  3. (Facultatief) verifieer de handtekening voor het checksum dossier.

    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. (Facultatief) verifieer de controlesom.

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

  5. Maak het config.yaml -bestand met de volgende inhoud.

    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. Controleer de installatie.

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

  7. Na het downloaden en het installeren van de agent, moet u het vormen omgebruikend één van de volgende methodes in werking te stellen:

    • Dienst(aangewezen als u worteltoegang hebt)

    • Cron

De agent uitvoeren run-the-agent

Wij adviseren vormend de agent om als dienst te lopen. Als u beperkte toegang tot uw infrastructuur hebt en geen worteltoestemmingen hebt, dan moet u bebouwenin plaats daarvan gebruiken.

Service service

  1. Maak een systeemeenheidsbestand (/etc/systemd/system/scheduler.service) met de volgende configuratie (vervang <filesystemowner> door de UNIX®-gebruiker die eigenaar is van de map waarin de agent en de Adobe Commerce-software zijn geïnstalleerd). Als u de agent als hoofdgebruiker hebt gedownload, wijzigt u de map en de eigenaar van geneste bestanden.

    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. Start de service.

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

  3. Bevestig dat de dienst in gebruik is.

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

Cron cron

Als u geen worteltoestemmingen hebt of geen toestemmingen hebt om de dienst als wortel te vormen, kunt u in plaats daarvan kroon gebruiken.

Uw uitsnijdschema bijwerken:

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

Verwijderen

Voer de volgende opdrachten uit om de service van uw systeem te verwijderen en alle gegenereerde bestanden te verwijderen:

  1. Stop de planner.

    code language-bash 
    systemctl stop scheduler

  2. Schakel de planner uit.

    code language-bash 
    systemctl disable scheduler

  3. Verwijder het systemd eenheidsdossier van de plannerdienst.

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

  4. Laad de systemd -beheerconfiguratie opnieuw.

    code language-bash 
    systemctl daemon-reload

  5. Stel om het even welke systemd eenheden van een ontbroken staat terug.

    code language-bash 
    systemctl reset-failed

  6. Verwijder de folder van de plannerdienst.

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

  7. Verwijder het binaire dossier van de planner.

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

Als u de agent aan looppas met kroon vormde, gebruik in plaats daarvan de volgende instructies:

  1. Verwijder de agent uit de contextlijst.

    code language-bash 
    crontab -e

  2. Stop de actieve taak.

    code language-bash 
    ps aux | grep scheduler

  3. Verwijder de folder waar u de agent installeerde.

    code language-bash 
    rm -rf swat-agent

Problemen oplossen

Toegangstoetsen niet correct geparseerd

U ziet mogelijk de volgende fout als uw toegangstoetsen niet correct worden geparseerd:

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

Voer de volgende stappen uit om deze fout op te lossen:

  1. Doe a gescripte installeert, sparen de output, en herzie de output voor fouten.
  2. Controleer het gegenereerde config.yaml bestand en controleer of het pad naar uw Commerce-instantie en PHP juist is.
  3. Zorg ervoor dat de gebruiker die de planner in werking stelt in de eigenaar van het dossiersysteemUnix groep is of de zelfde gebruiker zoals de eigenaar van het dossiersysteem is.
  4. Zorg ervoor dat de 🔗 sleutels van de Schakelaar van de Diensten van 0} Commerce correct geïnstalleerd zijn en probeer hen bij te werken om de uitbreiding met uw systeem te verbinden.
  5. desinstalleerde agent na het bijwerken van de sleutels en herinstalleer gebruikend installeer manuscript.
  6. Stel de planner in werking en zie of ontvangt u nog de zelfde fout.
  7. Als u nog steeds dezelfde fout ontvangt, verhoogt u het logniveau in de config.yaml om fouten op te sporen en een ondersteuningsticket te openen.

SIGFAULT Fout

Als u a SIGFAULT fout wanneer het runnen van binair getal ziet, stelt u waarschijnlijk niet dit als dossiereigenaar van Adobe Commerce en de dossiers van de Agent in werking.
Om op te lossen, gelieve te controleren of alle dossiers binnen de agentenfolder die de zelfde gebruiker hebben zoals de fileowner die de dossiers van Adobe Commerce hebben, en binair zou ook onder die gebruiker moeten worden in werking gesteld.
U kunt de opdracht chown gebruiken om de eigenaar van de bestanden te wijzigen en over te schakelen op de juiste gebruiker.
Zorg ervoor dat het proces onder de juiste gebruiker wordt uitgevoerd met het mechanisme voor demonisatie (Cron of System.d).

INFO
Zie hoe te om tot Site-Wide Analysis Tool toegang te hebben en rapportente produceren.
recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3