reports

package
v0.0.0-...-598a827 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	LogSeverity_name = map[int32]string{
		0:   "Default",
		100: "Trace",
		200: "Debug",
		300: "Info",
		400: "Warning",
		500: "Error",
		600: "Fatal",
	}
	LogSeverity_value = map[string]int32{
		"Default": 0,
		"Trace":   100,
		"Debug":   200,
		"Info":    300,
		"Warning": 400,
		"Error":   500,
		"Fatal":   600,
	}
)

Enum value maps for LogSeverity.

View Source
var (
	TaskState_name = map[int32]string{
		0:  "Prestart",
		1:  "Started",
		2:  "Stopping",
		20: "Failed",
		21: "Success",
	}
	TaskState_value = map[string]int32{
		"Prestart": 0,
		"Started":  1,
		"Stopping": 2,
		"Failed":   20,
		"Success":  21,
	}
)

Enum value maps for TaskState.

View Source
var File_reports_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type LogEntry

type LogEntry struct {

	// Timestamp of the time when the log entry was generated
	Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
	// Severity code for the log entry
	Severity LogSeverity `protobuf:"varint,2,opt,name=severity,proto3,enum=dev.studio_go_runner.reports.LogSeverity" json:"severity,omitempty"`
	// Mesage string
	Message *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// Key value pairs of context information
	Fields map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Structured log message

func (*LogEntry) Descriptor deprecated

func (*LogEntry) Descriptor() ([]byte, []int)

Deprecated: Use LogEntry.ProtoReflect.Descriptor instead.

func (*LogEntry) GetFields

func (x *LogEntry) GetFields() map[string]string

func (*LogEntry) GetMessage

func (x *LogEntry) GetMessage() *wrapperspb.StringValue

func (*LogEntry) GetSeverity

func (x *LogEntry) GetSeverity() LogSeverity

func (*LogEntry) GetTime

func (x *LogEntry) GetTime() *timestamppb.Timestamp

func (*LogEntry) ProtoMessage

func (*LogEntry) ProtoMessage()

func (*LogEntry) ProtoReflect

func (x *LogEntry) ProtoReflect() protoreflect.Message

func (*LogEntry) Reset

func (x *LogEntry) Reset()

func (*LogEntry) String

func (x *LogEntry) String() string

type LogSeverity

type LogSeverity int32
const (
	// (0) The log entry has no assigned severity level.
	LogSeverity_Default LogSeverity = 0
	// (100) Trace information.
	LogSeverity_Trace LogSeverity = 100
	// (200) Debug information.
	LogSeverity_Debug LogSeverity = 200
	// (300) Routine information, such as ongoing status or performance.
	LogSeverity_Info LogSeverity = 300
	// (400) Normal but significant events, such as start up, shut down, or
	// a configuration change.
	LogSeverity_Warning LogSeverity = 400
	// (500) Error events are likely to cause problems.
	LogSeverity_Error LogSeverity = 500
	// (600) One or more systems are unusable.
	LogSeverity_Fatal LogSeverity = 600
)

func (LogSeverity) Descriptor

func (LogSeverity) Enum

func (x LogSeverity) Enum() *LogSeverity

func (LogSeverity) EnumDescriptor deprecated

func (LogSeverity) EnumDescriptor() ([]byte, []int)

Deprecated: Use LogSeverity.Descriptor instead.

func (LogSeverity) Number

func (x LogSeverity) Number() protoreflect.EnumNumber

func (LogSeverity) String

func (x LogSeverity) String() string

func (LogSeverity) Type

type Progress

type Progress struct {

	// Timestamp of the time when the json payload was generated by the experiment
	Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
	// The valid json payload emitted by the experiment, or empty if the message is generated
	// by the runner itself
	Json *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=json,proto3" json:"json,omitempty"`
	// This field is used to indicated the state of the task to which this Progress message relates
	State TaskState       `protobuf:"varint,3,opt,name=state,proto3,enum=dev.studio_go_runner.reports.TaskState" json:"state,omitempty"`
	Error *Progress_Error `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

JSON messages emitted by the experiment application code. These messages should conform to the format documented in docs/metadata.md(docs/metadata.md#JSON-Document)

func (*Progress) Descriptor deprecated

func (*Progress) Descriptor() ([]byte, []int)

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetError

func (x *Progress) GetError() *Progress_Error

func (*Progress) GetJson

func (x *Progress) GetJson() *wrapperspb.StringValue

func (*Progress) GetState

func (x *Progress) GetState() TaskState

func (*Progress) GetTime

func (x *Progress) GetTime() *timestamppb.Timestamp

func (*Progress) ProtoMessage

func (*Progress) ProtoMessage()

func (*Progress) ProtoReflect

func (x *Progress) ProtoReflect() protoreflect.Message

func (*Progress) Reset

func (x *Progress) Reset()

func (*Progress) String

func (x *Progress) String() string

type Progress_Error

type Progress_Error struct {

	// The text message associated with an error
	Msg *wrapperspb.StringValue `protobuf:"bytes,20,opt,name=msg,proto3" json:"msg,omitempty"`
	// If an error code is available it will be included in the code value
	Code int32 `protobuf:"varint,21,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

This field is used to send any available failure information such as an error code

func (*Progress_Error) Descriptor deprecated

func (*Progress_Error) Descriptor() ([]byte, []int)

Deprecated: Use Progress_Error.ProtoReflect.Descriptor instead.

func (*Progress_Error) GetCode

func (x *Progress_Error) GetCode() int32

func (*Progress_Error) GetMsg

func (x *Progress_Error) GetMsg() *wrapperspb.StringValue

func (*Progress_Error) ProtoMessage

func (*Progress_Error) ProtoMessage()

func (*Progress_Error) ProtoReflect

func (x *Progress_Error) ProtoReflect() protoreflect.Message

func (*Progress_Error) Reset

func (x *Progress_Error) Reset()

func (*Progress_Error) String

func (x *Progress_Error) String() string

type Report

type Report struct {

	// Timestamp of the time when the report message was emitted
	Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
	// The unique ID of this experiment assigned by the experimenter.
	// If the report has no associated or known experiment id this
	// field will not be present.
	ExperimentId *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=experiment_id,json=experimentId,proto3" json:"experiment_id,omitempty"`
	// A unique ID that was generated by the runners attempt to run the experiment.
	// This value will change between attempts. If the report has no associated or
	// known experiment id this field will not be present.
	UniqueId *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=unique_id,json=uniqueId,proto3" json:"unique_id,omitempty"`
	// A unique ID denoting the host, pod, or node that this experiment attempt
	// is being performed on.
	ExecutorId *wrapperspb.StringValue `protobuf:"bytes,4,opt,name=executor_id,json=executorId,proto3" json:"executor_id,omitempty"`
	// Types that are assignable to Payload:
	//	*Report_ProtoAny
	//	*Report_Text
	//	*Report_Logging
	//	*Report_Progress
	Payload isReport_Payload `protobuf_oneof:"payload"`
	// contains filtered or unexported fields
}

Queue message format. All messages conform to this format

func (*Report) Descriptor deprecated

func (*Report) Descriptor() ([]byte, []int)

Deprecated: Use Report.ProtoReflect.Descriptor instead.

func (*Report) GetExecutorId

func (x *Report) GetExecutorId() *wrapperspb.StringValue

func (*Report) GetExperimentId

func (x *Report) GetExperimentId() *wrapperspb.StringValue

func (*Report) GetLogging

func (x *Report) GetLogging() *LogEntry

func (*Report) GetPayload

func (m *Report) GetPayload() isReport_Payload

func (*Report) GetProgress

func (x *Report) GetProgress() *Progress

func (*Report) GetProtoAny

func (x *Report) GetProtoAny() *anypb.Any

func (*Report) GetText

func (x *Report) GetText() *wrapperspb.StringValue

func (*Report) GetTime

func (x *Report) GetTime() *timestamppb.Timestamp

func (*Report) GetUniqueId

func (x *Report) GetUniqueId() *wrapperspb.StringValue

func (*Report) ProtoMessage

func (*Report) ProtoMessage()

func (*Report) ProtoReflect

func (x *Report) ProtoReflect() protoreflect.Message

func (*Report) Reset

func (x *Report) Reset()

func (*Report) String

func (x *Report) String() string

type Report_Logging

type Report_Logging struct {
	// A structured log message from the runner
	Logging *LogEntry `protobuf:"bytes,12,opt,name=logging,proto3,oneof"`
}

type Report_Progress

type Report_Progress struct {
	// A progress message generated by the experiment
	Progress *Progress `protobuf:"bytes,13,opt,name=progress,proto3,oneof"`
}

type Report_ProtoAny

type Report_ProtoAny struct {
	ProtoAny *anypb.Any `protobuf:"bytes,10,opt,name=proto_any,json=protoAny,proto3,oneof"`
}

type Report_Text

type Report_Text struct {
	// The log entry payload, represented as a Unicode string (UTF-8).
	Text *wrapperspb.StringValue `protobuf:"bytes,11,opt,name=text,proto3,oneof"`
}

type TaskState

type TaskState int32
const (
	// (0) The Task is in an intialization phase and has not started
	TaskState_Prestart TaskState = 0
	// (1) The task is in a starting state, optional transitional state
	TaskState_Started TaskState = 1
	// (2) The task is stopping, optional transitional state
	TaskState_Stopping TaskState = 2
	// (20) Terminal state indicating the task failed
	TaskState_Failed TaskState = 20
	// (21) Terminal state indicating the task completed successfully
	TaskState_Success TaskState = 21
)

func (TaskState) Descriptor

func (TaskState) Descriptor() protoreflect.EnumDescriptor

func (TaskState) Enum

func (x TaskState) Enum() *TaskState

func (TaskState) EnumDescriptor deprecated

func (TaskState) EnumDescriptor() ([]byte, []int)

Deprecated: Use TaskState.Descriptor instead.

func (TaskState) Number

func (x TaskState) Number() protoreflect.EnumNumber

func (TaskState) String

func (x TaskState) String() string

func (TaskState) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL