https://github.com/uzh/canary
Canary is a tool for automatically reporting runtime exceptions to issue trackers in OCaml projects.
https://github.com/uzh/canary
exception-reporting ocaml
Last synced: 10 months ago
JSON representation
Canary is a tool for automatically reporting runtime exceptions to issue trackers in OCaml projects.
- Host: GitHub
- URL: https://github.com/uzh/canary
- Owner: uzh
- License: other
- Created: 2022-02-22T08:50:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T08:28:39.000Z (over 2 years ago)
- Last Synced: 2025-07-02T16:41:45.368Z (12 months ago)
- Topics: exception-reporting, ocaml
- Language: OCaml
- Homepage:
- Size: 38.1 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canary
Canary is a tool for automatically reporting runtime exceptions to issue
trackers. Developed by the University of Zurich for internal projects using
OCaml.
# Doctrine
When using OCaml, one should almost always use error-aware return types such as
`option` or `result` to help structure application in such a way that any
problems that could be reasonably expected will be handled gracefully. However,
exceptional circumstances (or situations that you don't expect to have to deal
with) should still raise exceptions. Usually, an exception in production is
*exceptional* enough to demand the immediate attention of developers. That is
what Canary is for. Canary provides a standard interface for exception reporters,
in order to accelerate the development of reporters as well as facilitate
multi-reporting, or easier transitioning between different reporters.