Xdebug 구성

Xdebug은(는) PHP를 디버깅하기 위한 확장입니다. 선택한 IDE를 사용할 수 있지만, 다음은 로컬 환경에서 디버깅하도록 Xdebug 및 PhpStorm을(를) 구성하는 방법을 설명합니다.

NOTE
클라우드 인프라 프로젝트 구성에서 Adobe Commerce을 변경하지 않고 로컬 디버깅을 위해 Cloud Docker 환경에서 실행되도록 Xdebug을(를) 구성할 수 있습니다. Docker용 Xdebug 구성을 참조하십시오.

Xdebug을(를) 사용하려면 Git 저장소에서 파일을 구성하고 IDE를 구성하고 포트 전달을 설정해야 합니다. magento.app.yaml 파일에서 일부 설정을 구성할 수 있습니다. 편집한 후 모든 Starter 환경 및 Pro 통합 환경에서 Git 변경 사항을 푸시하여 Xdebug을(를) 사용하도록 설정합니다. Xdebug은(는) Pro 스테이징 및 프로덕션 환경에서 이미 사용할 수 있습니다.

구성하고 나면 CLI 명령, 웹 요청 및 코드를 디버깅할 수 있습니다. 모든 클라우드 인프라 환경은 읽기 전용입니다. 코드를 로컬 개발 환경에 복제하여 디버깅을 수행합니다. Pro 스테이징 및 프로덕션 환경의 경우 Xdebug에 대한 추가 지침을 참조하세요.

요구 사항

Xdebug을(를) 실행하고 사용하려면 환경에 대한 SSH URL이 필요합니다. Cloud Console 또는 Cloud Onboarding UI을(를) 통해 정보를 찾을 수 있습니다.

Xdebug 구성

Xdebug을(를) 구성하려면 다음 단계를 수행합니다.

분기 시작

Adobe Xdebug을(를) 추가하려면 개발 분기에서 작업하는 것이 좋습니다.

환경에서 Xdebug 활성화

모든 시작 환경 및 Pro 통합 환경에 직접 Xdebug을(를) 사용하도록 설정할 수 있습니다. 이 구성 단계는 Pro 프로덕션 및 스테이징 환경에는 필요하지 않습니다. Pro 스테이징 및 프로덕션용 디버그를 참조하십시오.

프로젝트에 대해 Xdebug을(를) 사용하려면 .magento.app.yaml 파일의 runtime:extensions 섹션에 xdebug을(를) 추가하십시오.

Xdebug를 사용하려면:

  1. 로컬 터미널에서 텍스트 편집기에서 .magento.app.yaml 파일을 엽니다.

  2. runtime 섹션의 extensions에서 xdebug을(를) 추가합니다. For example:

    code language-yaml
    runtime:
        extensions:
            - redis
            - xsl
            - newrelic
            - sodium
            - xdebug
    
  3. .magento.app.yaml 파일에 변경 내용을 저장하고 텍스트 편집기를 종료합니다.

  4. 변경 사항을 추가, 커밋 및 푸시하여 환경을 재배포합니다.

    code language-bash
    git add .magento.app.yaml
    
    code language-bash
    git commit -m "add xdebug"
    
    code language-bash
    git push origin <environment-ID>
    

Starter 환경 및 Pro 통합 환경에 배포되면 이제 Xdebug을(를) 사용할 수 있습니다. IDE 구성을 계속합니다. PhpStorm의 경우 PhpStorm 구성을 참조하십시오.

PhpStorm 서버 구성

Xdebug에서 제대로 작동하도록 PhpStorm IDE를 구성해야 합니다.

