package canary

All checked builds pass
  1. Overview
  2. Docs
Capture unhandled exceptions and automatically report them through various channels

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (2)

Authors

  1. D
    Department of Economics, University of Zurich
  2. J
    John Christopher McAlpine

Maintainers

  1. E
    engineering@econ.uzh.ch

Sources

0.0.4.tar.gz
md5=5423f9c950ce2c64cdc0aa3428538d26
sha512=f349a195d1f469956952817cbbdaa59c2072609854ba334532e0fdca4e4f3704e56f7b595305998b60466dc22d248b9de4f1a2bc750d6c75a1ed760ab097dac5

Description

Developed by the University of Zurich, Canary is a tool for capturing unhandled exceptions and automatically reporting them to your development team.

Added to opam-repository:

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.

Dev Dependencies (6)

  1. odoc with-doc
  2. lwt_ssl >= "1.2.0" & with-test
  3. ssl >= "0.7.0" & with-test
  4. ocaml-lsp-server with-dev-setup
  5. ocamlformat with-dev-setup
  6. dune-release with-dev-setup

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building canary with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.0.4 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure