Code Monkey home page Code Monkey logo

airbrakex's Introduction

Airbrakex Package Version Code Climate Build Status

Elixir client for the Airbrake service!

Installation

Add Airbrakex as a dependency to your mix.exs file:

defp deps do
  [{:airbrakex, "~> 0.1.9"}]
end

If on Elixir 1.3 or lower you will need to add it to your applications.

def application do
  [applications: [:airbrakex]]
end

Then run mix deps.get in your shell to fetch the dependencies.

Configuration

It requires project_key and project parameters to be set in your application environment, usually defined in your config/config.exs. logger_level and environment are optional.

config :airbrakex,
  project_key: "abcdef12345",
  project_id: 123456,
  logger_level: :error,
  environment: Mix.env

Advanced Configuration

If you want to use errbit instance, set custom url as endpoint. If you connect through a proxy or need to pass other specific options to HTTPoison you can use http_options, see https://hexdocs.pm/httpoison/HTTPoison.html#request/5 for a list of the available options.

config :airbrakex,
  project_key: "abcdef12345",
  project_id: 123456,
  endpoint: "http://errbit.yourdomain.com",
  http_options: [ssl: [cacertfile: "/path/to/certfile.pem"]]

Usage

try do
  IO.inspect("test",[],"")
rescue
  exception -> Airbrakex.notify(exception)
end

Logger Backend

There is a Logger backend to send logs to the Airbrake, which could be configured as follows:

config :logger,
  backends: [:console, Airbrakex.LoggerBackend]

Plug

You can plug Airbrakex.Plug in your web application Plug stack to send all exception to Airbrake

defmodule YourApp.Router do
  use Phoenix.Router
  use Airbrakex.Plug

  # ...
end

Ignore

You can ignore certain types of errors by specifying a global :ignore as well as an :ignore_backend config key:

Global ignore

This will prevent errors from being sent from the notifier to Airbrake

config :airbrakex,
  ...
  # List form
  ignore: [Phoenix.Router.NoRouteError]
  # OR
  # Function
  ignore: fn(error) ->
    cond do
      error.type == Phoenix.Router.NoRouteError -> true
      String.contains?(error.message, "Ecto.NoResultsError") -> true
      true -> false
    end
  end

Ignore Backend

This is only needed if you are using the Logger Backend.

:ignore_backend prevents logs from being sent from the backend to the notifier. For example, it can be used to prevent errors that are already being logged by the plug from double logging.

config :airbrakex,
  ...
  # Function
  ignore_backend: fn(log) ->
    cond do
      {_, message, _, _} = log ->
        Enum.at(message, 2) == "MyApp.Endpoint"
      true -> false
    end
  end

Thankx

Thank you!

Become Patreon

airbrakex's People

Contributors

aturkewi avatar danmarcab avatar fazibear avatar gaynetdinov avatar gsempe avatar jemc avatar jhalmeida avatar lpil avatar rodrigues avatar sgray avatar take-five avatar talum avatar thousandsofthem avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

airbrakex's Issues

Airbrakex.notify(exception) return 301 redirect

Not looks like the library is working, when i run the example of exception manually i dont receive success status but 301 redirect:

{:ok,
 %HTTPoison.Response{body: "",
  headers: [{"Location",
    "https://airbrake.io/api/v3/projects/126886/notices?key=ed8b5d05367bea21a3576a5ec31abb6b"},
   {"Content-Length", "0"}, {"Connection", "keep-alive"}], status_code: 301}}

And the exception not shows in Airbrake dashboard.

`:ignore` config key only works with the plug

Since the readme does not specify, I would have expected the :ignore key to work for all requests (going through the plug or just calling .notify directly as the readme suggests).

The check to ignore is only happening in the plug:

defp proceed?(ignore, _error) when is_nil(ignore), do: true

Maybe this check can be moved into the notifier module so it works throughout the package.

Errors on app boot with latest version

