Stowage/browsertrix-crawler
2
0
Fork 0
mirror of https://github.com/webrecorder/browsertrix-crawler.git synced 2025-10-19 06:23:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation on exit codes (#765)

Browse source 
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
This commit is contained in:
benoit74 2025-02-11 18:16:29 +01:00 • committed by GitHub
parent fc56c2cf76
commit 4b72b7c7dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/docs/user-guide/exit-codes.md Normal file
View file

@ -0,0 +1,19 @@
# Exit codes
The crawler uses following exit codes to indicate crawl result.
| Code | Name | Description |
|--|--|--|
| 0 | Success | Crawl completed normally |
| 1 | GenericError | Unspecified error, check logs for more details |
| 3 | OutOfSpace | Disk is already full |
| 9 | Failed | Crawl failed unexpectedly, might be worth retrying |
| 10 | BrowserCrashed | Browser used to fetch pages has crashed |
| 11 | SignalInterrupted | Crawl stopped gracefully in response to SIGINT signal |
| 12 | FailedLimit | Limit on amount of failed pages, configured with `--failOnFailedLimit`, has been reached |
| 13 | SignalInterruptedForce | Crawl stopped forcefully in response to SIGTERM or repeated SIGINT signal |
| 14 | SizeLimit | Limit on maximum WARC size, configured with `--sizeLimit`, has been reached |
| 15 | TimeLimit | Limit on maximum crawl duration, configured with `--timeLimit`, has been reached |
| 16 | DiskUtilization | Limit on maximum disk usage, configured with `--diskUtilization`, has been reached |
| 17 | Fatal | A fatal (non-retryable) error occured |
| 21 | ProxyError | Unable to establish connection with proxy |

1
docs/mkdocs.yml
View file

@ -51,6 +51,7 @@ nav:
- User Guide:
- user-guide/index.md
- user-guide/outputs.md
- user-guide/exit-codes.md
- user-guide/common-options.md
- user-guide/crawl-scope.md
- user-guide/yaml-config.md