Packages
appsignal
2.5.0
2.17.4
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.11
2.15.10
2.15.9
2.15.8
2.15.7
2.15.6
2.15.5
2.15.4
2.15.3
2.15.2
2.15.1
2.15.0
2.14.1
2.14.0
2.13.4
2.13.3
2.13.2
2.13.1
2.13.0
2.12.3
2.12.2
2.12.1
2.12.0
2.11.0
2.10.2
2.10.1
2.10.0
2.9.2
2.9.1
2.9.0
2.8.3
2.8.2
2.8.1
2.8.0
2.7.13
2.7.12
2.7.11
2.7.10
2.7.9
2.7.8
2.7.7
2.7.6
2.7.5
2.7.4
2.7.3
2.7.2
2.7.1
2.7.0
2.7.0-beta.1
2.6.1
2.6.0
2.5.3
2.5.2
2.5.1
2.5.0
2.4.3
2.4.2
2.4.1
2.4.0
2.3.1
2.3.0
2.2.19
2.2.18
2.2.17
2.2.16
2.2.15
2.2.14
2.2.13
2.2.12
retired
2.2.11
2.2.10
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.15
2.1.14
2.1.13
2.1.12
2.1.11
2.1.10
2.1.9
2.1.8
2.1.7
2.1.7-beta.1
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.8
2.0.7
2.0.6
2.0.6-beta.1
2.0.5
retired
2.0.4
retired
2.0.3
retired
2.0.2
retired
2.0.1
retired
2.0.0
retired
2.0.0-beta.11
2.0.0-beta.10
2.0.0-beta.9
2.0.0-beta.8
2.0.0-beta.7
2.0.0-beta.6
2.0.0-beta.5
2.0.0-beta.4
2.0.0-beta.3
2.0.0-beta.2
2.0.0-beta.1
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.13.5
1.13.4
1.13.3
1.13.2
1.13.1
1.13.0
1.13.0-beta.2
1.13.0-beta.1
1.12.1
1.12.0
1.12.0-beta.3
1.12.0-beta.2
1.12.0-beta.1
1.11.8
1.11.7
1.11.6
1.11.5
1.11.4
1.11.3
1.11.2
1.11.1
1.11.0
1.11.0-beta.1
1.10.13
1.10.12
1.10.11
1.10.10
1.10.9
1.10.8
1.10.7
1.10.6
1.10.5
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.1-beta.1
1.9.0
1.9.0-beta.1
1.9.0-alpha.1
1.8.2
1.8.1
1.8.1-beta.2
1.8.1-beta.1
1.8.0
1.7.2
1.7.1
1.7.0
1.7.0-beta.2
1.7.0-beta.1
1.7.0-alpha.4
1.7.0-alpha.3
1.7.0-alpha.2
1.7.0-alpha.1
1.6.7
1.6.6
1.6.6-beta.2
1.6.6-beta.1
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-beta.1
1.6.0-alpha.1
1.5.1
1.5.0
1.5.0-beta.2
1.5.0-beta.1
1.4.11-beta.1
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-alpha.1
1.3.6
1.3.6-beta.1
1.3.5
1.3.4
1.3.4-beta.1
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-beta.3
1.3.0-beta.2
1.3.0-beta.1
1.2.3
1.2.2
1.2.1
1.2.0
1.1.1
1.1.0
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
1.0.0-rc.1
0.13.0
0.12.3
0.12.2
0.12.1
0.12.0
0.11.6
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
Collects error and performance data from your Elixir applications and sends it to AppSignal
Current section
Files
Jump to
Current section
Files
README.md
# AppSignal for Elixir[](https://travis-ci.org/appsignal/appsignal-elixir)[](https://hex.pm/packages/appsignal)AppSignal for Elixir monitors errors, performance and servers for Elixirapplications.- [AppSignal.com website](https://www.appsignal.com/elixir)- [AppSignal for Elixir documentation](https://docs.appsignal.com/elixir/)- [Package documentation](https://hexdocs.pm/appsignal/)- [Support][contact]## InstallationPlease follow the [installationguide](https://docs.appsignal.com/elixir/installation.html) on how to installand use this library.Then, add custom instrumentation or use one of the framework integrations toautomatically gain performance insights and error notifications. Currently,AppSignal has framework integrations for[Plug](https://github.com/appsignal/appsignal-elixir-plug) and[Phoenix](https://github.com/appsignal/appsignal-elixir-phoenix) andapplications.## UsageAppSignal will automatically monitor requests, report any exceptions that arethrown and any performance issues that might have occurred.You can also add extra information to requests by adding custominstrumentation. Read more in our [instrumentationguide](https://docs.appsignal.com/elixir/instrumentation/).## ConfigurationA complete list of all configurable options for AppSignal for Elixir isavailable in [ourdocumentation](https://docs.appsignal.com/elixir/configuration/).## Development### SetupBefore you can start developing on the AppSignal for Elixir project make sureyou have [Elixir installed](http://elixir-lang.org/install.html).This repository is managed by [mono](https://github.com/appsignal/mono/).Install mono on your local machine by [following the mono installationsteps](https://github.com/appsignal/mono/#installation).Then make sure you have all the project's dependencies installed by running thefollowing command: $ mono bootstrap### TestingTesting is done with ExUnit and can be run with the `mix test` command. You canalso supply a path to a specific file path you want to test and even a specificline on which the test you want to run is defined. $ mono test # The original command can still be used $ mix test $ mix test test/appsignal/some_test.ex:123This project has several different test suites defined with different mixenvironments. You can run them by specifying the specific type of test suite inthe `MIX_ENV` environment variable. # Default $ MIX_ENV=test mix test # Run the test suite with the NIF inoperational. This will generate errors # because the NIF is not active, but should run without failures. $ MIX_ENV=test_no_nif mix test### BenchmarkingThis package uses benchee to benchmark code. To run the benchmarker: $ MIX_ENV=bench mix run bench/<file>.exs### Branches and versionsThe `main` branch corresponds to the current release of thelibrary. The `develop` branch is used for development of features thatwill end up in the next minor release. If you fix a bug open a pullrequest on `main`, if it's a new feature on `develop`.### Making changesWhen making changes to the project that require a release, [add achangeset](https://github.com/appsignal/mono/#changeset-add) that will be usedto update the generated `CHANGELOG.md` file upon[release](#publishing-new-version). $ mono changeset add### Publishing new versions1. Merge the `develop` branch to `main` if necessary.- Run [`mono publish`](https://github.com/appsignal/mono/#publish) and follow the instructions.### Updating the CI build matrix1. Update `.semaphore/versions.rb` to add or remove Elixir/OTP versions, or `.semaphore/semaphore.yml.erb`.2. Run `script/generate_ci_matrix`.## ContributingThinking of contributing to our Elixir package? Awesome! 🚀Please follow our [Contributing guide][contributing-guide] in ourdocumentation and follow our [Code of Conduct][coc].Also, we would be very happy to send you Stroopwafles. Have look at everyonewe send a package to so far on our [Stroopwafles page][waffles-page].## Support[Contact us][contact] and speak directly with the engineers working onAppSignal. They will help you get set up, tweak your code and make sure you getthe most out of using AppSignal.Also see our [SUPPORT.md file](SUPPORT.md).## LicenseThe AppSignal for Elixir package source code is released under the MIT License.Check the [LICENSE](LICENSE) file for more information.[contact]: mailto:support@appsignal.com[contributing-guide]: https://docs.appsignal.com/appsignal/contributing.html[coc]: https://docs.appsignal.com/appsignal/code-of-conduct.html[waffles-page]: https://appsignal.com/waffles