Xdebug에서 작동하도록 PhpStorm을 구성하려면:

  1. PhpStorm 프로젝트에서 설정 패널을 엽니다.

    • macOSPhpStorm > 설정 ​을 선택합니다.
    • Windows/Linux - 파일 > 설정 ​을 선택합니다.
  2. 설정 패널에서 PHP 섹션을 확장하고 서버 ​를 클릭합니다.

  3. 서버 구성을 추가하려면 + ​을(를) 클릭하십시오. 프로젝트 이름이 맨 위에 회색으로 표시됩니다.

  4. [선택 사항] 새 서버 구성에 대해 다음 설정을 구성합니다. PHPStorm 설명서에서 구성된 디버그 서버가 없음을 참조하십시오.

    • 이름—호스트 이름과 동일하게 입력합니다. 이 값은 디버깅에 CLI를 사용하려면 Debug CLI 명령PHP_IDE_CONFIG 변수 값과 일치해야 합니다.
    • 호스트—호스트 이름을 입력하십시오.
    • 포트443을(를) 입력하십시오.
    • 디버거Xdebug을(를) 선택합니다.
  5. 경로 매핑 사용 ​을 선택하십시오. 파일/디렉터리 창에 serverName에 대한 프로젝트의 루트가 표시됩니다.

  6. 서버의 절대 경로 열에서 편집 아이콘을 클릭하고 환경에 따라 설정을 추가합니다.

    • 모든 Starter 환경 및 Pro 통합 환경의 경우 원격 경로는 /app입니다.

    • Pro 스테이징 및 프로덕션 환경의 경우:

      • 프로덕션: /app/<project_code>/
      • 준비 중: /app/<project_code>_stg/
  7. Xdebug 포트를 9000,9003(으)로 변경하거나 PHP > Debug > Xdebug > Debug Port 패널에서 9000(으)로 제한할 수 있습니다.

  8. 적용 ​을 클릭합니다.

PHPStorm 실행/디버그 구성 만들기

이렇게 하면 응용 프로그램이 Adobe Commerce 응용 프로그램의 요청을 처리할 수 있는 올바른 디버그 설정을 가질 수 있습니다.

  1. PHPStorm 애플리케이션을 열고 화면 오른쪽 상단의 Add Configuration ​을(를) 클릭합니다.

  2. Add new run configuration ​을(를) 클릭합니다.

  3. PHP Remote Debug 옵션을 선택하십시오.

    • 고유하지만 인식할 수 있는 이름을 입력합니다.
    • Filter debug connection by IDE key** 확인란을 선택합니다.
    • 이전 섹션에서 만든 서버를 선택합니다. 아직 만들지 않은 경우 지금 만들 수 있지만 설정 안내서의 해당 부분을 참조하십시오.
    • IDE key(session id) 텍스트 필드에 대문자로 PHPSTORM을(를) 입력합니다. 설정의 다른 부분에서 이를 사용할 예정이므로 이 항목을 동일하게 유지하는 것이 중요합니다. 다른 문자열을 선택하는 경우 설정 및 구성 프로세스에서 다른 곳에 이 문자열을 사용해야 합니다.
  4. Apply > OK ​을(를) 클릭합니다.

포트 전달 설정

서버에서 로컬 시스템에 XDEBUG 연결을 매핑합니다. 모든 유형의 디버깅을 수행하려면 Adobe Commerce on cloud infrastructure 서버에서 로컬 시스템으로 포트 9000을 전달해야 합니다. 다음 섹션 중 하나를 참조하십시오.

Mac 또는 UNIX에서 포트 ®

Mac 또는 UNIX® 환경에서 포트 전달을 설정하려면:

  1. 터미널을 엽니다.

  2. SSH를 사용하여 연결을 설정하십시오.

    code language-bash
    ssh -R 9000:localhost:9000 <ssh url>
    

    소켓이 전달되는 포트에 연결될 때마다 터미널에 표시되도록 -v(verbose) 옵션을 사용합니다.

    "연결할 수 없음" 또는 "원격으로 포트를 수신 대기할 수 없음" 오류가 표시되면 포트 9000을 사용 중인 서버에 다른 활성 SSH 세션이 남아 있을 수 있습니다. 해당 연결이 사용되고 있지 않으면 연결을 종료할 수 있습니다.

