60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# crash-reporter
|
|
|
|
다음 예제는 윈격 서버에 어플리케이션 오류 정보를 자동으로 보고하는 예제입니다:
|
|
|
|
```javascript
|
|
crashReporter = require('crash-reporter');
|
|
crashReporter.start({
|
|
productName: 'YourName',
|
|
companyName: 'YourCompany',
|
|
submitUrl: 'https://your-domain.com/url-to-submit',
|
|
autoSubmit: true
|
|
});
|
|
```
|
|
|
|
## crashReporter.start(options)
|
|
|
|
* `options` Object
|
|
* `productName` String, 기본값: Electron
|
|
* `companyName` String, 기본값: GitHub, Inc
|
|
* `submitUrl` String, 기본값: http://54.249.141.255:1127/post
|
|
* Crash Reporter는 POST 방식으로 해당 URL에 전송됩니다.
|
|
* `autoSubmit` Boolean, 기본값: true
|
|
* true로 지정할 경우 유저의 승인 없이 자동으로 오류를 보고합니다.
|
|
* `ignoreSystemCrashHandler` Boolean, 기본값: false
|
|
* `extra` Object
|
|
* 오류보고 시 같이 보낼 추가 정보를 지정하는 객체입니다.
|
|
* 문자열로 된 속성만 정상적으로 보내집니다.
|
|
* 중첩 객체는 지원되지 않습니다. (Nested objects are not supported)
|
|
|
|
다른 crashReporter API들을 사용하기 전에 이 함수를 먼저 호출해야 합니다.
|
|
|
|
|
|
**알림:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다.
|
|
오류 수집 기능을 활성화 시키려면 오류를 수집하고 싶은 메인 프로세스나 랜더러 프로세스에서
|
|
`crashReporter.start` 함수를 호출하여 `crashpad`를 초기화 해야합니다.
|
|
|
|
## crashReporter.getLastCrashReport()
|
|
|
|
마지막 오류보고의 날짜와 ID를 반환합니다.
|
|
이전 오류보고가 없거나 Crash Reporter가 시작되지 않았을 경우 `null`이 반환됩니다.
|
|
|
|
## crashReporter.getUploadedReports()
|
|
|
|
모든 업로드된 오류보고를 반환합니다. 각 보고는 날짜와 업로드 ID를 포함하고 있습니다.
|
|
|
|
# crash-reporter 오류보고 형식
|
|
|
|
Crash Reporter는 다음과 같은 데이터를 `submitUrl`에 `POST` 방식으로 전송합니다:
|
|
|
|
* `rept` String - 예시 'electron-crash-service'
|
|
* `ver` String - Electron의 버전
|
|
* `platform` String - 예시 'win32'
|
|
* `process_type` String - 예시 'renderer'
|
|
* `ptime` Number
|
|
* `_version` String - `package.json`내의 `version` 필드
|
|
* `_productName` String - Crash Reporter의 `options` 객체에서 정의한 제품명.
|
|
* `prod` String - 기본 제품의 이름. 이 경우 Electron으로 표시됩니다.
|
|
* `_companyName` String - Crash Reporter의 `options` 객체에서 정의한 회사명.
|
|
* `upload_file_minidump` File - 오류보고 파일
|
|
* Crash Reporter의 `options` 객체에서 정의한 `extra` 객체의 속성들.
|