Packages
raygun
0.0.9
0.4.0
0.3.2
0.3.1
0.3.0
0.2.0
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.45
0.0.44
0.0.43
0.0.42
0.0.41
0.0.40
0.0.39
0.0.38
0.0.37
0.0.36
0.0.35
0.0.34
0.0.33
0.0.32
0.0.31
0.0.30
0.0.29
0.0.28
0.0.27
0.0.26
0.0.25
0.0.24
0.0.23
0.0.22
0.0.21
0.0.20
0.0.19
0.0.18
0.0.17
0.0.16
0.0.15
0.0.14
0.0.13
0.0.12
0.0.11
0.0.10
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
Send errors in your application to Raygun. Raygun captures all your application errors in one place. It can be used as a Plug, via Logger and/or programmatically.
Current section
Files
Jump to
Current section
Files
README.md
Raygun
======
THIS IS AN **BETA** RELEASE. IT IS FUNCTIONAL, BUT MAY STILL HAVE BUGS!
## Install
Add the dependency to your mix.exs file.
```elixir
def deps do
[{:raygun, "~> 0.0.1"}]
end
```
Add Raygun and httpoison to the list of applications.
```elixir
def application do
[applications: [:logger, :raygun, :httpoison]
end
```
## Configuration
Add the following entry to your config/config.exs file.
```elixir
config :raygun,
api_key: "<INSERT YOUR API KEY HERE>"
```
You can *OPTIONALLY* add tags as well. These tags will be sent with every
reported error.
```elixir
config :raygun,
api_key: "<INSERT YOUR API KEY HERE>",
tags: ["tag1", "tag2"]
```
## Usage
There are three different ways you can use Raygun. All three ways may be combined,
but you _may_ send the same message multiple times if you do that.
### By Plug in Phoenix
Add the plug to your router:
```elixir
defmodule YourApp.Router do
use Phoenix.Router
use Raygun.Plug
# ...
end
```
We are still considering a few options for detecting the currently logged in
user. Since nearly every application handles it differently we will most
likely provide a configuration option that takes a callback. The function you
provide will be passed the Plug Conn state.
### Via the Logger
Any error logged with automatically be sent to Raygun.
Configure the Logger to use the Raygun backend. You can do this programmatically
```elixir
Logger.add_backend(Raygun)
```
or via configuration by adding Raygun as a backend in config/config.exs:
```elixir
config :logger,
backends: [:console, Raygun]
```
Any messages logged at :error level will be automatically sent to Raygun.
If you would like messages to be associated with a system user then add the
following configuration to config/config.exs:
```elixir
config :raygun,
system_user: %{
identifier: "myuserid",
isAnonymous: true,
email: "myuserid@example.com",
fullName: "Jane Doe",
firstName: "Jane",
uuid: "b07eb66c-9055-4847-a173-881b77cdc83e"
}
```
### Any Elixir code
Start our Raygun application (if you did not configure it as an application
in mix.exs)
```elixir
Raygun.start
```
Report an exception programmatically. Be sure that System.stacktrace will be
the correct stack trace!
```elixir
try do
:foo = :bar
rescue
exception -> Raygun.report(exception)
end
```
Or capture the stacktrace explicitly yourself and pass it to Raygun.
```elixir
try do
:foo = :bar
rescue
exception ->
stacktrace = System.stacktrace
Raygun.report(stacktrace, exception)
end
```
Both forms allow some custom context to be passed as an optional final
parameters as a Map. This will appear as 'userCustomData' under the custom
tab in Raygun's web interface.
```elixir
try do
:foo = :bar
rescue
exception ->
Raygun.report(System.stacktrace, exception, %{env: Mix.env})
end
```
## License
[LICENSE](LICENSE)