Menu

AppSignal for Elixir: Check installation tool

This feature requires AppSignal for Elixir version 2.15.3 or higher.

The AppSignal for Elixir package ships with a command line tool to check if the package's extension (a NIF) was installed correctly.

Our package does not error or fail builds when the extension is not installed correctly. This behavior is by design.

We would rather have no data reported to AppSignal than have entire applications brought down because our extension could not be installed.

We know it's not always easy to check if our package and extension were installed correctly. In some cases, failing a build or deployment when this happens is the best approach. The check install tool can help with this.

If you want the build to fail when our extension isn't installed correctly, you can run the check installation task in your CI (Continuous Integration) or deployment process as described below. The command will fail with status code 1 when the extension is not installed correctly.

Usage

In your project's command line, run:

Shell
mix appsignal.check_install

With a release binary

In your project's command line, run:

Shell
bin/your_app command appsignal_tasks check_install

Exit codes

  • Exits with status code 0 if the extension installation was successful.
  • Exits with status code 1 if the extension installation was unsuccessful.