연결 문제 해결:

  1. SSH를 사용하여 원격 통합, 스테이징 또는 프로덕션 환경에 로그인합니다.

  2. SSH 세션 목록 보기: who

  3. 사용자별 기존 SSH 세션을 봅니다. 자신 이외의 사용자에게 영향을 주지 않도록 주의하십시오!

    • 통합: 사용자 이름이 dd2q5ct7mhgus과(와) 비슷합니다.
    • 스테이징: 사용자 이름이 dd2q5ct7mhgus_stg과(와) 비슷합니다.
    • 프로덕션: 사용자 이름이 dd2q5ct7mhgus과(와) 비슷합니다.
  4. 기존 세션보다 오래된 사용자 세션의 경우 pts/0과(와) 같은 의사 터미널(PTS) 값을 찾습니다.

  5. PTS 값에 해당하는 프로세스 ID(PID)를 종료합니다.

    code language-bash
    ps aux | grep ssh
    kill <PID>
    

    샘플 응답:

    code language-none
    dd2q5ct7mhgus        5504  0.0  0.0  82612  3664 ?      S    18:45   0:00 sshd: dd2q5ct7mhgus@pts/0
    

    연결을 종료하려면 프로세스 ID(PID)와 함께 종료 명령을 입력합니다.

    code language-bash
    kill 3664
    

Windows에서 포트 전달

Windows에서 포트 전달(SSH 터널링)을 설정하려면 Windows 터미널 응용 프로그램을 구성해야 합니다. 이 예제에서는 Putty을(를) 사용하여 SSH 터널을 만드는 과정을 단계별로 설명합니다. Cygwin과 같은 다른 응용 프로그램을 사용할 수 있습니다. 다른 애플리케이션에 대한 자세한 내용은 해당 애플리케이션과 함께 제공되는 공급업체 설명서를 참조하십시오.

Putty를 사용하여 Windows에서 SSH 터널을 설정하려면:

  1. 아직 다운로드하지 않았다면 Putty을(를) 다운로드하십시오.

  2. 퍼티 시작해요

  3. 범주 창에서 세션 ​을 클릭합니다.

  4. 다음 정보를 입력합니다.

    • 호스트 이름(또는 IP 주소) 필드: 클라우드 서버의 SSH URL을(를) 입력하십시오.
    • 포트 필드: 22 입력

    Putty 설정

  5. 범주 창에서 연결 > SSH > 터널 ​을 클릭합니다.

  6. 다음 정보를 입력합니다.

    • Source 포트 필드: 9000 입력
    • 대상 필드: 127.0.0.1:9000 입력
    • 원격 클릭
  7. 추가 ​를 클릭합니다.

    Putty에서 SSH 터널 만들기

  8. 범주 창에서 세션 ​을 클릭합니다.

  9. 저장된 세션 필드에 이 SSH 터널의 이름을 입력하십시오.

  10. 저장 ​을 클릭합니다.

    SSH 터널 저장

  11. SSH 터널을 테스트하려면 로드 ​를 클릭한 다음 열기 ​를 클릭합니다.

    "연결할 수 없음" 오류가 표시되면 다음을 확인하십시오.

    • 모든 퍼티 설정이 올바릅니다.
    • 클라우드 인프라의 개인 Adobe Commerce SSH 키가 있는 컴퓨터에서 Putty를 실행하고 있습니다.

Xdebug 환경에 대한 SSH 액세스

디버깅을 시작하고 설정을 수행하는 등의 작업을 수행하려면 환경에 액세스하기 위한 SSH 명령이 필요합니다. Cloud Console 및 프로젝트 스프레드시트를 통해 이 정보를 가져올 수 있습니다.

Starter 환경 및 Pro 통합 환경의 경우 다음 magento-cloud CLI 명령을 사용하여 해당 환경에 SSH할 수 있습니다.

magento-cloud environment:ssh --pipe -e <environment-ID>

Xdebug을(를) 사용하려면 다음과 같이 환경에 SSH를 사용하십시오.

ssh -R <xdebug listen port>:<host>:<xdebug listen port> <SSH-URL>

For example,

ssh -R 9000:localhost:9000 pwga8A0bhuk7o-mybranch@ssh.us.magentosite.cloud

Pro Staging 및 프로덕션에 대한 디버그

NOTE
Pro 스테이징 및 프로덕션 환경에서는 Xdebug에 대한 특별 설정이 있으므로 Xdebug을(를) 항상 사용할 수 있습니다. 모든 일반 웹 요청이 Xdebug이(가) 없는 전용 PHP 프로세스로 라우팅됩니다. 따라서 이러한 요청은 정상적으로 처리되며 Xdebug이(가) 로드될 때 성능 저하의 영향을 받지 않습니다. Xdebug 키가 있는 웹 요청이 전송되면 Xdebug이(가) 로드된 별도의 PHP 프로세스로 라우팅됩니다.

