kapp

Documentation

Index

• Variables
• func GetApp() *application
• type Configuration
• type DB
  • func (this *DB) SavePrograms(Name, CurrentDir, Command, CallBack string, AutoStart bool, ...) error
• type LogsForm
• type LogsModel
• type ProgramsForm
• type ProgramsModel
• type Returns
  • func NewDataReturns(data interface{}) *Returns
  • func NewErrReturns(code, message string) *Returns
  • func NewListReturns(data interface{}) *Returns
  • func NewReturns(code, message string, data interface{}) *Returns
  • func NewTotalListReturns(total int64, data interface{}) *Returns
  • func (r *Returns) Error() string
  • func (r *Returns) String() string
• type ScriptsForm
• type ScriptsModel
• type SessionsForm
• type SessionsModel
• type StatusForm
• type StatusModel

Variables

var STATUS = status{
	Ok:                "00000",
	ErrInternal:       "10000",
	ErrInMaintain:     "10001",
	ErrRequestFormat:  "10002",
	ErrApiDeprecated:  "10003",
	ErrSessionExpired: "10004",
	ErrInBlacklist:    "10005",
	ErrTempBlock:      "10006",
}

Functions

func GetApp

func GetApp() *application

Types

type Configuration

type Configuration struct {
	Debug  string `yaml:"debug"`
	DbPath string `yaml:"dbpath"`
	Email  string `yaml:"email"`
	Server struct {
		HttpAuth struct {
			Enabled  string `yaml:"enabled"`
			User     string `yaml:"username"`
			Password string `yaml:"password"`
		} `yaml:"httpauth"`
		Addr string `yaml:"addr"`
	} `yaml:"server"`

	Log struct {
		Level    string `yaml:"level"`
		Filepath string `yaml:"filepath"`
		Format   string `yaml:"format"`
	} `yaml:"log"`
}

type DB

type DB struct {
	DB       *storm.DB
	Scripts  storm.Node
	Programs storm.Node
	Logs     storm.Node
	Sessions storm.Node
	Status   storm.Node
}

数据库

func (*DB) SavePrograms

func (this *DB) SavePrograms(Name, CurrentDir, Command, CallBack string, AutoStart bool, NumRetry, Instances int) error

保存服务资源

type LogsForm

type LogsForm struct {
	ID        int       `json:"id" binding:"required"`         // 数据ID
	SessionID string    `json:"session_id" binding:"required"` // 状态ID
	CreatedAt time.Time `json:"create_at" binding:"required"`  // 创建时间
	Data      string    `json:"data" binding:"required"`       // session的日志输出结果
}

logs数据 线上环境的log会实时放到库里面的

type LogsModel

type LogsModel struct {
	ID        int       `storm:"id,increment"` // 数据ID
	SessionID string    `storm:"index"`        // 状态ID
	CreatedAt time.Time `storm:"index"`        // 创建时间
	Data      string    // session的日志输出结果
}

logs数据 线上环境的log会实时放到库里面的

type ProgramsForm

type ProgramsForm struct {
	Name       string `json:"name" binding:"required" validate:"required"`    // 服务的名称,全剧唯一
	NumRetry   int    `json:"num_retry" binding:"required" validate:"isbn"`   // 重启次数
	Instances  int    `json:"instances" binding:"required" validate:"isbn"`   // 实例数量
	CurrentDir string `json:"cur_dir" binding:"required" validate:"required"` // 当前目录
	Command    string `json:"cmd" binding:"required" validate:"required"`     // 运行命令
	AutoStart  bool   `json:"auto_start" binding:"required"`                  // 自动启动
	CallBack   string `json:"callback" binding:"required"`                    // 回调接口,用于返回实时日志等,多个URL逗号隔开
}

programs form

type ProgramsModel

type ProgramsModel struct {
	ID         int    `storm:"id,increment"` // 数据ID
	Name       string `storm:"index,unique"` // 服务的名称,全剧唯一
	NumRetry   int    // 重启次数
	Instances  int    // 实例数量
	CurrentDir string // 当前目录
	Command    string // 运行命令
	AutoStart  bool   // 自动启动
	CallBack   string // 回调接口,用于返回实时日志等,多个URL逗号隔开
	CreatedAt  int64  `storm:"index"` // 创建时间
}

programs数据

type Returns

type Returns struct {
	// 应答码
	Code string `json:"code"`

	// 错误消息，如果请求成功，不返回这个字段
	Message string `json:"message,omitempty"`

	// 错误提示，用于客户端提醒用户
	Alert string `json:"alert,omitempty"`

	// 分页时返回总条数
	Total int64 `json:"total,omitempty"`

	// 返回数据，如果请求错误，不返回这个字段
	Data interface{} `json:"data,omitempty"`
}

Returns 所有请求都返回这个类型，其中 data 是返回的实际内容

func NewDataReturns

func NewDataReturns(data interface{}) *Returns

func NewErrReturns

func NewErrReturns(code, message string) *Returns

NewErrReturns 创建错误 Returns

func NewListReturns

func NewListReturns(data interface{}) *Returns

func NewReturns

func NewReturns(code, message string, data interface{}) *Returns

NewReturns 创建 Returns

func NewTotalListReturns

func NewTotalListReturns(total int64, data interface{}) *Returns

func (*Returns) Error

func (r *Returns) Error() string

func (*Returns) String

func (r *Returns) String() string

type ScriptsForm

type ScriptsForm struct {
	ID        int       `json:"id" binding:"required"` // 数据ID
	Name      string    `storm:"index,unique"`         // 脚本名称,全剧唯一
	Scripts   string    // 需要运行的脚本
	CallBack  string    // 回调接口,用于返回实时日志等,多个URL逗号隔开
	CreatedAt time.Time `storm:"index"` // 创建时间
	Crontab   string    // 定时执行脚本
}

scripts数据

type ScriptsModel

type ScriptsModel struct {
	ID        int       `storm:"id,increment"` // 数据ID
	Name      string    `storm:"index,unique"` // 脚本名称,全剧唯一
	Scripts   string    // 需要运行的脚本
	CallBack  string    // 回调接口,用于返回实时日志等,多个URL逗号隔开
	CreatedAt time.Time `storm:"index"` // 创建时间
	Crontab   string    // 定时执行脚本
}

scripts数据

type SessionsForm

type SessionsForm struct {
	ID         string    `json:"id" binding:"required"`          // ID
	MsgType    string    `json:"msg_type" binding:"required"`    // session的类型
	ParentName string    `json:"parent_name" binding:"required"` // 从什么数据创造出来的
	Pid        int       `json:"parent_name" binding:"required"` //  进程号
	CreatedAt  time.Time `json:"create_at" binding:"required"`   // 创建时间
}

sessions数据

type SessionsModel

type SessionsModel struct {
	ID         string    `storm:"id,index,unique"` // ID
	MsgType    string    // session的类型
	ParentName string    // 从什么数据创造出来的
	Pid        int       `storm:"index"` //  进程号
	CreatedAt  time.Time `storm:"index"` // 创建时间
}

sessions数据

type StatusForm

type StatusForm struct {
	SessionID string    `json:"session_id" binding:"required"` // 状态ID
	IsAlive   bool      `json:"is_alive" binding:"required"`   // 存活状态
	CreatedAt time.Time `json:"create_at" binding:"required"`  // 创建时间
}

status数据 根据进程号获取该进程的状态信息

type StatusModel

type StatusModel struct {
	SessionID string    `storm:"index"` // 状态ID
	IsAlive   bool      // 存活状态
	CreatedAt time.Time `storm:"index"` // 创建时间
}

status数据 根据进程号获取该进程的状态信息