DocumentaçãoCommerceFerramentas

Guia de instalação

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

Criado para:

  • Experiente
  • Administrador
  • Desenvolvedor
IMPORTANT
A partir de 23 de abril de 2024, o Site-Wide Analysis Tool será descontinuado para todos os clientes locais do Adobe Commerce.

O Site-Wide Analysis Tool fornece monitoramento, relatórios e recomendações de desempenho em tempo real 24 horas por dia, 7 dias por semana, para garantir a segurança e a operabilidade do Adobe Commerce nas instalações da infraestrutura em nuvem. Ela também fornece informações detalhadas sobre patches disponíveis e instalados, extensões de terceiros e a instalação do Adobe Commerce.

INFO
Saiba como habilitar o Site-Wide Analysis Tool e gerar relatórios.

Se você tiver uma instalação local do Adobe Commerce, instale um agente em sua infraestrutura para usar a ferramenta. Não é necessário instalar o agente no Adobe Commerce em projetos de infraestrutura em nuvem.

Agente

O Agente Site-Wide Analysis Tool permite usar o Site-Wide Analysis Tool para instalações locais do Adobe Commerce.

O Agente do Site-Wide Analysis Tool coleta dados de aplicativos e de negócios, analisa e fornece informações adicionais sobre a integridade da instalação para que você possa melhorar a experiência do cliente. Ele monitora os aplicativos e ajuda a identificar problemas de desempenho, segurança, disponibilidade e aplicativos.

A instalação do agente requer as seguintes etapas:

  1. Verifique os requisitos do sistema.

  2. Configurar chaves de API na extensão Commerce Services Connector.

  3. Instale o agente.

  4. Execute o agente.

INFO
O agente é compatível com instalações de vários nós do Adobe Commerce. Instale e configure o agente em cada nó.

Requisitos do sistema

Sua infraestrutura local deve atender aos seguintes requisitos antes de instalar o agente:

  • Sistemas operacionais

    • Linux x86-64 distribuições, como Red Hat® Enterprise Linux (RHEL), CentOS, Ubuntu, Debian, e similares
    note important
    IMPORTANT
    Não há suporte para Adobe Commerce em Microsoft Windows ou macOS.

  • Adobe Commerce 2.4.5-p1 ou posterior (devido à dependência do Service Connector)

  • Commerce Services Connector extension

  • CLI do PHP

  • Utilitários Bash/Shell

    • php

    • wget

    • awk

    • nice

    • grep

    • openssl

Commerce Services Connector

O agente requer que a extensão Commerce Services Connector seja instalada no sistema e configurada com chaves de API. Para verificar se a extensão está instalada, execute o seguinte comando:

bin/magento module:status Magento_ServicesId

Se você instalou a extensão e a configurou usando uma chave de API existente para um serviço diferente, DEVE regenerar a chave de API e atualizá-la no Administrador do Adobe Commerce para o agente.

  1. Coloque seu site no modo de manutenção.

  2. Faça logon em account.magento.com.

    note note
    NOTE
    Se você tiver problemas para acessar sua conta, consulte Não é possível fazer logon no suporte da Adobe Commerce ou na conta da nuvem para obter ajuda com a solução de problemas.

  3. Clique em API Portal.

  4. Clique em Delete ao lado da Chave de API existente.

  5. Configure uma nova chave de API.

IMPORTANT
Se você gerar novas chaves no Portal de API, atualize imediatamente as chaves de API no Admin configuration. Se você gerar novas chaves e não atualizá-las no Admin, suas extensões SaaS não funcionarão mais e você perderá dados valiosos.

Se a extensão não estiver instalada, use as seguintes instruções para instalá-la:

  1. Adicione a extensão ao arquivo composer.json e instale-o.

    code language-bash 
    composer require magento/services-id

  2. Ative a extensão.

    code language-bash 
    bin/magento module:enable Magento_ServicesId

  3. Atualize o esquema do banco de dados.

    code language-bash 
    bin/magento setup:upgrade

  4. Limpe o cache.

    code language-bash 
    bin/magento cache:clean

  5. Configure as Chaves de API para conectar a extensão ao seu sistema.

Instalar o agente

Criamos um script de shell para simplificar a instalação. Recomendamos o uso do script de shell, mas você pode seguir o método de instalação manual, se necessário.

INFO
Após a instalação do agente, ele se autoatualizará quando uma nova versão estiver disponível.

Com script

  1. Baixe e execute o script de shell.

    code language-bash 
    bash -c "$(wget -qO - https://raw.githubusercontent.com/magento-swat/install-agent-helpers/main/install.sh)"
    note tip
    TIP
    Recomendamos instalar o agente fora do diretório raiz do projeto Adobe Commerce.

  2. Verifique a instalação.

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

  3. Após baixar e instalar o agente, configure-o para ser executado usando um dos seguintes métodos:

Manual manual

