Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve docs #7

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## v1.3.1

* Improved README, no new features.

## v1.3.0

* Add search.
Expand Down
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,31 @@

<!-- MDOC !-->

Real-time Monitoring for `Oban` with `Phoenix.LiveDashboard`.
Obanalyze provides real-time monitoring for `Oban` within `Phoenix.LiveDashboard`,
delivering a user-friendly interface to manage background jobs seamlessly.

## Install
## Features

- **Job Management**: Retry, cancel, or delete jobs directly from the dashboard.
- **Filtering**: Filter jobs based on worker name or job arguments to quickly find what you're looking for.
- **Database Compatibility**: Fully compatible with SQLite, PostgreSQL or any database that Oban uses.

## Installation

The package can be installed by adding `obanalyze` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:obanalyze, "~> 1.0"}
{:obanalyze, "~> 1.3"}
]
end
```

## Configure
## Configuration

Update the `live_dashboard` configuration in your router.
Configure your application to include Obanalyze in `Phoenix.LiveDashboard`.
Update your router configuration as follows:

```elixir
# lib/my_app_web/router.ex
Expand All @@ -31,14 +39,22 @@ live_dashboard "/dashboard",
]
```

## Done
## Usage

After installation and setup, navigate to your `Phoenix.LiveDashboard` at the specified
route (e.g., `/dev/dashboard`). You will see the new `Obanalyze` tab, which provides
a complete overview of your background jobs.

Go to your `Phoenix.LiveDashboard` and you should see the `Obanalyze` tab.
## List view

![Obanalyze screenshot](doc/images/obanalyze.png "Obanalyze")

## Single job view

![Obanalyze job screenshot](doc/images/obanalyze_job.png "Single Job")


# Alternatives

* [evilmarty/oban_live_dashboard](https://github.com/evilmarty/oban_live_dashboard) where I took my inspiration from.
You should check it out if you want a simple way to observe your Oban jobs.
- [evilmarty/oban_live_dashboard](https://github.com/evilmarty/oban_live_dashboard): Inspired this project; a simplistic approach to Oban job monitoring.
- [Oban Web](https://getoban.pro): Official advanced dashboard offering extensive features, directly from the creators of Oban.
Binary file added doc/images/obanalyze_job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Obanalyze.MixProject do
use Mix.Project

@version "1.3.0"
@version "1.3.1"
@source_url "https://github.com/egze/obanalyze"

def project do
Expand Down
Loading