https://github.com/j3rn/saturn_phoenix
Display Saturn-gathered query statistics in the Phoenix LiveDashboard.
https://github.com/j3rn/saturn_phoenix
Last synced: over 1 year ago
JSON representation
Display Saturn-gathered query statistics in the Phoenix LiveDashboard.
- Host: GitHub
- URL: https://github.com/j3rn/saturn_phoenix
- Owner: J3RN
- License: mit
- Created: 2025-02-10T17:22:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-10T17:46:51.000Z (over 1 year ago)
- Last Synced: 2025-02-10T18:35:05.751Z (over 1 year ago)
- Language: Elixir
- Size: 1.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SaturnPhoenix
Display [Saturn]-gathered query statistics in the [Phoenix LiveDashboard].
## Installation
First, you'll need to [install and configure Saturn]
The package can be installed by adding `saturn_phoenix` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:saturn_phoenix, git: "git@github.com:instinctscience/saturn_phoenix"}
]
end
```
Next, you'll need to configure the live dashboard to show the Saturn query page. In your `router.ex` file, you should have a section that looks like this:
```elixir
live_dashboard "/",
metrics: MyApp.Web.Telemetry,
ecto_repos: [MyApp.Repo]
```
You'll want to add `saturn: SaturnPhoenix.QueriesPage` to the list after an `additional_pages:`, like so:
```elixir
live_dashboard "/",
metrics: MyApp.Web.Telemetry,
ecto_repos: [MyApp.Repo],
additional_pages: [
saturn: SaturnPhoenix.QueriesPage
]
```
Now when you visit your Live Dashboard, you should see a new "Saturn" tab. Install complete!
[Saturn]: https://github.com/instinctscience/saturn
[Phoenix LiveDashboard]: https://hexdocs.pm/phoenix_live_dashboard/Phoenix.LiveDashboard.html
[install and configure Saturn]: https://github.com/instinctscience/saturn#installation