Se você não quiser usar nosso script de shell para instalar o agente, instale-o manualmente seguindo estas etapas:

  1. Crie um diretório no qual deseja fazer download do agente.

    note tip
    TIP
    Recomendamos instalar o agente fora do diretório raiz do projeto Adobe Commerce.

  2. Baixe o arquivo binário e descompacte-o.

    note info
    INFO
    Para usar o Site-Wide Analysis Tool, você deve primeiro ler e aceitar os Termos de uso que são apresentados quando você acessa o painel pelo Administrador do Adobe Commerce.

    Para a arquitetura AMD64:

    1. Baixe o arquivo iniciador.

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

    2. Descompacte o arquivo iniciador.

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

    Para a arquitetura ARM64:

    1. Baixe o arquivo iniciador.

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

    2. Descompacte o arquivo iniciador.

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

  3. (Opcional) Verifique a assinatura do arquivo de soma de verificação.

    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. (Opcional) Verifique a soma de verificação.

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

  5. Crie o arquivo config.yaml com o conteúdo a seguir.

    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. Verifique a instalação.

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

  7. Após baixar e instalar o agente, você deve configurá-lo para execução usando um dos seguintes métodos:

Executar o agente run-the-agent

Recomendamos configurar o agente para ser executado como um serviço. Se você tiver acesso limitado à sua infraestrutura e não tiver permissões raiz, deverá usar o cron.

Serviço service

  1. Crie um arquivo de unidade sistêmica (/etc/systemd/system/scheduler.service) com a seguinte configuração (substitua <filesystemowner> pelo usuário UNIX® proprietário do diretório em que o agente e o software Adobe Commerce estão instalados). Se você baixou o agente como um usuário raiz, altere o diretório e o proprietário dos arquivos aninhados.

    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. Inicie o serviço.

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

  3. Valide se o serviço está ativo e em execução.

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

Cron cron

Se você não tiver permissões raiz ou não tiver permissões para configurar um serviço como raiz, poderá usar o cron.

Atualize seu cronograma 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 -

Desinstalar

Execute os seguintes comandos para desinstalar o serviço do sistema e remover todos os arquivos gerados:

  1. Interrompa o programador.

    code language-bash 
    systemctl stop scheduler

  2. Desative o programador.

    code language-bash 
    systemctl disable scheduler

  3. Remova o arquivo de unidade systemd do serviço de agendador.

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

  4. Recarregue a configuração do gerenciador systemd.

    code language-bash 
    systemctl daemon-reload

  5. Redefinir quaisquer systemd unidades de um estado de falha.

    code language-bash 
    systemctl reset-failed

  6. Remova o diretório de serviço do scheduler.

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

  7. Remova o arquivo binário do scheduler.

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

Se, em vez disso, você configurou o agente para ser executado com cron, use as seguintes instruções:

  1. Remova o agente da lista crontab.

    code language-bash 
    crontab -e

  2. Interrompa o job em execução.

    code language-bash 
    ps aux | grep scheduler

  3. Remova o diretório onde você instalou o agente.

    code language-bash 
    rm -rf swat-agent

Solução de problemas

Chaves de acesso não analisadas corretamente

Você pode observar o seguinte erro se as chaves de acesso não forem analisadas corretamente:

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

Para resolver esse erro, tente as seguintes etapas:

  1. Faça uma instalação com script, salve a saída e verifique se há erros na saída.
  2. Revise o arquivo config.yaml gerado e verifique se o caminho para sua instância do Commerce e PHP está correto.
  3. Verifique se o usuário que está executando o agendador está no grupo Unix proprietário do sistema de arquivos ou se é o mesmo usuário que o proprietário do sistema de arquivos.
  4. Verifique se as chaves do Commerce Services Connector estão instaladas corretamente e tente atualizá-las para conectar a extensão ao seu sistema.
  5. Desinstalar o agente depois de atualizar as chaves e reinstalar usando o script de instalação.
  6. Execute o scheduler e veja se você ainda recebe o mesmo erro.
  7. Se você ainda receber o mesmo erro, aumente o nível do log no config.yaml para depurar e abrir um tíquete de Suporte.

Erro SIGFAULT

Se você vir um erro SIGFAULT ao executar binário, provavelmente não o executa como proprietário dos arquivos do Adobe Commerce e do Agente.
Para resolver, verifique se todos os arquivos dentro do diretório do agente que têm o mesmo usuário que o proprietário do arquivo que os arquivos Adobe Commerce têm, e se o binário também deve ser executado nesse usuário.
Você pode usar o comando chown para alterar o proprietário dos arquivos e alternar para o usuário apropriado.
Certifique-se de que seu mecanismo de daemonização (Cron ou System.d) execute o processo no usuário apropriado.

INFO
Consulte Como acessar Site-Wide Analysis Tool e gerar relatórios.
recommendation-more-help
c2d96e17-5179-455c-ad3a-e1697bb4e8c3