Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.13 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.13 KB

Opbeat

Elixir client for Opbeat.

##Installation

Add module to mix.exs

def application do
  [applications: [:logger, :opbeat]]
end

def deps do
  [{:opbeat, github: "teodor-pripoae/opbeat"}]
end

Add following settings to config.exs

config :opbeat, :auth,
  %{org_id: System.get_env("OPBEAT_ORG_ID"), \
    app_id: System.get_env("OPBEAT_APP_ID"), \
    app_secret: System.get_env("OPBEAT_APP_SECRET")}

By default Opbeat logging is disabled. You must enabled it for production.exs or staging.exs

config :opbeat, :enabled, true

##Usage

To report and error:

if Opbeat.Client.enabled do
  Opbeat.Client.report(e)
end

You can also pass options misc and extra as Map:

Opbeat.Client.report(e, %{mymisc: "Some Value"}, %{myextra: "aaaa"})

##TODO

  • add support for http connection info
  • more tests with VCR
  • show more stacktrace information so it can be formatted properly on opbeat
  • make requests with HTTPoison.AsyncResponse