Merge pull request #108 from getsentry/hackney-opts

allow setting hackney opts

Author: mitchellhenke

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## master
+
+* Enhancements
+  * Allow setting `hackney_opts`
+
 ## 2.1.0 (2016-12-17)
 
 * Enhancements

README.md

@@ -67,6 +67,7 @@ config :sentry,
 | `release` | False  | None | |
 | `server_name` | False  | None | |
 | `use_error_logger` | False  | False | |
+| hackney_opts | False  | [] | |
 
 An example production config might look like this:
 
@@ -77,7 +78,8 @@ config :sentry,
   included_environments: [:prod],
   tags: %{
     env: "production"
-  }
+  },
+  hackney_opts: [pool: :my_pool]
 ```
 
 The `environment_name` and `included_environments` work together to determine
@@ -111,6 +113,8 @@ Now, on our servers, we can set the environment variable appropriately. On
 our local development machines, exceptions will never be sent, because the
 default value is not in the list of `included_environments`.
 
+Sentry uses the [hackney HTTP client](https://github.com/benoitc/hackney) for HTTP requests.  If you need to set [hackney configurations](https://github.com/benoitc/hackney/blob/master/doc/hackney.md#request5) for things like a proxy or different pool, the `hackney_opts` configuration is passed directly to hackney.
+
 ## Testing Your Configuration
 
 To ensure you've set up your configuration correctly we recommend running the

docs/config.rst

@@ -57,6 +57,10 @@ Optional settings
   Set this to a module that implements the ``Sentry.EventFilter`` behaviour if you would like to prevent
   certain exceptions from being sent.  See below for further documentation.
 
+.. describe:: hackney_opts
+
+  Sentry uses `hackney <https://github.com/benoitc/hackney>`_.  If you would like to set `options <https://github.com/benoitc/hackney/blob/master/doc/hackney.md#request5>`_ for hackney requests, they can be provided via this configuration.
+
 Testing Your Configuration
 --------------------------
 

lib/mix/tasks/sentry.send_test_event.ex

@@ -18,12 +18,14 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
     end
 
     environment_name = Application.get_env(:sentry, :environment_name)
+    hackney_opts = Application.get_env(:sentry, :hackney_opts, [])
     Mix.shell.info "Client configuration:"
     Mix.shell.info "server: #{endpoint}"
     Mix.shell.info "public_key: #{public_key}"
     Mix.shell.info "secret_key: #{secret_key}"
     Mix.shell.info "included_environments: #{inspect included_environments}"
-    Mix.shell.info "current environment_name: #{inspect environment_name}\n"
+    Mix.shell.info "current environment_name: #{inspect environment_name}"
+    Mix.shell.info "hackney_opts: #{inspect hackney_opts}\n"
 
     maybe_send_event(environment_name, included_environments)
   end

lib/sentry/client.ex

@@ -48,8 +48,14 @@ defmodule Sentry.Client do
     end
   end
 
+  @doc """
+  Makes the HTTP request to Sentry using hackney.
+
+  Hackney options can be set via the `hackney_opts` configuration option.
+  """
   def request(method, url, headers, body) do
-    case :hackney.request(method, url, headers, body, []) do
+    hackney_opts = Application.get_env(:sentry, :hackney_opts, [])
+    case :hackney.request(method, url, headers, body, hackney_opts) do
       {:ok, 200, _headers, client} ->
         case :hackney.body(client) do
           {:ok, body} ->