특별히 Pro 계획 스테이징 및 프로덕션 환경에서 Xdebug을(를) 사용하려면 액세스 권한이 있는 사용자에게만 별도의 SSH 터널 및 웹 세션을 만듭니다. 이 사용법은 일반적인 액세스와는 다르며, 모든 사용자가 아닌 귀하에게만 액세스를 제공합니다.

다음이 필요합니다.

  • 환경에 액세스하기 위한 SSH 명령. Cloud Console 또는 Cloud Onboarding UI을(를) 통해 이 정보를 가져올 수 있습니다.

  • 스테이징 및 Pro 환경을 구성할 때 설정된 xdebug_key 값입니다.

    SSH를 사용하여 기본 노드에 로그인하고 다음을 실행하여 xdebug_key을(를) 찾을 수 있습니다.

    code language-bash
    cat /etc/platform/*/nginx.conf | grep xdebug.sock | head -n1
    

스테이징 또는 프로덕션 환경에 SSH 터널을 설정하려면:

  1. 터미널을 엽니다.

  2. 클러스터의 각 웹 노드에 대한 모든 SSH 세션을 정리합니다.

    code language-bash
    ssh USERNAME@CLUSTER.ent.magento.cloud 'rm /run/platform/USERNAME/xdebug.sock'
    
  3. 클러스터의 각 웹 노드에 대해 Xdebug에 대한 SSH 터널을 설정합니다.

    code language-bash
    ssh -R /run/platform/USERNAME/xdebug.sock:localhost:9000 -N USERNAME@CLUSTER.ent.magento.cloud
    
NOTE
USERNAME@CLUSTER.ent.magento.cloud에 대한 올바른 값을 얻으려면:
  • 방법 1: magento-cloud CLI: magento-cloud ssh --all
  • 메서드 2: Commerce 콘솔: https://CONSOLE-URL/ENVIRONMENT, SSH v 드롭다운을 클릭합니다.

환경 URL을 사용하여 디버깅을 시작하려면:

이는 사용된 구성에 대한 데모이자 원격 디버깅 세션을 시작하는 GET 매개변수에 대한 데모입니다.

  1. 원격 디버깅을 사용하도록 설정합니다. 브라우저의 사이트를 방문하여 KEY이(가) xdebug_key의 값인 URL에 다음을 추가하십시오.

    code language-http
    ?XDEBUG_SESSION_START=KEY
    

    이 단계에서는 Xdebug을(를) 트리거하기 위해 브라우저 요청을 보내는 쿠키를 설정합니다.

  2. Xdebug (으)로 디버깅을 완료합니다.

  3. 세션을 종료할 준비가 되면 다음 명령을 사용하여 쿠키를 제거하고 브라우저를 통해 디버깅을 종료합니다. 여기서 KEY은(는) xdebug_key의 값입니다.

    code language-http
    ?XDEBUG_SESSION_STOP=KEY
    
    note note
    NOTE
    POST 요청에 의해 전달된 XDEBUG_SESSION_START은(는) 지원되지 않습니다.

CLI 명령 디버그

이 섹션에서는 CLI 명령 디버깅에 대해 설명합니다.

CLI 명령을 디버깅하려면

  1. CLI 명령을 사용하여 디버그하려는 서버에 SSH를 연결합니다.

  2. 다음 환경 변수를 만듭니다.

    code language-bash
    export XDEBUG_CONFIG='PHPSTORM'
    
    code language-bash
    export PHP_IDE_CONFIG="serverName=<name of the server that is configured in PHPSTORM>"
    

    이 변수는 SSH 세션이 종료되면 제거됩니다.

  3. 디버깅 시작

    Starter 환경 및 Pro 통합 환경에서 CLI 명령을 실행하여 디버그합니다.
    다음과 같은 런타임 옵션을 추가할 수 있습니다.

    code language-bash
    php -d xdebug.profiler_enable=On -d xdebug.max_nesting_level=9999 bin/magento cache:clean
    

    Pro Staging 및 Production 환경에서는 다음과 같이 CLI 명령을 디버깅할 때 Xdebug PHP 구성 파일의 경로를 지정해야 합니다.

    code language-bash
    php -c /etc/platform/USERNAME/php.xdebug.ini bin/magento cache:clean
    

웹 요청 디버그

다음 단계는 웹 요청을 디버깅하는 데 도움이 됩니다.

  1. 확장 메뉴에서 디버그 ​를 클릭하여 사용하도록 설정합니다.

  2. 마우스 오른쪽 단추를 클릭하고 옵션 메뉴를 선택한 다음 IDE 키를 PHPSTORM(으)로 설정합니다.

  3. 브라우저에 Xdebug 클라이언트를 설치합니다. 구성 및 활성화합니다.

예: Chrome 설정

이 섹션에서는 Xdebug Helper 확장을 사용하여 Chrome에서 Xdebug을(를) 사용하는 방법에 대해 설명합니다. 다른 브라우저의 Xdebug 도구에 대한 자세한 내용은 브라우저 설명서를 참조하십시오.

Chrome에서 Xdebug 도우미를 사용하려면:

  1. 클라우드 서버에 대한 SSH 터널을(를) 만듭니다.

  2. Chrome 스토어에서 Xdebug Helper 확장 기능을 설치하십시오.

  3. 다음 그림과 같이 Chrome에서 확장을 활성화합니다.

    Chrome에서 Xdebug 확장 사용

  4. Chrome에서 Chrome 도구 모음의 녹색 도우미 아이콘을 마우스 오른쪽 단추로 클릭합니다.

  5. 팝업 메뉴에서 옵션 ​을 클릭합니다.

  6. IDE 키 목록에서 PhpStorm ​을 클릭합니다.

  7. 저장 ​을 클릭합니다.

    Xdebug 도우미 옵션

  8. PhpStorm 프로젝트를 엽니다.

  9. 위쪽 탐색 모음에서 수신 시작 아이콘을 클릭합니다.

    탐색 모음이 표시되지 않으면 보기 > 탐색 모음 ​을 클릭하세요.

  10. PhpStorm 탐색 창에서 테스트할 PHP 파일을 두 번 클릭합니다.

로컬 코드 디버그

읽기 전용 환경으로 인해 디버깅을 수행하려면 코드를 환경 또는 특정 Git 분기에서 로컬 워크스테이션으로 가져와야 합니다.

선택하는 방법은 사용자가 결정합니다. 다음과 같은 옵션이 있습니다.

  • Git에서 코드를 체크아웃하고 composer install을(를) 실행합니다.

    이 메서드는 composer.json이(가) 액세스 권한이 없는 개인 저장소의 패키지를 참조하지 않는 한 작동합니다. 이 메서드는 전체 Adobe Commerce 코드베이스를 가져옵니다.

  • vendor, app, pub, libsetup 디렉터리 복사

    이 방법을 사용하면 테스트할 수 있는 모든 코드가 있습니다. 보유한 정적 에셋 수에 따라 대량의 파일로 장기간 전송할 수 있습니다.

  • vendor 디렉터리만 복사

    대부분의 코드가 vendor 디렉터리에 있으므로 이 메서드는 전체 코드베이스를 테스트하지는 않지만 양호한 테스트를 초래할 수 있습니다.

파일을 압축하여 로컬 컴퓨터에 복사하려면:

  1. SSH를 사용하여 원격 환경에 로그인합니다.

  2. 파일을 압축합니다.

    code language-bash
    tar -czf /tmp/<file-name>.tgz <directory list>
    

    예를 들어 vendor 디렉터리만 압축하려면 다음을 수행합니다.

    code language-bash
    tar -czf /tmp/vendor.tgz vendor
    
  3. 로컬 환경에서 PhpStorm을 사용하여 파일을 압축합니다.

    code language-bash
    cd <phpstorm project root dir>
    
    code language-bash
    rsync <SSH-URL>:/tmp/<file-name>.tgz .
    
    code language-bash
    tar xzf <file-name>.tgz
    
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26