Skip to content

feat: Supervisor supports automatic restart configuration. #8413

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.

Sign up for GitHub

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

Merged
f2c-ci-robot merged 1 commit into from
Apr 17, 2025
Merged

feat: Supervisor supports automatic restart configuration. #8413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions agent/app/dto/request/host_tool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ type HostToolConfig struct {
}

type SupervisorProcessConfig struct {
Name string `json:"name"`
Operate string `json:"operate"`
Command string `json:"command"`
User string `json:"user"`
Dir string `json:"dir"`
Numprocs string `json:"numprocs"`
Name string `json:"name"`
Operate string `json:"operate"`
Command string `json:"command"`
User string `json:"user"`
Dir string `json:"dir"`
Numprocs string `json:"numprocs"`
AutoRestart string `json:"autoRestart"`
}

type SupervisorProcessFileReq struct {
Copy link
Copy Markdown
Member

@wanghe-fit2cloud wanghe-fit2cloud Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided JSON structure seems to be part of a configuration file used by Supervisord, an process control system for Unix-like operating systems. The main concern is that the SupervisorProcessConfig contains two fields with different names but similar functionality:

  • Numprocs
  • AutoRestart

It's not clear why these would have separate names ("numprocs" vs "autoRestart") when they seem to represent the same concept: specifying a number of processes to start and whether to automatically restart them in case of failure.

Here are some suggestions for improvement:

  1. Consistency: If Numprocs and AutoRestart should actually differ (e.g., if one controls automatic restarting while the other specifies the number of instances) then rename them appropriately based on their actual functions or usage within the Supervisor context.

  2. Documentation: Ensure that this difference between Numprocs and AutoRestart is clearly documented so it’s understood what each field does.

  3. Default Values: Consider setting default values for both fields to make configuration more flexible depending on specific use cases.

  4. Field Uniqueness: Verify that no other code relies on these field names specifically to avoid potential bugs or unintended behaviors due to naming inconsistencies.

If you want to align the fields and provide clarity about how they relate to auto-restarting behavior, here's a revised version:

type SupervisorProcessConfig struct {
    Name        string   `json:"name"`
    Operate     string   `json:"operate"`
    Command     string   `json:"command"`
    User        string   `json:"user"`
    Dir         string   `json:"dir"`
    NumInstances int       `json:"num_instances"` // Renamed as "num_instances"
    AutoRestart bool     `json:"auto Restart"` // Capitalized as per typical Go naming conventions
}

This revision maintains consistency while providing additional information through better naming and documentation practices.

Expand Down
15 changes: 8 additions & 7 deletions agent/app/dto/response/host_tool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ type HostToolConfig struct {
}

type SupervisorProcessConfig struct {
Name string `json:"name"`
Command string `json:"command"`
User string `json:"user"`
Dir string `json:"dir"`
Numprocs string `json:"numprocs"`
Msg string `json:"msg"`
Status []ProcessStatus `json:"status"`
Name string `json:"name"`
Command string `json:"command"`
User string `json:"user"`
Dir string `json:"dir"`
Numprocs string `json:"numprocs"`
Msg string `json:"msg"`
Status []ProcessStatus `json:"status"`
AutoRestart string `json:"autoRestart"`
}

type ProcessStatus struct {
Copy link
Copy Markdown
Member

@wanghe-fit2cloud wanghe-fit2cloud Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided code snippet is for SupervisorProcessConfig, which contains an additional field AutoRestart compared to the original struct definition in HostToolConfig. This seems like a mistake or intended change. The rest of the fields have not been altered.

Irregularity: The new field AutoRestart does not exist in the old struct HostToolConfig.

Potential issues: Without further context on whether this new field is necessary or how it fits into the existing system, there might be confusion about its purpose and potential integration bugs with other parts of the application.

Optimization Suggestions:

  1. Review Dependencies: If including AutoRestart affects dependencies between components that interact with these structs, ensure they handle the new field appropriately.

  2. Documentation Update: Clearly document the usage of AutoRestart, especially if it has functionality different from Numprocs as described in the comment above ("If Numprocs == 'auto', then each proc will restart automatically after failure.").

  3. Code Quality Checkers: Run static analysis tools to identify such discrepancies early in development, which can help prevent inconsistencies at runtime.

  4. Consistency Check: Compare all similar structures across the project to ensure consistency and avoid introducing errors in data integrity due to missing mandatory fields.

Overall, while having no immediate technical issue per se, updating documentation and ensuring consistent behavior could improve maintainability and clarity of the codebase.

Expand Down
7 changes: 6 additions & 1 deletion agent/app/service/host_tool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ func handleProcess(supervisordDir string, req request.SupervisorProcessConfig, c
}
_, _ = section.NewKey("command", strings.TrimSpace(req.Command))
_, _ = section.NewKey("directory", req.Dir)
_, _ = section.NewKey("autorestart", "true")
_, _ = section.NewKey("autorestart", req.AutoRestart)
_, _ = section.NewKey("startsecs", "3")
_, _ = section.NewKey("stdout_logfile", outLog)
_, _ = section.NewKey("stderr_logfile", errLog)
Expand Down Expand Up @@ -358,6 +358,8 @@ func handleProcess(supervisordDir string, req request.SupervisorProcessConfig, c
userKey.SetValue(req.User)
numprocsKey := section.Key("numprocs")
numprocsKey.SetValue(req.Numprocs)
autoRestart := section.Key("autorestart")
autoRestart.SetValue(req.AutoRestart)

if err = configFile.SaveTo(iniPath); err != nil {
return err
Expand Down Expand Up @@ -424,6 +426,9 @@ func handleProcessConfig(configDir, containerName string) ([]response.Supervisor
if numprocs, _ := section.GetKey("numprocs"); numprocs != nil {
config.Numprocs = numprocs.Value()
}
if autoRestart, _ := section.GetKey("autorestart"); autoRestart != nil {
config.AutoRestart = autoRestart.Value()
}
_ = getProcessStatus(&config, containerName)
result = append(result, config)
}
Copy link
Copy Markdown
Member

@wanghe-fit2cloud wanghe-fit2cloud Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided code has no significant inaccuracies or issues. The autoRestart value is correctly retrieved from req.AutoRestart. No major optimizations can be suggested based on this patch; it appears to function as intended for setting up supervisor configurations in a given directory. If you need further modifications or have additional requirements, please provide more context or specify the changes needed.

Expand Down
1 change: 1 addition & 0 deletions agent/i18n/lang/zh.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ ErrDBNotExist: "数据库不存在"
allow: "允许"
deny: "禁止"
OpenrestyNotFound: "Openresty 未安装"
remoteIpIsNull: "IP 列表为空"

#task
TaskStart: "{{ .name }} 任务开始 [START]"
Expand Down
1 change: 1 addition & 0 deletions frontend/src/api/interface/host-tool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export namespace HostTool {
dir: string;
numprocs: string;
status?: ProcessStatus[];
autoRestart: string;
}

export interface ProcessStatus {
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/en.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2753,6 +2753,7 @@ const message = {
ERROR: 'Error',
statusCode: 'Status code',
manage: 'Management',
autoRestart: 'Auto Restart',
},
},
xpack: {
Expand Down Expand Up @@ -3013,6 +3014,7 @@ const message = {
strict: 'Strict Mode',
strictHelper: 'Use stricter rules to validate requests',
saveLog: 'Save Log',
remoteURLHelper: 'The remote URL needs to ensure one IP per line and no other characters',
},
monitor: {
name: 'Website Monitoring',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/ja.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2619,6 +2619,7 @@ const message = {
ERROR: 'エラー',
statusCode: 'ステータスコード',
manage: '管理',
autoRestart: '自動再起動',
},
},
xpack: {
Expand Down Expand Up @@ -2873,6 +2874,7 @@ const message = {
strict: '厳格モード',
strictHelper: 'より厳格なルールを使用してリクエストを検証します',
saveLog: 'ログを保存',
remoteURLHelper: 'リモート URL は、1行に1つのIPで、他の文字がないことを保証する必要があります',
},
monitor: {
name: 'ウェブサイトモニタリング',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/ko.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2578,6 +2578,7 @@ const message = {
ERROR: '오류',
statusCode: '상태 코드',
manage: '관리',
autoRestart: '자동 재시작',
},
},
xpack: {
Expand Down Expand Up @@ -2828,6 +2829,7 @@ const message = {
strict: '엄격 모드',
strictHelper: '더 엄격한 규칙을 사용하여 요청을 검증합니다',
saveLog: '로그 저장',
remoteURLHelper: '원격 URL은 한 줄에 하나의 IP만 포함하고 다른 문자는 포함하지 않아야 합니다',
},
monitor: {
name: '웹사이트 모니터링',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/ms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2680,6 +2680,7 @@ const message = {
ERROR: 'Ralat',
statusCode: 'Kod status',
manage: 'Pengurusan',
autoRestart: 'Auto Restart',
},
},
xpack: {
Expand Down Expand Up @@ -2938,6 +2939,7 @@ const message = {
strict: 'Mod Strict',
strictHelper: 'Gunakan peraturan yang lebih ketat untuk mengesahkan permintaan',
saveLog: 'Simpan Log',
remoteURLHelper: 'URL jauh perlu memastikan satu IP setiap baris dan tiada aksara lain',
},
monitor: {
name: 'Pemantauan Laman Web',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/pt-br.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2677,6 +2677,7 @@ const message = {
ERROR: 'Erro',
statusCode: 'Código de status',
manage: 'Gerenciamento',
autoRestart: 'Reinicialização Automática',
},
},
xpack: {
Expand Down Expand Up @@ -2938,6 +2939,7 @@ const message = {
strict: 'Modo estrito',
strictHelper: 'Usa regras mais rigorosas para validar solicitações',
saveLog: 'Salvar log',
remoteURLHelper: 'O URL remoto precisa garantir um IP por linha e nenhum outro caractere',
},
monitor: {
name: 'Monitoramento de Websites',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/ru.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2673,6 +2673,7 @@ const message = {
ERROR: 'Ошибка',
statusCode: 'Код статуса',
manage: 'Управление',
autoRestart: 'Автоматический перезапуск',
},
},
xpack: {
Expand Down Expand Up @@ -2932,6 +2933,7 @@ const message = {
strict: 'Строгий режим',
strictHelper: 'Использует более строгие правила для проверки запросов',
saveLog: 'Сохранить лог',
remoteURLHelper: 'Удаленный URL должен содержать один IP на строку и не содержать других символов',
},
monitor: {
name: 'Мониторинг веб-сайта',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/zh-Hant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2550,6 +2550,7 @@ const message = {
ERROR: '錯誤',
statusCode: '狀態碼',
manage: '管理',
autoRestart: '自動重啟',
},
},
xpack: {
Expand Down Expand Up @@ -2793,6 +2794,7 @@ const message = {
strict: '嚴格模式',
strictHelper: '使用更嚴格的規則來校驗請求',
saveLog: '保存日誌',
remoteURLHelper: '遠程 URL 需要保證每行一個 IP 並且沒有其他字符',
},
monitor: {
name: '網站監控',
Expand Down
2 changes: 2 additions & 0 deletions frontend/src/lang/modules/zh.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2542,6 +2542,7 @@ const message = {
ERROR: '错误',
statusCode: '状态码',
manage: '管理',
autoRestart: '自动重启',
},
},
xpack: {
Expand Down Expand Up @@ -2782,6 +2783,7 @@ const message = {
strict: '严格模式',
strictHelper: '使用更严格的规则来校验请求',
saveLog: '保存日志',
remoteURLHelper: '远程 URL 需要保证每行一个 IP 并且没有其他字符',
},
monitor: {
name: '网站监控',
Expand Down
5 changes: 5 additions & 0 deletions frontend/src/views/toolbox/supervisor/create/index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
<el-form-item :label="$t('tool.supervisor.numprocs')" prop="numprocsNum">
<el-input type="number" v-model.number="process.numprocsNum"></el-input>
</el-form-item>
<el-form-item :label="$t('tool.supervisor.autoRestart')" prop="autoRestart">
<el-switch v-model="process.autoRestart" active-value="true" inactive-value="false"></el-switch>
</el-form-item>
</el-form>
<template #footer>
<span class="dialog-footer">
Expand Down Expand Up @@ -70,6 +73,7 @@ const initData = () => ({
dir: '',
numprocsNum: 1,
numprocs: '1',
autoRestart: 'true',
});
const process = ref(initData());

Expand Down Expand Up @@ -100,6 +104,7 @@ const acceptParams = (operate: string, config: HostTool.SupersivorProcess) => {
dir: config.dir,
numprocsNum: 1,
numprocs: config.numprocs,
autoRestart: config.autoRestart,
};
process.value.numprocsNum = Number(config.numprocs);
}
Expand Down
Loading