journal

type API struct {
	ID     string            `json:"id,omitempty"`
	Start  time.Time         `json:"start"`
	Total  time.Duration     `json:"total"`
	Name   string            `json:"name"`
	User   string            `json:"user,omitempty"`
	Tags   map[string]string `json:"tags,omitempty"`
	Keys   map[string]string `json:"keys,omitempty"`
	Stages []*StageAPI       `json:"stages"`
}

type CrashHandler func(report *crash.Report, chain []*Stage)

type Cursor interface {
	ID() string
	Empty() bool

	// NextPage - Подгрузка следующей страницы (но, возможно, с изменением размера)
	NextPage(size uint, services ...string) ([]Model, error)
}

type Driver interface {
	/*
		InsertEntry - сохранение записи журнала в БД.
	*/
	InsertEntry(*Entry) error
}

type Entry struct {
	ID      string
	Host    string
	Service string
	Start   time.Time
	Total   time.Duration
	Chain   []*Stage
	Debug   map[string]string
}

type Factory interface {
	/*
		New - конструктор новой модели для сохранения
	*/
	New() Model

	/*
		ByID - получение записи журнала по идентификатору.

		* id не должен быть пустым и валидируется как core.UUID

		* Если не найден, ErrNotFound
		* Если что-то пошло не так, ErrSelect
	*/
	ByID(id string) (Model, error)

	/*
		ByModel - получение всех записей журнала по конкретной модели
	*/
	ByModel(mtp ModelType, mid string) ([]Model, error)

	/*
		Cursor - загрузка существующего курсора
	*/
	Cursor(id string) (_ Cursor, err error)

	/*
		ByDate - формирование курсора перебора по дате
	*/
	ByDate(from, to time.Time, page uint, services ...string) (_ Cursor, err error)

	/*
		ByModelDate - формирование курсора перебора по модели и дате
	*/
	ByModelDate(mtp ModelType, mid string, from, to time.Time, page uint, services ...string) (_ Cursor, err error)

	/*
		ImportEntries - массовая загрузка сразу нескольких моделей
	*/
	ImportEntries(...*Entry) error
}

type GlogLogger struct{}

type Logger interface {
	Print(tpl string, args ...interface{})
	Error(tpl string, args ...interface{})
}

type Model interface {
	/*
		Import - копирование основного представления в модель и сохранение в БД.
	*/
	Import(*Entry) error

	/*
		Export - основное представление записи журнала.
	*/
	Export(withCrash bool) (*Entry, error)

	/*
		ExportAPI - представление для выдачи журнала в файлах и пакетах
	*/
	ExportAPI(log Provider) *API

	/*
		ExportMonitoring - представление для выдачи журнала в мониторинге
	*/
	ExportMonitoring(log Provider) *ViewMonitoring
}

type ModelType interface {
	ID() int
	String() string
}

type Provider interface {
	/*
		Print - простая текстовая запись, для отладки или обозначения контрольной точки в процессе.

		* txt - текст записи, возможно форматная строка
		* args - аргументы форматной строки, могут отсутствовать, если текст не требует форматирования

		* Вызов функции создает новую отметку времени в цепочке
	*/
	Print(txt string, args ...interface{})

	/*
		Model - запись со ссылкой на какую-то модель в БД.

		* mtp - тип модели записи журнала, один из допустимых для логирования и поиска
		* mid - идентификатор модели, будет участвовать в поисковом индексе
		* txt - комментарий к записи, возможно форматная строка
		* args - аргументы форматной строки, могут отсутствовать, если текст не требует форматирования

		* Вызов функции создает новую отметку времени в цепочке
		* Если указан пустой идентификатор, то функция аналогична вызову Print
	*/
	Model(mtp ModelType, mid string, txt string, args ...interface{})

	/*
		Crash - логирование ошибки в журнал с формированием и записью отчета.

		* err - любая ошибка, которая будет возвращена как внешняя

		* Если err = nil, то возвращается тоже nil
		* Ошибка логируется как модель с идентификатором типа core.ModelTypeCrash
		* В текстовый комментарий к модели идет содержимое err.Error()
	*/
	Crash(err error) *crash.Report

	/*
		Close - закрытие модели, запись в glog и сохранение с помощью фабрики.

		* Обязательно требуется вызов этого метода, иначе все записи будут потеряны
	*/
	Close() *Entry

	/*
		Clone - создание нового чистого провайдера, с теми же параметрами.
	*/
	Clone() Provider

	/*
		SaveOnlyError - пометка о том, что сохранять запись в БД при закрытии нужно только в случае ошибки
	*/
	SaveOnlyError(opt bool)

	/*
		Debug - общая запись значений для дебага, который записывается в каждую ошибку.
		В записях журнала дебаг не сохраняется.

		* Старые значения из карты не удаляются.
		* Повторяющиеся - перезаписываются последними данными.
	*/
	Debug(dbg map[string]string)

	/*
		OnCrash - установка обработчика, который будет вызываться при Crash,
		когда возвращаемый crash.Report не равен nil

		* Переданная функция запускается в отдельной горутине
	*/
	OnCrash(handler CrashHandler)
}

type Stage struct {
	EnID string
	Text string
	Wait time.Duration
	Verb int
	Type int
	Fail *crash.Report
}

type StageAPI struct {
	Wait time.Duration `json:"wait"`
	Name string        `json:"name"`
	Type string        `json:"type,omitempty"`
	EnID string        `json:"enid,omitempty"`
}

type StageMonitoring struct {
	Wait string `json:"wait"`
	Name string `json:"name"`
	Time uint64 `json:"time"`
	Type string `json:"type,omitempty"`
	EnID string `json:"enid,omitempty"`
}

type StrLogger struct {
	Result string
	// contains filtered or unexported fields
}

type ViewMonitoring struct {
	ID      string             `json:"id,omitempty"`
	Host    string             `json:"host"`
	Service string             `json:"service"`
	Total   string             `json:"total"`
	Name    string             `json:"name"`
	User    string             `json:"user,omitempty"`
	Start   time.Time          `json:"start"`
	Time    uint64             `json:"time"`
	Tags    map[string]string  `json:"tags,omitempty"`
	Keys    map[string]string  `json:"keys,omitempty"`
	Stages  []*StageMonitoring `json:"stages"`
}