Fix Ecto parallel preloads #915
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ All good! |
|
I was wondering if there would be an easy way for (This is not a blocker, just a thought) |
Add the `Appsignal.Ecto.Repo` module to fix the Ecto parallel preload issue, making it easy to apply the workaround that was already found by [Elixir Forums][solution] users. After this change, customers can replace `use Ecto.Repo` in their Ecto repositories with `use Appsignal.Ecto.Repo`. This will configure Ecto so that it passes through the current span at invocation time as the telemetry options for the query, fixing the issue where parallel preload queries were lost because they took place in parallel processes where there was no current span. For customers who wish to customise their Ecto repo default options, which would override the `default_options/1` function implemented by `Appsignal.Ecto.Repo`, a workaround is provided by also exposing this function as `Appsignal.Ecto.Repo.default_options`, so customers can call it manually and merge its output with their own default options. [solution]: https://elixirforum.com/t/help-understanding-ecto-telemetry-events-according-to-appsignal/35957/3
cdb305d to
ae09d17
Compare
luismiramirez
approved these changes
Jan 23, 2024
jeffkreeftmeijer
approved these changes
Jan 23, 2024
tombruijn
approved these changes
Jan 24, 2024
.changesets/add-appsignal-ecto-repo-to-fix-parallel-preloads.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Tom de Bruijn <tom@tomdebruijn.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #603. See also https://github.com/appsignal/appsignal-docs/pull/1715. Use appsignal/test-setups#184 to test it.
Add the
Appsignal.Ecto.Repomodule to fix the Ecto parallel preload issue, making it easy to apply the workaround that was already found by Elixir Forums users.After this change, customers can replace
use Ecto.Repoin their Ecto repositories withuse Appsignal.Ecto.Repo. This will configure Ecto so that it passes through the current span at invocation time as the telemetry options for the query, fixing the issue where parallel preload queries were lost because they took place in parallel processes where there was no current span.For customers who wish to customise their Ecto repo default options, which would override the
default_options/1function implemented byAppsignal.Ecto.Repo, a workaround is provided by also exposing this function asAppsignal.Ecto.Repo.default_options, so customers can call it manually and merge its output with their own default options.