Light Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feature: Action button with custom URL #1465

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

Open
Vorticity-Flux wants to merge 1 commit into Supervisor:main
base: main
Choose a base branch
Loading
from Vorticity-Flux:master
Open

feature: Action button with custom URL #1465

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
30 changes: 30 additions & 0 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1138,6 +1138,36 @@ where specified.

*Introduced*: 3.0

``custom_action_name``

Custom action name to be displayed along the usual Start/Stop/Tail log
actions in the Web UI. When this custom action button is clicked a new
browser window will open with URL provided by custom_action_href parameter.
This is useful for example to open an application dashboard or control panel.
Both custom_action_name and custom_action_href parameters have to be
defined for custom button to be displayed.

*Default*: None

*Required*: No.

*Introduced*: 4.3.0

``custom_action_href``

Custom action link to be displayed along the usual Start/Stop/Tail log
actions in the Web UI. Title for the custom action link is defined by the
custom_action_name parameter. When this custom action button is clicked a new
browser window will open with URL provided by custom_action_href parameter.
Both custom_action_name and custom_action_href parameters have to be
defined for custom button to be displayed.

*Default*: None

*Required*: No.

*Introduced*: 4.3.0

``[program:x]`` Section Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
14 changes: 12 additions & 2 deletions supervisor/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,6 +1026,13 @@ def get(section, opt, *args, **kwargs):
raise ValueError(
'program section %s does not specify a command' % section)

custom_action_name = get(section, 'custom_action_name', None, expansions=expansions)
custom_action_href = get(section, 'custom_action_href', None, expansions=expansions)
if custom_action_name is None:
custom_action_href = None
if custom_action_href is None:
custom_action_name = None

pconfig = klass(
self,
name=expand(process_name, expansions, 'process_name'),
Expand Down Expand Up @@ -1057,7 +1064,9 @@ def get(section, opt, *args, **kwargs):
exitcodes=exitcodes,
redirect_stderr=redirect_stderr,
environment=environment,
serverurl=serverurl)
serverurl=serverurl,
custom_action_name=custom_action_name,
custom_action_href=custom_action_href)

programs.append(pconfig)

Expand Down Expand Up @@ -1874,7 +1883,8 @@ class ProcessConfig(Config):
'stderr_logfile_backups', 'stderr_logfile_maxbytes',
'stderr_events_enabled', 'stderr_syslog',
'stopsignal', 'stopwaitsecs', 'stopasgroup', 'killasgroup',
'exitcodes', 'redirect_stderr' ]
'exitcodes', 'redirect_stderr',
'custom_action_name', 'custom_action_href' ]
optional_param_names = [ 'environment', 'serverurl' ]

def __init__(self, options, **params):
Expand Down
2 changes: 2 additions & 0 deletions supervisor/skel/sample.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
;stderr_syslog=false ; send stderr to syslog with process name (default false)
;environment=A="1",B="2" ; process environment additions (def no adds)
;serverurl=AUTO ; override serverurl computation (childutils)
;custom_action_name=Link Title ; Title for custom action in the web UI
;custom_action_href=http://url ; URL for custom action button in the web UI

; The sample eventlistener section below shows all possible eventlistener
; subsection values. Create one or more 'real' eventlistener: sections to be
Expand Down
16 changes: 13 additions & 3 deletions supervisor/web.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,13 +269,23 @@ def actions_for_process(self, process):
'href': 'logtail/%s/stderr' % processname,
'target': '_blank'
}
if (process.config.custom_action_name is not None
and process.config.custom_action_href is not None):
custom_action = {
'name': process.config.custom_action_name,
'href': process.config.custom_action_href,
'target': '_blank'
}
else:
custom_action = None
if state == ProcessStates.RUNNING:
actions = [restart, stop, clearlog, tailf_stdout, tailf_stderr]
actions = [restart, stop, clearlog, tailf_stdout, tailf_stderr,
custom_action]
elif state in (ProcessStates.STOPPED, ProcessStates.EXITED,
ProcessStates.FATAL):
actions = [start, None, clearlog, tailf_stdout, tailf_stderr]
actions = [start, None, clearlog, tailf_stdout, tailf_stderr, None]
else:
actions = [None, None, clearlog, tailf_stdout, tailf_stderr]
actions = [None, None, clearlog, tailf_stdout, tailf_stderr, None]
return actions

def css_class_for_state(self, state):
Expand Down