update HTTPClient docs

Author: mitchellhenke

lib/sentry/hackney_client.ex

@@ -0,0 +1,40 @@
+defmodule Sentry.HackneyClient do
+  @behaviour Sentry.HTTPClient
+
+  @moduledoc """
+  The built-in HTTP client.
+  """
+
+  @hackney_pool_name :sentry_pool
+
+  def child_spec do
+    unless Code.ensure_loaded?(:hackney) do
+      raise """
+      cannot start Sentry.HackneyClient because :hackney is not available.
+      Please make sure to add hackney as a dependency:
+
+          {:hackney, "~> 1.8"}
+      """
+    end
+
+    Application.ensure_all_started(:hackney)
+
+    :hackney_pool.child_spec(
+      @hackney_pool_name,
+      timeout: Sentry.Config.hackney_timeout(),
+      max_connections: Sentry.Config.max_hackney_connections()
+    )
+  end
+
+  def post(url, headers, body) do
+    hackney_opts =
+      Sentry.Config.hackney_opts()
+      |> Keyword.put_new(:pool, @hackney_pool_name)
+
+    with {:ok, status, headers, client} <-
+           :hackney.request(:post, url, headers, body, hackney_opts),
+         {:ok, body} <- :hackney.body(client) do
+      {:ok, status, headers, body}
+    end
+  end
+end

lib/sentry/http_client.ex

@@ -1,6 +1,14 @@
 defmodule Sentry.HTTPClient do
   @moduledoc """
   Specifies the API for using a custom HTTP Client.
+
+  The default HTTP client is `Sentry.HackneyClient`
+
+  To configure a different HTTP client, implement the `Sentry.HTTPClient` behaviour and
+  change the `:client` configuration:
+
+      config :sentry,
+        client: MyHTTPClient
   """
 
   @type headers :: [{String.t(), String.t()}]
@@ -11,44 +19,3 @@ defmodule Sentry.HTTPClient do
               {:ok, status :: pos_integer, headers, body :: String.t()}
               | {:error, term}
 end
-
-defmodule Sentry.HackneyClient do
-  @behaviour Sentry.HTTPClient
-
-  @moduledoc """
-  The built-in HTTP client.
-  """
-
-  @hackney_pool_name :sentry_pool
-
-  def child_spec do
-    unless Code.ensure_loaded?(:hackney) do
-      raise """
-      cannot start Sentry.HackneyClient because :hackney is not available.
-      Please make sure to add hackney as a dependency:
-
-          {:hackney, "~> 1.8"}
-      """
-    end
-
-    Application.ensure_all_started(:hackney)
-
-    :hackney_pool.child_spec(
-      @hackney_pool_name,
-      timeout: Sentry.Config.hackney_timeout(),
-      max_connections: Sentry.Config.max_hackney_connections()
-    )
-  end
-
-  def post(url, headers, body) do
-    hackney_opts =
-      Sentry.Config.hackney_opts()
-      |> Keyword.put_new(:pool, @hackney_pool_name)
-
-    with {:ok, status, headers, client} <-
-           :hackney.request(:post, url, headers, body, hackney_opts),
-         {:ok, body} <- :hackney.body(client) do
-      {:ok, status, headers, body}
-    end
-  end
-end