ドキュメントCommerceツール

インストールガイド

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

作成対象：

  • 経験者
  • 管理者
  • 開発者
IMPORTANT
2024 年 4 月 23 日（PT）より、Adobe Commerceのオンプレミス環境のお客様の Site-Wide Analysis Tool は廃止されます。

Site-Wide Analysis Tool は、クラウドインフラストラクチャーのインストール時にAdobe Commerceのセキュリティと操作性を確保するために、24 時間 365 日、リアルタイムのパフォーマンスモニタリング、レポート、推奨事項を提供します。 また、使用可能なパッチおよびインストール済みのパッチ、サードパーティの拡張機能、Adobe Commerceのインストールに関する詳細情報も提供されます。

INFO
Site-Wide Analysis Tool ールとレポートの生成について 有効化する方法を説明します。

Adobe Commerceをオンプレミスでインストールしている場合は、このツールを使用するために、インフラストラクチャにエージェントをインストールします。 クラウドインフラストラクチャプロジェクトのAdobe Commerceにエージェントをインストールする必要はありません。

代理人

Site-Wide Analysis Tool Agent では、Adobe Commerceのオンプレミスインストールに Site-Wide Analysis Tool を使用できます。

Site-Wide Analysis Tool Agent は、アプリケーションおよびビジネスデータを収集して分析し、インストールの状態に関する追加のインサイトを提供することで、カスタマーエクスペリエンスを向上させます。 アプリケーションを監視し、パフォーマンス、セキュリティ、可用性、アプリケーションの問題を特定するのに役立ちます。

エージェントをインストールするには、次の手順が必要です。

  1. システム要件を確認します。

  2. Commerce Services Connector 拡張機能で API キーを設定します。

  3. エージェントをインストールします。

  4. エージェントを実行します。

INFO
このエージェントは、複数ノードのAdobe Commerceのインストールをサポートします。 各ノードにエージェントをインストールして設定します。

必要システム構成

エージェントをインストールする前に、オンプレミスインフラストラクチャが次の要件を満たしている必要があります。

  • オペレーティングシステム

    • Red Hat® Enterprise Linux (RHEL)、CentOS、Ubuntu、Debian などの Linux x86-64 ディストリビューション
    note important
    IMPORTANT
    Adobe Commerceは Microsoft Windows または macOS ではサポートされていません。

  • Adobe Commerce 2.4.5-p1 以降（サービスコネクタの依存関係による）

  • Commerce Services Connector extension

  • PHP CLI

  • Bash/shell ユーティリティ

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

エージェントを使用するには、Commerce Services Connector 拡張機能がシステムにインストールされ、API キーを使用して 設定されている必要があります。 拡張機能がインストールされていることを確認するには、次のコマンドを実行します。

bin/magento module:status Magento_ServicesId

拡張機能をインストールし、別のサービス用の既存の API キーを使用して設定した場合は、API キーを再生成し エージェントのAdobe Commerce管理者で更新する必要があります。

  1. Web サイトを メンテナンスモードにします。

  2. account.magento.com にログインします。

    note note
    NOTE
    アカウントへのアクセスで問題が発生した場合は、Adobe Commerce サポートまたは Cloud アカウントにログインできませんのトラブルシューティングヘルプを参照してください。

  3. 「API Portal」をクリックします。

  4. 既存の API キーの横にある「Delete」をクリックします。

  5. 設定新しい API キー。

IMPORTANT
API ポータルで新しいキーを生成した場合は、直ちに Admin configuration の API キーを更新します。 新しいキーを生成し、Admin のキーを更新しない場合、SaaS 拡張機能は機能しなくなり、貴重なデータが失われます。

拡張機能がインストールされていない場合は、次の手順を使用してインストールします。

  1. composer.json ファイルに拡張子を追加してインストールします。

    code language-bash 
    composer require magento/services-id

  2. 拡張機能を有効にします。

    code language-bash 
    bin/magento module:enable Magento_ServicesId

  3. データベーススキーマを更新します。

    code language-bash 
    bin/magento setup:upgrade

  4. キャッシュをクリアします。

    code language-bash 
    bin/magento cache:clean

  5. API キーを設定して、拡張機能をシステムに接続します。

エージェントのインストール

インストールを簡単にする シェルスクリプトを作成しました。 シェルスクリプトを使用することをお勧めしますが、必要に応じて 手動インストール方法に従うことができます。

INFO
エージェントのインストール後、新しいリリースが使用可能になると自動的にアップデートされます。

スクリプト化

  1. シェルスクリプトをダウンロードして実行します。

    code language-bash 
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    note tip
    TIP
    ルートのAdobe Commerce プロジェクトディレクトリの外部にエージェントをインストールすることをお勧めします。

  2. インストールを確認します。

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

  3. エージェントをダウンロードしてインストールした後、以下のいずれかの方法で 実行するように設定します。

手動 manual

