jobs

Documentation

Index

• Constants
• type FileLogger
  • func NewFileLogger(jobId uint, logFilePath string) (*FileLogger, error)
  • func (l *FileLogger) Close() error
  • func (l *FileLogger) Log(format string, a ...interface{})
  • func (l *FileLogger) Reset(format string, a ...interface{})
• type JobCancelRequest
• type JobCleanRequest
• type JobExecutor
  • func NewJobExecutor(dataDir string, client *httpclient.HttpClient) *JobExecutor
  • func (job *JobExecutor) Cancel(c *gin.Context)
  • func (job *JobExecutor) Cleanup(c *gin.Context)
  • func (job *JobExecutor) Execute(c *gin.Context)
  • func (job *JobExecutor) Status(c *gin.Context)
• type JobResult
• type JobRunRequest
• type JobStatus
  • func NewJobStatus(filePath string) *JobStatus
  • func (s *JobStatus) Get() (*JobResult, error)
  • func (s *JobStatus) Set(sr *JobResult) error
• type JobStatusLog
• type JobStatusRequest
• type PipeFlowJobRun
  • func NewPipeFlowJobRun(dataDir string, client *httpclient.HttpClient) *PipeFlowJobRun
  • func (p *PipeFlowJobRun) Cancel(jobId uint) error
  • func (p *PipeFlowJobRun) Cleanup(jobId uint) error
  • func (p *PipeFlowJobRun) Execute(jobId uint, pluginKey string, params map[string]interface{}) (resp *utils.Response)
  • func (p *PipeFlowJobRun) GetJobLogFile(jobId uint) (string, error)
  • func (p *PipeFlowJobRun) GetJobStatusFile(jobId uint) (string, error)
  • func (p *PipeFlowJobRun) GetRootDir(jobId uint) (jobPath string, err error)
  • func (p *PipeFlowJobRun) GetStatusLog(jobId uint, showLog bool) (*JobStatusLog, error)

Constants

const PipeFlowCallbackUrl = "/api/v1/pipeflow/callback"

Types

type FileLogger

type FileLogger struct {
	*os.File
	// contains filtered or unexported fields
}

FileLogger 任务执行时日志写入文件

func NewFileLogger

func NewFileLogger(jobId uint, logFilePath string) (*FileLogger, error)

func (*FileLogger) Close

func (l *FileLogger) Close() error

func (*FileLogger) Log

func (l *FileLogger) Log(format string, a ...interface{})

Log 日志存储到文件

func (*FileLogger) Reset

func (l *FileLogger) Reset(format string, a ...interface{})

Reset 从头日志重写

type JobCancelRequest

type JobCancelRequest struct {
	JobId uint `json:"jobId" form:"jobId" url:"jobId"`
}

type JobCleanRequest

type JobCleanRequest struct {
	JobId uint `json:"jobId" form:"jobId" url:"jobId"`
}

type JobExecutor

type JobExecutor struct {
	// contains filtered or unexported fields
}

JobExecutor defines the jobs executor which handles the pipeline jobs.

func NewJobExecutor

func NewJobExecutor(dataDir string, client *httpclient.HttpClient) *JobExecutor

func (*JobExecutor) Cancel

func (job *JobExecutor) Cancel(c *gin.Context)

func (*JobExecutor) Cleanup

func (job *JobExecutor) Cleanup(c *gin.Context)

func (*JobExecutor) Execute

func (job *JobExecutor) Execute(c *gin.Context)

func (*JobExecutor) Status

func (job *JobExecutor) Status(c *gin.Context)

Status Get jobs status interface parameters

type JobResult

type JobResult struct {
	Status string          `json:"status"`
	Result *utils.Response `json:"result"`
}

JobResult 任务状态以及执行结果存储查询

type JobRunRequest

type JobRunRequest struct {
	JobId  uint                   `json:"jobId" form:"jobId"`
	Plugin string                 `json:"plugin" form:"plugin"`
	Params map[string]interface{} `json:"params" form:"params"`
}

type JobStatus

type JobStatus struct {
	// contains filtered or unexported fields
}

func NewJobStatus

func NewJobStatus(filePath string) *JobStatus

func (*JobStatus) Get

func (s *JobStatus) Get() (*JobResult, error)

Get reads the result from the status file

func (*JobStatus) Set

func (s *JobStatus) Set(sr *JobResult) error

Set updates the status file with the given JobResult

type JobStatusLog

type JobStatusLog struct {
	Result *JobResult `json:"result"`
	Log    string     `json:"log"`
}

type JobStatusRequest

type JobStatusRequest struct {
	JobId   uint `json:"jobId" form:"jobId" url:"jobId"`
	ShowLog bool `json:"showLog" form:"showLog" url:"showLog"`
}

type PipeFlowJobRun

type PipeFlowJobRun struct {
	// contains filtered or unexported fields
}

func NewPipeFlowJobRun

func NewPipeFlowJobRun(dataDir string, client *httpclient.HttpClient) *PipeFlowJobRun

func (*PipeFlowJobRun) Cancel

func (p *PipeFlowJobRun) Cancel(jobId uint) error

func (*PipeFlowJobRun) Cleanup

func (p *PipeFlowJobRun) Cleanup(jobId uint) error

func (*PipeFlowJobRun) Execute

func (p *PipeFlowJobRun) Execute(jobId uint, pluginKey string, params map[string]interface{}) (resp *utils.Response)

Execute 执行任务插件，任务开启一个协程后台执行，该方法立即返回，后续的任务执行状态通过回调接口上报

func (*PipeFlowJobRun) GetJobLogFile

func (p *PipeFlowJobRun) GetJobLogFile(jobId uint) (string, error)

GetJobLogFile Get the log file of task execution

func (*PipeFlowJobRun) GetJobStatusFile

func (p *PipeFlowJobRun) GetJobStatusFile(jobId uint) (string, error)

GetJobStatusFile Get task execution results and status files

func (*PipeFlowJobRun) GetRootDir

func (p *PipeFlowJobRun) GetRootDir(jobId uint) (jobPath string, err error)

GetRootDir gets the root directory of the jobs. If it does not exist, it creates it.

func (*PipeFlowJobRun) GetStatusLog

func (p *PipeFlowJobRun) GetStatusLog(jobId uint, showLog bool) (*JobStatusLog, error)

GetStatusLog returns the status of a jobs. If showLog is true, it also returns the contents of the jobs log.