그누보드 Debugbar 플러그인

그누보드에 PHP Debug Bar를 추가하는 플러그인입니다. 그누보드의 실행 상태와 DB 쿼리, Hook, 요청 등 디버깅을 위한 기능을 제공합니다.

주의사항

이 플러그인은 디버깅을 위한 개발자용 도구이며, 서비스 중인 사이트에서 사용하지마세요.

이 플러그인이 출력하거나 저장하는 정보에 개인정보가 포함되거나 보안에 취약한 정보가 포함될 수 있습니다. 암호화되거나 암호화되지 않은 모든 유형의 데이터가 저장될 수 있습니다.

백그라운드 요청의 디버그 정보를 수집하기 위해 DB에 일부 데이터를 저장합니다. 이 데이터는 10MB 내외 또는 그 이상의 DB 용량을 차지할 수 있습니다.

설치 및 활성화 방법

• KG Framework 필수
  • 다운로드: https://sir.kr/g5_plugin?sfl=wr_subject&stx=KG+Framework
• PHP 7.4 버전 이상
• 그누보드 5.5.8.2.6 버전 이상
• 설치 경로: /kg/plugins/debugbar

활성화 방법

활성화

그누보드를 설치한 최상위 폴더에 config.custom.php 파일을 생성하여 다음과 같이 설정 할 수 있습니다.

• KG_DEBUGBAR_ENABLE
  • type: bool
  • default: false
  • Debugbar 활성화. 최고관리자에게만 활성화 됨
• KG_DEBUGBAR_ENABLE_IP
  • type: string
  • default: ''
  • 일치하는 IP에 대해 Debugbar 활성화
  • 쉼표(,)로 구분하여 여러 IP를 지정할 수 있음
  • IP를 지정하는 경우 해당 IP에 관리자 여부를 판단하지 않고 실행된 DB 쿼리 등 민감한 데이터가 보여질 수 있으므로 주의하세요
  • 서버 설정의 문제로 $_SERVER['REMOTE_ADDR']에 접속자의 IP가 제대로 전달되지 않아 모두 동일 IP로 전달되는 등의 문제가 있다면 서버 문제를 수정하거나 이 옵션을 사용하지 마세요

설정 예시

// 최고관리자 세션에서 Debugbar 활성화
$_ENV['KG_DEBUGBAR_ENABLE', true];

// 일치하는 IP에 Debugbar 항상 활성화
$_ENV['KG_DEBUGBAR_ENABLE_IP', '127.0.0.1,::1'];

DB 테이블 생성

백그라운드 요청의 디버그 정보를 확인하기 위해 DB 테이블을 생성해야 합니다.

위 활성화 과정을 거친 후 그누보드 관리자 페이지의 '환경설정 -> DB 업그레이드' 메뉴에 접근하면 자동으로 {prefix}_kg_debugbar_stack DB 테이블이 생성됩니다.

디버그 메시지 사용 방법

ddd() ^{Since v0.4.0}

ddd() 함수는 Debugbar의 'Messages' 탭에 메시지를 출력합니다.

ddd('Hello, world!');
ddd($g5);

// 첫번째 항목이 String이면 캡션처럼 사용됨
ddd('현재 회원', $member);

Ajax 등 백그라운드 요청

Ajax 등 백그라운드에서 실행되는 요청 또한 Debugbar에서 확인할 수 있습니다.

Debugbar 패널의 우측 상단 폴더 아이콘을 클릭하여 지난 내역을 볼 수 있으며 선택하여 해당 요청의 디버그 정보를 확인할 수 있습니다.

License (GNU LGPL v2.1 or later)

Copyright (C) 2023 Kkigomi (https://github.com/kkigomi)

이 플러그인은 자유 소프트웨어입니다. 자유 소프트웨어 재단이 공표한 GNU LGPL 2.1 또는 그 이후 버전을 임의로 선택해서 그 규정에 따라 이 플러그인을 수정하거나 재배포할 수 있습니다.

이 플러그인은 어떠한 형태의 보증도 제공하지 않습니다. 특정 목적 적합성 또는 상업성에 대한 묵시적 보증 역시 제공하지 않습니다. 알지 못했거나 이미 알고 있는 문제가 포함되어있을 수 있으며, 예측하거나 예측하지 못한 문제를 일으킬 수 있습니다. 보다 자세한 사항에 대해서는 GNU LGPL 2.1 버전 또는 이 플러그인에 포함된 LICENSE 파일을 확인하시기 바랍니다.

• 이 플러그인의 저장소
  • https://kg-framework.github.io/plugin-debugbar
• Awesome KG
• KG Framework
  • sir.kr에서 KG Framework 다운로드
• sir.kr에서 KG 플러그인 모두 찾기
• 그누보드5 가이드