GenEvent handler Airbrakex.LoggerBackend installed in Logger terminating {:noreply, %{level: :error, metadata: []}} Last message: {:io_reply, #Reference<0.3354249149.804257793.86467>, :ok}
GenServer #PID<0.180.0> terminating {:noreply, %{level: :error, metadata: []}} Last message: {:gen_event_EXIT, Airbrakex.LoggerBackend, {:noreply, %{level: :error, metadata: []}}}

Exceptions seem to still get reported, though I'm unsure if any are missed.

Plug Broken In 1.7

Using the plug with the new version raises and error:

[error] #PID<0.542.0> running RegistrarWeb.Endpoint (cowboy_protocol) terminated
Server: localhost:4000 (http)
Request: GET /sadfasdf
** (exit) an exception was raised:
    ** (FunctionClauseError) no function clause matching in Map.from_struct/1

I believe is is associated to this change: https://github.com/fazibear/airbrakex/blob/master/lib/airbrakex/notifier.ex#L39
The plug returns errors as a map already and Map.from_struct/1 is expecting a struct.

I'll try and put a fix in if I can as I'm already working on putting in tests for the plug (so that I can add URLs to the context with the plug)

Adding language to the context when using Airbrakex.Plug

Hello,

We use Airbrakex.Plug for tracking our Elixir errors and we would like to include in the context of the notice that this is an Elixir error. When the Plug calls Notify.notify/2, it does not pass a context, so it seems that this is the function head that gets hit:

https://github.com/fazibear/airbrakex/blob/master/lib/airbrakex/notifier.ex#L38-L40

We would like in those cases for the context language to be set to "Elixir". Would you be open to a PR that makes that change? Or would you prefer that be configurable in some way?

301 when using default endpoint

iex(2)> Airbrakex.notify(%UndefinedFunctionError{reason: "test"})
{:ok,
 %HTTPoison.Response{body: "",
  headers: [{"Location",
    "https://airbrake.io/api/v3/projects/142622/notices?key=9ed9a66fa0482ea7155c89b1c5389
eda"},
   {"Content-Length", "0"}, {"Connection", "keep-alive"}], status_code: 301}}

Seems like we should be using https://airbrake.io now.

Also, the default of this lib is to use http, not https. This seems like a security risk

SSL certificate error

Our Airbrake notification errors have been working correctly until recently when we started getting SSL certification errors:

iex(1)> Airbrakex.notify RuntimeError.exception("hi")
[error] SSL: :certify: ssl_handshake.erl:1605:Fatal error: bad certificate

{:error, %HTTPoison.Error{id: nil, reason: {:tls_alert, 'bad certificate'}}}
config :airbrakex,
  environment: to_string(Mix.env()),
  project_key: Env.get("AIRBRAKE_API_KEY"),
  project_id: Env.get("AIRBRAKE_PROJECT_ID"),
  endpoint: "https://airbrake.io"

Does it look like we have the configuration wrong?

Errbit compatibility

It would be nice to be able to configure the endpoint one is hitting, as some organizations have their own Errbit instances running privately. You'd currently have to maintain a private fork of this repo to make that work. I'd be happy to submit a PR.

Seprate ignore config for backend

Right now, I need to explicitly wrap all processes that do not run through the plug to get error handling.

I'd like to just use the backend that you wrote to catch everything, but then I'm getting double reporting with the plug. It would be nice to have another ignore key like :ignore_backend that could have a different function than ignore (e.g. ignore anything from MyApp.Endpoint module...).

support for boolean values in `:ignore` config key

currently, to ignore all errors in a specific environment (such as :test or :dev), you set :ignore config to a simple function that returns true:

config :airbrakex,
  ignore: fn(_error) ->
    true
  end

it'd be more concise / convenient to allow users to set a boolean value here instead:

config :airbrakex, ignore: true

i have a branch open with the change. let me know if this is something you want to support, and i'll be happy to open a PR.

Do not rely on `Mix.env`

Since Mix is not(and should not) included to a release, executing this command inside a release:

Application.get_env(:airbrakex, :environment, Mix.env)

causes an exception like this:

** (exit) an exception was raised:
    ** (UndefinedFunctionError) undefined function Mix.env/0 (module Mix is not available)
        Mix.env()

You can either make environment param mandatory and remove default value(which is Mix.env) from get_env function call OR you can merge this PR #9. To be honest I don't know which option is better, probably the first one.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.