シェルスクリプトを使用してエージェントをインストールしない場合は、次の手順に従って手動でインストールする必要があります。

  1. エージェントのダウンロード先となるディレクトリを作成します。

    note tip
    TIP
    ルートのAdobe Commerce プロジェクトディレクトリの外部にエージェントをインストールすることをお勧めします。

  2. バイナリファイルをダウンロードして解凍します。

    note info
    INFO
    Site-Wide Analysis Tool を使用するには、まずAdobe Commerce管理者からダッシュボードにアクセスする際に表示される利用条件を読み、同意する必要があります。

    AMD64 アーキテクチャの場合：

    1. ランチャーアーカイブをダウンロードします。

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

    2. ランチャーアーカイブを解凍します。

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

    ARM64 アーキテクチャの場合：

    1. ランチャーアーカイブをダウンロードします。

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

    2. ランチャーアーカイブを解凍します。

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

  3. （オプション） チェックサムファイルの署名を確認します。

    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. （オプション） チェックサムを確認します。

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

  5. 次の内容の config.yaml ファイルを作成します。

    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. インストールを確認します。

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

  7. エージェントをダウンロードしてインストールした後、次のいずれかの方法で 実行するように設定する必要があります。

エージェントの実行 run-the-agent

エージェントをサービスとして実行するように設定することをお勧めします。 インフラストラクチャへのアクセスが制限されていて、ルート権限がない場合は、代わりに cron を使用する必要があります。

サービス service

  1. 次の設定で systemd unit ファイル (/etc/systemd/system/scheduler.service) を作成します（<filesystemowner> を、エージェントおよびAdobe Commerceソフトウェアがインストールされているディレクトリを所有する UNIX® ユーザーに置き換えます）。 エージェントを root ユーザーとしてダウンロードした場合は、ディレクトリとネストされたファイルの所有者を変更します。

    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. サービスを起動します。

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

  3. サービスが起動および実行されていることを検証します。

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

Cron cron

root 権限がない場合、または root としてサービスを設定する権限がない場合は、cron を代わりに使用できます。

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 -

Uninstall

次のコマンドを実行して、システムからサービスをアンインストールし、生成されたすべてのファイルを削除します。

  1. スケジューラーを停止します。

    code language-bash 
    systemctl stop scheduler

  2. スケジューラーを無効にします。

    code language-bash 
    systemctl disable scheduler

  3. スケジューラーサービスの systemd 単位ファイルを削除します。

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

  4. systemd manager 設定をリロードします。

    code language-bash 
    systemctl daemon-reload

  5. エラー状態から systemd ユニットをリセットします。

    code language-bash 
    systemctl reset-failed

  6. スケジューラーサービスディレクトリを削除します。

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

  7. スケジューラーバイナリファイルを削除します。

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

代わりに cron を使用してエージェントを実行するように設定した場合は、次の手順を使用します。

  1. crontab リストからエージェントを削除します。

    code language-bash 
    crontab -e

  2. 実行中のジョブを停止します。

    code language-bash 
    ps aux | grep scheduler

  3. エージェントをインストールしたディレクトリを削除します。

    code language-bash 
    rm -rf swat-agent

トラブルシューティング

アクセスキーが正しく解析されていない

アクセスキーが正しく解析されていない場合は、次のエラーが表示される場合があります。

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

このエラーを解決するには、次の手順を試してください。

  1. スクリプト形式のインストールを実行し、出力を保存して、出力にエラーがないか確認します。
  2. 生成された config.yaml ファイルを確認し、Commerce インスタンスと PHP へのパスが正しいことを確認します。
  3. スケジューラーを実行しているユーザーが ファイルシステム所有者Unix グループに属しているか、ファイルシステム所有者と同じユーザーであることを確認します。
  4. Commerce サービスコネクタのキーが正しくインストールされていることを確認し、キーを更新して拡張機能をシステムに接続します。
  5. アンインストールキーを更新した後にエージェントをアンインストールし、 インストールスクリプトを使用して再インストールします。
  6. スケジューラーを実行して、同じエラーが引き続き表示されるかどうかを確認します。
  7. それでも同じエラーが発生する場合は、config.yaml のログレベルを上げてデバッグし、サポートチケットを開きます。

SIGFAULT エラー

バイナリの実行中に SIGFAULT エラーが発生した場合は、Adobe Commerceおよび Agent ファイルのファイルオーナーとしてこれを実行しない可能性があります。
これを解決するには、エージェントディレクトリ内のファイルのうち、Adobe Commerce ファイルのファイルオーナーと同じユーザーを持つすべてのファイルが、そのユーザーの下でもバイナリを実行する必要があるかどうかを確認してください。
chown コマンドを使用してファイルの所有者を変更し、適切なユーザーに切り替えることができます。
デーモンのメカニズム （Cron または System.d）で、適切なユーザーの下でプロセスが実行されていることを確認します。

INFO
詳しくは レポートへのアクセス Site-Wide Analysis Tool 生成の方法を参照してください。
recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3