AppSignal  Docs

Visit AppSignal.com
Jump to navigation

Installing AppSignal for Elixir

Installing the AppSignal package in your Elixir application requires a couple manual steps. Currently pure Elixir applications and the Phoenix framework are supported. Both use-cases are described in this guide.

If AppSignal does not support your use-case or if you find a problem with the documentation, don't hesitate to contact us. You can also create a pull-request on our public Elixir repository or documentation repository.

Installation

Requirements

Before you can compile the AppSignal package make sure the build/compilation tools are installed for your system.

Ubuntu / Debian

1
2
sudo apt-get update
sudo apt-get install build-essential

Alpine Linux

1
apk add --update alpine-sdk coreutils

macOS

1
xcode-select --install

Installing the package

  1. Start by adding appsignal to your list of dependencies in mix.exs.

    1
    2
    3
    4
    # mix.exs
    def deps do
      [{:appsignal, "~> 0.0"}]
    end
  2. Ensure appsignal is started before your application.

    1
    2
    3
    4
    # mix.exs
    def application do
      [applications: [:appsignal]]
    end
  3. Then run mix deps.get

  4. Then run mix appsignal.install your-push-api-key or follow the manual configuration guide.

  5. If you use the Phoenix framework, continue with the integrating AppSignal into Phoenix guide.

After the installation is complete start your application. When the AppSignal OTP application starts, it looks for a valid configuration (e.g. an AppSignal Push API key), and start the AppSignal agent.

If it can't find a valid configuration, a warning will be logged. See the Configuration section on how to fully configure the AppSignal agent.

Configuration

Before the AppSignal package works you need to configure it. To be able to send data to AppSignal you first need to create an account on AppSignal.com. Or, if you already have an account, click on the "add app" button on AppSignal.com/accounts.

During the installation process you can run the mix appsignal.install command with the hexadecimal Push API key or manually configure AppSignal using the guide below.

For more information about configuring the AppSignal package for Elixir, please read our configuration documentation.

Manual configuration

If you want to manually configure AppSignal you will need to place the AppSignal Push API key you receive in the installation process in your application's config/config.exs configuration file.

Using the AppSignal configuration you are also able to configure an application name and environment and more.

1
2
3
4
5
6
# config/config.exs
config :appsignal, :config,
  active: true,
  name: "My awesome app",
  push_api_key: "your-push-api-key",
  env: Mix.env

Alternatively, you can configure AppSignal using OS environment variables.

1
2
3
export APPSIGNAL_PUSH_API_KEY="your-push-api-key"
export APPSIGNAL_APP_NAME="My awesome app"
export APPSIGNAL_APP_ENV="prod"

For more information about configuring the AppSignal package for Elixir, please read our configuration options page.

Run your application!

Once you've completed this guide your application is ready to be monitored by AppSignal!

Start your application up and perform some requests on it. By triggering an error or two you'll also test the error reporting.

Contact us if you have questions regarding installation or encountered any problems during the installation.

Optional: Add Phoenix instrumentation

Read more about how you can integrate more instrumentation in your Phoenix application in our integrating Phoenix guide.

Optional: Add custom instrumentation

Add custom instrumentation to your application to get a more in-depth view of what's happening in your application. Read more about custom instrumentation in our instrumentation documentation.

Want to help us improve this documentation page? Create a pull request