Switch HTTP Client from Hackney to Finch #897

savhappy · 2025-05-27T06:40:57Z

Switch default HTTP client from Hackney to Finch

Changes

Changes the default HTTP client from Sentry.HackneyClient to Sentry.FinchClient
Adds new Finch-specific configuration options:
- finch_pool_opts: For pool configuration (defaults to [size: 50, conn_max_idle_time: 5000])
- finch_request_opts: For request configuration (defaults to [receive_timeout: 5000])
Deprecates Hackney-specific options
Updates tests to use Finch configuration
Updates documentation to reflect Finch as the default client

Migration

Users who want to continue using Hackney can:

Explicitly configure Sentry to use Hackney:

config :sentry,
  client: Sentry.HackneyClient

Dependencies

Adds Finch as an optional dependency
Keeps Hackney as an optional dependency for backward compatibility

Testing

Updated all tests to use Finch configuration
Added tests for Finch-specific error handling
Verified backward compatibility with Hackney

Documentation

Updated README to show Finch as the default client
Added migration guidance for users of Hackney
Updated configuration documentation to reflect new options
closes Switch from Hackney to Finch as the default HTTP client #724

github-actions · 2025-05-27T06:41:19Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Switch HTTP Client from Hackney to Finch ([#897](https://github.com/getsentry/sentry-elixir/pull/897))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against 8af8dce

whatyouhide

Lovely work. Left a few first-pass comments, but they're mostly nits to clean this up for a nice release. Let me know if you have questions and otherwise let me know when this is ready for another review pass 🙃

whatyouhide · 2025-05-28T06:36:02Z

README.md


 ```elixir
 defp deps do
  [
    # ...

    {:sentry, "~> 10.8"},
-    {:hackney, "~> 1.20"}
+    {:jason, "~> 1.4"},
+    {:finch, "~> 0.19"}


Nit, but let's suggest a version requirement that wouldn't technically allow breaking versions (since this is before 1.0):

Suggested change

{:finch, "~> 0.19"}

{:finch, "~> 0.19.0"}

whatyouhide · 2025-05-28T06:37:28Z

lib/mix/tasks/sentry.send_test_event.ex

@@ -67,7 +67,7 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
    end

    Mix.shell().info("current environment_name: #{inspect(to_string(Config.environment_name()))}")
-    Mix.shell().info("hackney_opts: #{inspect(Config.hackney_opts())}\n")
+    Mix.shell().info("finch_pool_opts: #{inspect(Config.finch_pool_opts())}\n")


Since we're touching this... a nit! 😉

Suggested change

Mix.shell().info("finch_pool_opts: #{inspect(Config.finch_pool_opts())}\n")

Mix.shell().info("Finch pool options: #{inspect(Config.finch_pool_opts(), pretty: true)}\n")

lib/sentry/config.ex

whatyouhide · 2025-05-28T06:38:38Z

lib/sentry/config.ex

+        applied if `:client` is set to `Sentry.HackneyClient`.
+        """
+      ] ++
+        if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."]),


Nit:

Suggested change

if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."]),

if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch as the default HTTP client instead."]),

whatyouhide · 2025-05-28T06:39:41Z

lib/sentry/config.ex

      type: :keyword_list,
-      default: [pool: :sentry_pool],
+      default: [size: 50, conn_max_idle_time: 5000],


Why the 5000 idle time? I think Finch's default of :infinity is a good choice here?

whatyouhide · 2025-05-28T06:40:47Z

lib/sentry/finch_client.ex

+  @behaviour Sentry.HTTPClient
+
+  @moduledoc """
+  The built-in HTTP client.


Shows up correctly in the module doc summary with ExDoc:

Suggested change

The built-in HTTP client.

The built-in HTTP client.

whatyouhide · 2025-05-28T06:41:02Z

lib/sentry/finch_client.ex

+  see "Pool Configuration Options" in the Finch documentation for details on the possible map values.
+  [finch configuration options](https://hexdocs.pm/finch/Finch.html#start_link/1-pool-configuration-options)
+  """
+  @impl true


Nit:

Suggested change

@impl true

@impl true

whatyouhide · 2025-05-28T06:41:16Z

lib/sentry/finch_client.ex

+  Finch is built on top of [NimblePool](https://github.com/dashbitco/nimble_pool). If you need to set other pool configuration options,
+  see "Pool Configuration Options" in the Finch documentation for details on the possible map values.
+  [finch configuration options](https://hexdocs.pm/finch/Finch.html#start_link/1-pool-configuration-options)
+  """


Nit:

Suggested change

"""

"""

@moduledoc since: "10.11.0"

whatyouhide · 2025-05-28T06:42:12Z

lib/sentry/http_client.ex

@@ -2,7 +2,7 @@ defmodule Sentry.HTTPClient do
  @moduledoc """
  A behaviour for HTTP clients that Sentry can use.

-  The default HTTP client is `Sentry.HackneyClient`.
+  The default HTTP client is `Sentry.FinchClient`.


Suggested change

The default HTTP client is `Sentry.FinchClient`.

The default HTTP client is `Sentry.FinchClient` since v10.11.0

(it was based on Hackney before that).

whatyouhide · 2025-05-28T06:43:05Z

mix.exs

@@ -97,6 +97,7 @@ defmodule Sentry.Mixfile do

      # Optional dependencies
      {:hackney, "~> 1.8", optional: true},
+      {:finch, "~> 0.19", optional: true},


I think we can even go a couple of versions below this to allow more people to use this in case they're stuck on an older Finch version. Something like ~> 0.17. You can look at Finch's changelog and figure out a good balance there 🙃

savhappy · 2025-05-29T17:42:40Z

@whatyouhide made all the feedback changes! One thing I forgot to mention is the http_client module is still using Finch as an example to add your own.. Should this be updated to hackney or req? Or good as is?

whatyouhide · 2025-05-30T06:21:49Z

@savhappy updated to use Req (in another PR) would be great I think 🙃. We also have:

Failing CI
Can you run mix deps.unlock --unused just to make sure

savhappy added 8 commits May 26, 2025 22:42

update read me

86166b1

add finch client module and deps

1f643c0

add finch to mix file

1bc8f85

add finch to config.ex

9ccf6e0

fix sentry and client tests

39cfadf

format

99777f3

define finch opts and update logger/send_test_event tests

e87b946

update remaining tests, increase default timeout

3b7e8dd

savhappy requested a review from whatyouhide May 27, 2025 06:43

savhappy mentioned this pull request May 27, 2025

Switch HTTP client from hackney to finch #758

Closed

whatyouhide reviewed May 28, 2025

View reviewed changes

first round of feedback

8af8dce

whatyouhide approved these changes May 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Switch HTTP Client from Hackney to Finch #897

Switch HTTP Client from Hackney to Finch #897

Uh oh!

savhappy commented May 27, 2025

Uh oh!

github-actions bot commented May 27, 2025 •

edited

Loading

Uh oh!

whatyouhide left a comment

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

whatyouhide May 28, 2025

Uh oh!

savhappy commented May 29, 2025

Uh oh!

whatyouhide commented May 30, 2025

Uh oh!

Uh oh!

	Mix.shell().info("finch_pool_opts: #{inspect(Config.finch_pool_opts())}\n")
	Mix.shell().info("Finch pool options: #{inspect(Config.finch_pool_opts(), pretty: true)}\n")

	if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."]),
	if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch as the default HTTP client instead."]),

	The default HTTP client is `Sentry.FinchClient`.
	The default HTTP client is `Sentry.FinchClient` since v10.11.0
	(it was based on Hackney before that).

Uh oh!

Switch HTTP Client from Hackney to Finch #897

Are you sure you want to change the base?

Switch HTTP Client from Hackney to Finch #897

Uh oh!

Conversation

savhappy commented May 27, 2025

Switch default HTTP client from Hackney to Finch

Changes

Migration

Dependencies

Testing

Documentation

Uh oh!

github-actions bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions and example for changelog

Uh oh!

whatyouhide left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

savhappy commented May 29, 2025

Uh oh!

whatyouhide commented May 30, 2025

Uh oh!

Uh oh!

github-actions bot commented May 27, 2025 •

edited

Loading