버그 신고 패널로 앱에서 겪은 문제를 NeoSQL 에 바로 알립니다. 로그인하지 않아도 보낼 수 있고, 앱 버전과 OS, 지금 보던 화면, 최근 오류 로그가 자동으로 포함되어 있어 무엇을 하다 무슨 일이 생겼는지만 적으면 됩니다. 보내기 전에 함께 가는 내용을 모두 조회하고 수정하거나 삭제할 수 있습니다.
사용할 수 있는 곳웹데스크톱로그인 없이로그인로컬 프로젝트계정 프로젝트
화면 구성
| 번호 | 이름 | 설명 |
|---|---|---|
| 1 | 제목 칸 | 패널을 연 때 보던 화면의 이름(프로젝트에서는 탭의 종류와 이름)이 미리 들어 있습니다. 수정해 적어도 됩니다. |
| 2 | 증상 칸 | 무엇을 하다가 어떤 일이 생겼는지 적습니다. 다시 일으키는 순서를 알면 함께 적습니다. |
| 3 | 스크린샷 영역 | 이미지 첨부 버튼으로 선택하거나 패널에 드래그 앤 드롭합니다. PNG, JPEG, GIF, WebP 그림을 세 장까지, 한 장에 5MB 까지 붙입니다. |
| 4 | 오류 로그 | 앱이 모아 둔 최근 오류입니다. 옆에 오류 수가 보입니다. 새로고침, 비우기, 접기 버튼이 있고, 내용을 직접 수정해도 됩니다. |
| 5 | 환경정보 | 클릭하면 펼쳐집니다. 앱 버전, 클라이언트, OS, 현재 탭 / 페이지, DBMS, 언어 칸이 있고, 모두 수정할 수 있습니다. |
| 6 | 보내기 버튼 | 신고를 보냅니다. |
- DBMS 칸은 지금 보던 탭이 사용하는 커넥션의 DBMS 와 버전입니다. 프로젝트 밖에서 열었거나 커넥션이 없는 탭이면 해당 없음 표시가 들어갑니다.
- 패널은 화면을 가리지 않고 오른쪽에 표시되어 있습니다. 패널을 열어 둔 채 앱을 조작해 문제를 다시 일으켜 보고, 그동안 생긴 오류는 새로고침 버튼으로 오류 로그에 불러옵니다.
신고 보내기
- 헤더 오른쪽의 버그 신고 버튼을 클릭합니다. 문제가 생긴 화면에서 클릭하면 제목과 환경정보에 클릭한 화면이 들어갑니다.
- 제목 칸(1)을 확인하고 증상 칸(2)을 채웁니다. 두 칸은 비워 둘 수 없습니다.
- 필요하면 스크린샷 영역(3)에 이미지를 붙입니다.
- 오류 로그 영역(4)과 환경정보 영역(5)을 펼쳐 읽고, 보내고 싶지 않은 내용을 삭제하거나 수정합니다.
- 보내기 버튼(6)을 클릭합니다. 신고가 접수되었습니다. 감사합니다. 알림이 표시되고 패널이 닫힙니다.
함께 보내지는 것
| 내용 | 어디서 오는가 | 보내기 전에 |
|---|---|---|
| 제목, 증상, 스크린샷 | 내가 적고 붙인 것 | 수정합니다 |
| 오류 로그 | 앱을 실행한 뒤 생긴 오류 가운데 최근 것(최대 30건)입니다. 비밀번호, 토큰, API 키, 개인 키처럼 확실히 비밀인 값은 모을 때 *** 로 가립니다. | 수정하거나 비웁니다 |
| 환경정보 | 앱 버전, 웹, 데스크톱 구분, OS, 보던 화면, DBMS, 화면 언어 | 수정합니다 |
| 요청에 붙는 정보 | 앱 버전, 웹, 데스크톱 구분, 기기의 식별자(기기 ID)가 모든 요청에 붙어 함께 갑니다. 서버는 IP 주소와 앱 정보(User-Agent)를 기록하고, 로그인했으면 내 계정과 함께 기록합니다. | 읽기 전용입니다 |
- 프로젝트의 설계, SQL 문서, 커넥션 설정, 조회 결과는 따로 보내지 않습니다. 다만 오류 로그에는 오류 메시지에 들어 있던 SQL 문, 테이블 이름, 이메일 주소가 그대로 남을 수 있습니다. 문제를 찾는 단서라서 일부러 가리지 않으니, 보내기 전에 읽고 필요하면 삭제하세요.
- 붙인 스크린샷은 공개되지 않고 문제를 확인하는 데만 사용합니다. 스크린샷에 고객 데이터가 보이면 가리고 붙이세요.
- 신고가 접수되면 보낸 오류는 앱의 오류 로그에서 삭제되어 다음 신고에 다시 포함되지 않습니다.
보내지 못했을 때
보내지 못하면 패널이 닫히지 않고 아래에 이유가 나옵니다. 적은 내용은 그대로 있으니 다시 보내기 버튼을 클릭합니다.
| 안내 | 할 일 |
|---|---|
| 서버에 연결할 수 없습니다. 네트워크를 확인한 뒤 다시 시도해주세요. | 인터넷 연결을 확인하고 다시 보냅니다. |
| 잠시 후 다시 시도해주세요. 짧은 시간에 너무 많이 보냈습니다. | 잠시 기다렸다 다시 보냅니다. |
| 신고 전송에 실패했습니다. 잠시 후 다시 시도해주세요. | 잠시 뒤 다시 보냅니다. 계속 안 되면 문의하기 의 방법으로 알려 주세요. |
같은 패널에서 다시 보내면 같은 신고로 처리되어, 앞서 보낸 것이 실제로는 접수됐더라도 두 번 접수되지 않습니다.
주의할 점
- 패널 바깥을 클릭해도 패널은 닫히지 않습니다. 닫으려면
×버튼이나 취소 버튼을 클릭하거나, 패널을 클릭한 뒤Esc를 클릭합니다. 닫으면 적은 내용은 사라집니다. - 오류 로그는 앱을 실행해 둔 동안만 모읍니다. 앱을 다시 실행해기 전에 생긴 오류는 포함되지 않으니, 문제가 생긴 실행에서 신고해 주세요.
- 오류 로그 영역은 패널을 연 순간의 것입니다. 패널을 연 뒤 생긴 오류는 새로고침 버튼을 클릭해야 들어갑니다.
- 웹 앱의 OS 칸에는 브라우저가 알려 주는 정보(User-Agent)가 들어갑니다. 데스크톱 앱은 OS 버전과 칩 종류를 운영체제에서 직접 읽습니다.
관련 화면
- 앱 메뉴, 상단 바와 상태바: 버그 신고 버튼이 있는 헤더입니다.
- 보안과 데이터가 나가는 곳: 로그인하지 않아도 NeoSQL 서버와 주고받는 것입니다.
- 문제 해결: 신고하기 전에 확인할 수 있는 흔한 문제입니다.
- 문의하기: 버그 신고 말고 NeoSQL 에 연락하는 방법입니다.