panoptic 0.4.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +21 -0
- data/README.md +47 -11
- data/app/assets/builds/panoptic/application.css +11980 -0
- data/app/assets/builds/panoptic/application.js +4509 -0
- data/app/assets/config/panoptic_manifest.js +5 -0
- data/app/assets/javascripts/panoptic/application.js +1 -0
- data/app/assets/stylesheets/panoptic/application.scss +1 -0
- data/app/controllers/panoptic/jobs/failed_controller.rb +11 -0
- data/app/controllers/panoptic/jobs/scheduled_controller.rb +1 -1
- data/app/controllers/panoptic/jobs_controller.rb +1 -1
- data/app/models/panoptic/failed_job.rb +1 -1
- data/app/views/layouts/panoptic/application.html.erb +4 -5
- data/app/views/panoptic/jobs/failed/_job.html.erb +5 -0
- data/config/importmap.rb +2 -0
- data/config/routes.rb +2 -2
- data/lib/panoptic/engine.rb +5 -0
- data/lib/panoptic/version.rb +1 -1
- metadata +25 -4
- /data/app/views/{shared → panoptic/shared}/_flashes.html.erb +0 -0
- /data/app/views/{shared → panoptic/shared}/_navbar.html.erb +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 49dfaaa8c06b25c30051e92dca94f03d8ec4258b3953ba1c8c3c78c47f8171bd
|
|
4
|
+
data.tar.gz: 6d65ac6eefff785fe278383c276aebcba264f9d1d38edd14c188b1814c48b8d5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bfd46fd4cb10dddd447659c13e858cad287b41a7e6bf3380727596d62a96e620f7792925ad65a36cda00c50a28b072d64793545da78ab30b14351a04e8f42f61
|
|
7
|
+
data.tar.gz: 061f923cb56ddfb6126816aa4a8966311fc39e25bf54304c341ef53b03545073eece49de0e008c20df3caeb64d108a3ed3e34e3fd281ec74a199af6a2f67f1bd
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Vincent Rolea
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Panoptic is a web interface for the [SolidQueue](https://github.com/basecamp/sol
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
While MissionControl is getting ready for release, this gem offers a visual interface for testing purposes with SolidQueue.
|
|
9
|
+
While MissionControl is getting ready for release, this gem offers a visual interface for testing purposes with SolidQueue.
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
Add this line to your application's Gemfile:
|
|
@@ -15,23 +15,59 @@ Add this line to your application's Gemfile:
|
|
|
15
15
|
gem "panoptic"
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Then mount the engine in your `config/routes.rb` file
|
|
18
|
+
Then mount the engine in your `config/routes.rb` file
|
|
19
19
|
|
|
20
20
|
```ruby
|
|
21
21
|
mount Panoptic::Engine => "/panoptic"
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Development
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
- Processes
|
|
28
|
-
- Queues
|
|
29
|
-
- A first version of the jobs view
|
|
26
|
+
Panoptic requires Node installed to function properly in development. After cloning the repo, run:
|
|
30
27
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
28
|
+
```bash
|
|
29
|
+
$ bundle install
|
|
30
|
+
$ yarn
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
This will install the required Ruby and Javascript dependencies to run the project in development.
|
|
34
|
+
|
|
35
|
+
The Panoptic UI is accessible after running:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
$ bin/dev
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
This will:
|
|
42
|
+
- Start the dummy app server
|
|
43
|
+
- Enable asset compilation in development
|
|
44
|
+
- Run SolidQueue
|
|
45
|
+
|
|
46
|
+
After starting the processes, access the UI at:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
http://localhost:3000/panoptic
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Assets
|
|
53
|
+
|
|
54
|
+
#### CSS
|
|
55
|
+
Panoptic uses Bootstrap 5 for its styles. For ease of integration, Bootstrap's Sass is compiled and checked out in version control locally. This removes the dependency on NodeJS for host applications.
|
|
56
|
+
|
|
57
|
+
New CSS must be added to the `app/assets/stylesheets/panopitc` directory. If your run the UI through the `bin/dev` command above, changes to the files in `assets` will be automatically picked up and compiled in the main stylesheet located at `app/assets/builds/panoptic/application.css`. Otherwise, the `yarn build:css` command needs to be run to reflect changes in CSS.
|
|
58
|
+
|
|
59
|
+
#### Javascript
|
|
60
|
+
Panoptic uses esbuild to compile its Javascript code. Javascript code is located in the `app/assets/javascripts/panoptic` folder.
|
|
61
|
+
|
|
62
|
+
## Usage
|
|
63
|
+
|
|
64
|
+
Once the gem is installed and the Engine mounted, visit your engine route to access Panoptic. Three main views are available:
|
|
65
|
+
- Processes: display of the running worker and dispatcher process
|
|
66
|
+
- Queues
|
|
67
|
+
- Jobs: a list of SolidQueue jobs, with filters for scheduled and failed jobs
|
|
68
|
+
|
|
69
|
+
Current feature set:
|
|
70
|
+
- Retry jobs from the failed jobs panel
|
|
35
71
|
|
|
36
72
|
## License
|
|
37
73
|
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|